IssueWarning
in package
implements
ActionInterface
Uses
BackwardCompatibility
Rename here and in the exportStatic call at the end of the file.
Table of Contents
Interfaces
- ActionInterface
- Interface for all action classes.
Properties
- $issueErrors : array<string|int, mixed>
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- call() : void
- Convenience method to load() and execute() an instance of this class.
- execute() : void
- Does the job.
- exportStatic() : void
- Provides a way to export a class's public static properties and methods to global namespace.
- issueWarning() : void
- Backward compatibility wrapper.
- list_getUserWarningCount() : int
- Get the number of warnings a user has.
- list_getUserWarnings() : array<string|int, mixed>
- Get the data about a user's warnings.
- load() : object
- Static wrapper for constructor.
- __construct() : mixed
- Constructor. Protected to force instantiation via self::load().
- preview() : void
- Gets a preview of the warning message.
- save() : void
- Saves the newly issued warning.
Properties
$issueErrors
public
array<string|int, mixed>
$issueErrors
= []
This stores any legitimate errors.
$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' => ['list_getUserWarnings' => 'list_getUserWarnings', 'list_getUserWarningCount' => 'list_getUserWarningCount', 'issueWarning' => 'issueWarning']]
BackwardCompatibility settings for this class.
Methods
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
execute()
Does the job.
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.
issueWarning()
Backward compatibility wrapper.
public
static issueWarning(int $memID) : void
Parameters
- $memID : int
-
The ID of the user.
list_getUserWarningCount()
Get the number of warnings a user has.
public
static list_getUserWarningCount() : int
Return values
int —Total number of warnings for the user.
list_getUserWarnings()
Get the data about a user's warnings.
public
static list_getUserWarnings(int $start, int $items_per_page, string $sort) : array<string|int, mixed>
Parameters
- $start : int
-
The item to start with (for pagination purposes)
- $items_per_page : int
-
How many items to show on each page
- $sort : string
-
A string indicating how to sort the results
Return values
array<string|int, mixed> —An array of information about the user's warnings
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
preview()
Gets a preview of the warning message.
protected
preview() : void
save()
Saves the newly issued warning.
protected
save() : void
Also logs the action and, if the relevant setting is enabled, sends a personal message to notify the warned member about it.