POT
POT
POT
Main menu

Download

Forum

SVN

Interface: IOTS_GuildAction

Source Location: /classes/IOTS_GuildAction.php

Interface IOTS_GuildAction

Interface Overview

Guild action interface.

Guild action interface. This insterface indicates that class can handle OTServ guild action.

You can use it for example to handle invites or membership requests.

If you want to serialise (for example save in session) your guild obejcts with assigned drivers you need to implement also __sleep() and __wakeup() methods in your drivers, as assigned drivers are also serialised.

Located in /classes/IOTS_GuildAction.php [line 32]



		
				Author(s):
		
Information Tags:
Version:  0.0.4
Since:  0.0.4

Methods

[ Top ]
Method Summary
IOTS_GuildAction   __construct()   Objects are initialized with a guild that they are assigned to.
void   addRequest()   Adds new request.
void   deleteRequest()   Deletes request.
array   listRequests()   List of saved pending actions.
void   submitRequest()   Finalizes request.

[ Top ]
Methods
Constructor __construct  [line 41]

  IOTS_GuildAction __construct( OTS_Guild $guild  )

Objects are initialized with a guild that they are assigned to.

Objects are initialized with a guild that they are assigned to. It is recommeded that your implementations calls assignment functions of $guild to automaticly assign itself as action handler.

Parameters:
OTS_Guild   $guild:  Guild that this driver is assigned to.

API Tags:
Access:  public

Information Tags:
Version:  0.0.4
Since:  0.0.4

[ Top ]
addRequest  [line 54]

  void addRequest( OTS_Player $player  )

Adds new request.

Adds new request.

Parameters:
OTS_Player   $player:  Player which is object of request.

API Tags:
Access:  public

Information Tags:
Version:  0.0.4
Since:  0.0.4

[ Top ]
deleteRequest  [line 60]

  void deleteRequest( OTS_Player $player  )

Deletes request.

Deletes request.

Parameters:
OTS_Player   $player:  Player which is object of request.

API Tags:
Access:  public

Information Tags:
Version:  0.0.4
Since:  0.0.4

[ Top ]
listRequests  [line 48]

  array listRequests( )

List of saved pending actions.

List of saved pending actions.


API Tags:
Return:  List of actions.
Access:  public

Information Tags:
Version:  0.0.4
Since:  0.0.4

[ Top ]
submitRequest  [line 66]

  void submitRequest( OTS_Player $player  )

Finalizes request.

Finalizes request.

Parameters:
OTS_Player   $player:  Player which is object of request.

API Tags:
Access:  public

Information Tags:
Version:  0.0.4
Since:  0.0.4

[ Top ]