TrackIP
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
- $memID : int
- $standalone : bool
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- call() : void
- Convenience method to load() and execute() an instance of this class.
- execute() : void
- Do the job.
- exportStatic() : void
- Provides a way to export a class's public static properties and methods to global namespace.
- list_getIPMessageCount() : int
- Gets the number of posts made from a particular IP
- list_getIPMessages() : array<string|int, mixed>
- Gets all the posts made from a particular IP
- load() : object
- Static wrapper for constructor.
- trackIP() : void
- Backward compatibility wrapper.
- __construct() : mixed
- Constructor. Protected to force instantiation via self::load().
Properties
$memID
public
int
$memID
ID of the member to track.
$standalone
public
bool
$standalone
True if this was called via ?action=trackip. False if this was called via ?action=profile;area=tracking;sa=ip.
$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_getIPMessages' => 'list_getIPMessages', 'list_getIPMessageCount' => 'list_getIPMessageCount', 'trackIP' => 'TrackIP']]
BackwardCompatibility settings for this class.
Methods
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
execute()
Do 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.
list_getIPMessageCount()
Gets the number of posts made from a particular IP
public
static list_getIPMessageCount(string $where[, array<string|int, mixed> $where_vars = [] ]) : int
Parameters
- $where : string
-
A query indicating which posts to count
- $where_vars : array<string|int, mixed> = []
-
The parameters for $where
Return values
int —Count of messages matching the IP
list_getIPMessages()
Gets all the posts made from a particular IP
public
static list_getIPMessages(int $start, int $items_per_page, string $sort, string $where[, array<string|int, mixed> $where_vars = [] ]) : array<string|int, mixed>
Parameters
- $start : int
-
Which 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
- $where : string
-
A query to filter which posts are returned
- $where_vars : array<string|int, mixed> = []
-
An array of parameters for $where
Return values
array<string|int, mixed> —An array containing information about the posts
load()
Static wrapper for constructor.
public
static load() : object
Return values
object —An instance of this class.
trackIP()
Backward compatibility wrapper.
public
static trackIP([int $memID = 0 ]) : void
Parameters
- $memID : int = 0
-
The ID of a member whose IP we want to track.
__construct()
Constructor. Protected to force instantiation via self::load().
protected
__construct() : mixed