class CheckSearchResults extends CheckAbstract

Check to see if the advanced search results template is using the proper result handler This is a warning level

Properties

protected $template Template context from CheckAbstract
protected $fileName Template filename from CheckAbstract
protected $messages Message container from CheckAbstract

Methods

setFileName(string $name)

Set template filename

loadTemplate(string $template)

Handle the loading of the template

string
getFileName()

Return filename

string
asString()

Return template as a string

array
asArray()

Return template as an array of lines

setMessage($type, $message)

No description

array
getMessages()

Return messages, if it exists

boolean
execute()

Execute check, must return a boolean and set a message on failure

Details

in CheckAbstract at line 35
CheckAbstract setFileName(string $name)

Set template filename

Parameters

string $name

Return Value

CheckAbstract

in CheckAbstract at line 46
CheckAbstract loadTemplate(string $template)

Handle the loading of the template

Parameters

string $template

Return Value

CheckAbstract

in CheckAbstract at line 56
protected string getFileName()

Return filename

Return Value

string

in CheckAbstract at line 65
protected string asString()

Return template as a string

Return Value

string

in CheckAbstract at line 74
protected array asArray()

Return template as an array of lines

Return Value

array

in CheckAbstract at line 79
protected setMessage($type, $message)

Parameters

$type
$message

in CheckAbstract at line 92
array getMessages()

Return messages, if it exists

Return Value

array of Ceo\Lint\Twig\Message or NULL

at line 13
boolean execute()

Execute check, must return a boolean and set a message on failure

Return Value

boolean TRUE for success, FALSE for failure