Documentation

WatchedUsers
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

$obj  : object
$backcompat  : array<string|int, mixed>

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
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.
list_getWatchedUserCount()  : int
Callback for SMF\ItemList().
list_getWatchedUserPosts()  : array<string|int, mixed>
Callback for SMF\ItemList().
list_getWatchedUserPostsCount()  : int
Callback for SMF\ItemList().
list_getWatchedUsers()  : array<string|int, mixed>
Callback for SMF\ItemList().
load()  : object
Static wrapper for constructor.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().

Properties

$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' => 'ViewWatchedUsers', 'list_getWatchedUserCount' => 'list_getWatchedUserCount', 'list_getWatchedUsers' => 'list_getWatchedUsers', 'list_getWatchedUserPostsCount' => 'list_getWatchedUserPostsCount', 'list_getWatchedUserPosts' => 'list_getWatchedUserPosts']]

BackwardCompatibility settings for this class.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

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:

  1. Use this trait in the class.
  2. 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_getWatchedUserCount()

Callback for SMF\ItemList().

public static list_getWatchedUserCount(string $approve_query) : int
Parameters
$approve_query : string

Not used here

Return values
int —

The number of users on the watch list

list_getWatchedUserPosts()

Callback for SMF\ItemList().

public static list_getWatchedUserPosts(int $start, int $items_per_page, string $sort, string $approve_query, array<string|int, int> $delete_boards) : array<string|int, mixed>
Parameters
$start : int

The item to start with (for pagination purposes)

$items_per_page : int

The number of items to show per page

$sort : string

A string indicating how to sort the results (not used here)

$approve_query : string

A query to only pull approved items

$delete_boards : array<string|int, int>

An array containing the IDs of boards we can delete posts in

Return values
array<string|int, mixed> —

An array of info about posts by watched users

list_getWatchedUserPostsCount()

Callback for SMF\ItemList().

public static list_getWatchedUserPostsCount(string $approve_query) : int
Parameters
$approve_query : string

A query to pull only approved items

Return values
int —

The total number of posts by watched users

list_getWatchedUsers()

Callback for SMF\ItemList().

public static list_getWatchedUsers(int $start, int $items_per_page, string $sort, string $approve_query, string $dummy) : array<string|int, mixed>
Parameters
$start : int

The item to start with (for pagination purposes)

$items_per_page : int

The number of items to show per page

$sort : string

A string indicating how to sort things

$approve_query : string

A query for approving things. Not used here.

$dummy : string

Not used here.

Return values
array<string|int, mixed> —

An array of info about watched users

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results