BuddyIgnoreLists
in package
implements
ActionInterface
Uses
BackwardCompatibility
Show all the users buddies, as well as a add/delete interface.
Table of Contents
Interfaces
- ActionInterface
- Interface for all action classes.
Properties
- $subaction : string
- $subactions : array<string|int, mixed>
- $subtemplates : array<string|int, mixed>
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- buddies() : void
- Show all the user's buddies, as well as an add/delete interface.
- call() : void
- Convenience method to load() and execute() an instance of this class.
- editBuddies() : void
- Backward compatibility wrapper for the buddies sub-action.
- editIgnoreList() : void
- Backward compatibility wrapper for the buddies sub-action.
- execute() : void
- Dispatcher to whichever sub-action method is necessary.
- exportStatic() : void
- Provides a way to export a class's public static properties and methods to global namespace.
- ignore() : void
- Allows the user to view their ignore list, as well as the option to manage members on it.
- load() : object
- Static wrapper for constructor.
- __construct() : mixed
- Constructor. Protected to force instantiation via self::load().
Properties
$subaction
public
string
$subaction
= 'buddies'
The requested sub-action. This should be set by the constructor.
$subactions
public
static array<string|int, mixed>
$subactions
= ['buddies' => 'buddies', 'ignore' => 'ignore']
Available sub-actions.
$subtemplates
public
static array<string|int, mixed>
$subtemplates
= ['buddies' => 'editBuddies', 'ignore' => 'editIgnoreList']
Available sub-actions.
$obj
protected
static object
$obj
An instance of this class. This is used by the load() method to prevent mulitple instantiations.
$backcompat
private
static array<string|int, mixed>
$backcompat
= ['func_names' => ['call' => 'editBuddyIgnoreLists', 'editBuddies' => 'editBuddies', 'editIgnoreList' => 'editIgnoreList']]
BackwardCompatibility settings for this class.
Methods
buddies()
Show all the user's buddies, as well as an add/delete interface.
public
buddies() : void
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
editBuddies()
Backward compatibility wrapper for the buddies sub-action.
public
static editBuddies(int $memID) : void
Parameters
- $memID : int
-
The ID of the member
editIgnoreList()
Backward compatibility wrapper for the buddies sub-action.
public
static editIgnoreList(int $memID) : void
Parameters
- $memID : int
-
The ID of the member
execute()
Dispatcher to whichever sub-action method is necessary.
public
execute() : void
exportStatic()
Provides a way to export a class's public static properties and methods to global namespace.
public
static exportStatic() : void
To do so:
- Use this trait in the class.
- At the END of the class's file, call its exportStatic() method.
Although it might not seem that way at first glance, this approach conforms to section 2.3 of PSR 1, since executing this method is simply a dynamic means of declaring functions when the file is included; it has no other side effects.
Regarding the $backcompat items:
A class's static properties are not exported to global variables unless explicitly included in $backcompat['prop_names']. Likewise, a class's static methods are not exported as global functions unless explicitly included in $backcompat['func_names'].
$backcompat['prop_names'] is a simple array where the keys are the names of one or more of a class's static properties, and the values are the names of global variables. In each case, the global variable will be set to a reference to the static property. Static properties that are not named in this array will not be exported.
$backcompat['func_names'] is a simple array where the keys are the names of one or more of a class's static methods, and the values are the names that should be used for global functions that will encapsulate those methods. Methods that are not named in this array will not be exported.
Adding non-static properties or methods to the $backcompat arrays will produce runtime errors. It is the responsibility of the developer to make sure not to do this.
ignore()
Allows the user to view their ignore list, as well as the option to manage members on it.
public
ignore() : void
load()
Static wrapper for constructor.
public
static load() : object
Return values
object —An instance of this class.
__construct()
Constructor. Protected to force instantiation via self::load().
protected
__construct() : mixed