Documentation

AutoSuggest
in package
implements ActionInterface, Routable uses ActionRouter, ActionTrait

Suggests members, membergroups, or SMF versions in reply to AJAX requests.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.
Routable
Classes implementing this interface can build routes from URL query parameters and parse routes back into URL query parameters.

Properties

$search  : string
$search_param  : array<string|int, mixed>
$suggest_type  : string
$suggest_types  : array<string|int, mixed>
$obj  : static

Methods

buildRoute()  : array<string|int, mixed>
Builds a routing path based on URL query parameters.
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.
checkRegistered()  : bool
Checks whether the given suggestion type is supported.
execute()  : void
Dispatcher to whichever 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.
load()  : static
Static wrapper for constructor.
member()  : array<string|int, mixed>
Search for a member by real_name.
membergroups()  : array<string|int, mixed>
Search for a membergroup by name.
parseRoute()  : array<string|int, mixed>
Parses a route to get URL query parameters.
versions()  : array<string|int, mixed>
Provides a list of possible SMF versions to use in emulation.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().
buildActionRoute()  : array<string|int, mixed>
Builds a routing path for an action based on URL query parameters.
parseActionRoute()  : array<string|int, mixed>
Parses a route for an action to get URL query parameters.
sanitizeSearch()  : void
Sanitizes the search string.

Properties

$search

public string $search

The string to search for when finding suggestions. This should be set by the constructor.

$search_param

public array<string|int, mixed> $search_param = []

Optional search parameters. This should be set by the constructor.

$suggest_type

public string $suggest_type

The requested type of suggestion. This should be set by the constructor.

$suggest_types

public static array<string|int, mixed> $suggest_types = ['member' => 'member', 'membergroups' => 'membergroups', 'versions' => 'versions']

Available suggestion types.

$obj

protected static static $obj

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

Methods

buildRoute()

Builds a routing path based on URL query parameters.

public static buildRoute(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

URL query parameters.

Return values
array<string|int, mixed> —

Contains two elements: ['route' => [], 'params' => []]. The 'route' element contains the routing path. The 'params' element contains any $params that weren't incorporated into the route.

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.

checkRegistered()

Checks whether the given suggestion type is supported.

public static checkRegistered(string $suggest_type) : bool
Parameters
$suggest_type : string

The suggestion type we are interested in.

Return values
bool

execute()

Dispatcher to whichever 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

Simple actions don't require the index template at all.

Return values
bool

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

member()

Search for a member by real_name.

public member() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of information for displaying the suggestions.

membergroups()

Search for a membergroup by name.

public membergroups() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of information for displaying the suggestions.

parseRoute()

Parses a route to get URL query parameters.

public static parseRoute(array<string|int, mixed> $route[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$route : array<string|int, mixed>

Array of routing path components.

$params : array<string|int, mixed> = []

Any existing URL query parameters.

Return values
array<string|int, mixed> —

URL query parameters

versions()

Provides a list of possible SMF versions to use in emulation.

public versions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of data for displaying the suggestions.

__construct()

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

protected __construct() : mixed

buildActionRoute()

Builds a routing path for an action based on URL query parameters.

protected static buildActionRoute(array<string|int, mixed> &$params) : array<string|int, mixed>

The 'action', 'area', and 'sa' parameters will be mapped to route path components in that order. The 'action' parameter is required, whereas 'area' and 'sa' are optional and will be silently skipped if not set.

The parameters are passed by reference and parameters are removed from the array when recognized. This lets wrapper methods continue parsing the remainder of the parameters without worrying about duplicate elements.

Parameters
$params : array<string|int, mixed>

URL query parameters.

Return values
array<string|int, mixed> —

The route path elements.

parseActionRoute()

Parses a route for an action to get URL query parameters.

protected static parseActionRoute(array<string|int, mixed> &$route) : array<string|int, mixed>

The first element of the route path is mapped to the 'action' parameter.

For the 'admin', 'moderate', and 'profile' actions, the second element of the route is mapped to the 'area' parameter and the third element is mapped to the 'sa' parameter.

For all other actions, the second element of the route path is mapped to the 'sa' parameter.

The route passed by reference and route path elements are removed from the route when recognized. This lets wrapper methods continue parsing the remainder of the route without worrying about duplicate elements.

Parameters
$route : array<string|int, mixed>

Array of routing path components.

Return values
array<string|int, mixed> —

URL query parameters

sanitizeSearch()

Sanitizes the search string.

protected sanitizeSearch() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results