Documentation

WatchedUsers
in package
implements ActionInterface uses ActionTrait

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  : static

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
execute()  : void
Dispatcher to whichever sub-action method is necessary.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
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()  : static
Static wrapper for constructor.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().

Properties

$obj

protected static static $obj

An instance of this class. This is used by the load() method to prevent multiple instantiations.

Methods

call()

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

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

execute()

Dispatcher to whichever sub-action method is necessary.

public execute() : void

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

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, array<string|int, mixed> $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 : array<string|int, mixed>

Not used here.

Return values
array<string|int, mixed> —

An array of info about watched users

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results