Documentation

Search2
in package
implements ActionInterface, Routable uses ActionRouter, ActionTrait

Shows the search form.

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

$messages  : array<string|int, mixed>
$num_results  : int
$posters  : 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.
execute()  : void
Performs the search and shows the results.
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.
parseRoute()  : array<string|int, mixed>
Parses a route to get URL query parameters.
prepareSearchContext()  : false|array<string|int, mixed>
Callback to return messages - saves memory.
__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.
checkLoadAverage()  : void
Aborts search if the load average is too high right now.
errorCheck()  : bool
Checks for errors and shows the initial search page if there were.
getPosters()  : void
Populates $this->posters with IDs of authors of the posts we will show.
initSearchContext()  : void
Initializes stuff we need to display the search results.
parseActionRoute()  : array<string|int, mixed>
Parses a route for an action to get URL query parameters.
preventPrefetch()  : void
Blocks browser attempts to prefetch the topic display.
redirectToMemberSearch()  : void
If coming from the quick search box and trying to search on members, redirect to the right place for that.
setupTemplate()  : void
Loads the template and sets some related contextual info.
setupVerification()  : void
Sets up anti-spam verification stuff, if needed.
spamCheck()  : void
Block spam attempts, but without driving guests completely crazy.

Properties

$messages

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

ID numbers of messages in the search results.

$num_results

public int $num_results = 0

The number of results found.

$posters

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

ID numbers of the authors of the $messages.

$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.

execute()

Performs the search and shows the results.

public execute() : void
Tags
todo

Break this up into separate protected functions.

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

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

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

prepareSearchContext()

Callback to return messages - saves memory.

public prepareSearchContext([bool $reset = false ]) : false|array<string|int, mixed>

What it does:

  • callback function for the results sub template.
  • loads the necessary contextual data to show a search result.
Parameters
$reset : bool = false

Whether to reset the counter

Return values
false|array<string|int, mixed> —

An array of contextual info related to this search

__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.

checkLoadAverage()

Aborts search if the load average is too high right now.

protected checkLoadAverage() : void

errorCheck()

Checks for errors and shows the initial search page if there were.

protected errorCheck() : bool
Return values
bool

getPosters()

Populates $this->posters with IDs of authors of the posts we will show.

protected getPosters() : void

initSearchContext()

Initializes stuff we need to display the search results.

protected initSearchContext() : void

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

preventPrefetch()

Blocks browser attempts to prefetch the topic display.

protected preventPrefetch() : void

redirectToMemberSearch()

If coming from the quick search box and trying to search on members, redirect to the right place for that.

protected redirectToMemberSearch() : void

setupTemplate()

Loads the template and sets some related contextual info.

protected setupTemplate() : void

setupVerification()

Sets up anti-spam verification stuff, if needed.

protected setupVerification() : void

spamCheck()

Block spam attempts, but without driving guests completely crazy.

protected spamCheck() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results