\Ceo\Lint\Twig\ChecksCheckAbstract

Lint check abstract class. All checks must inherit from this abstract

Summary

Methods
Properties
Constants
setFileName()
loadTemplate()
getMessages()
execute()
No public properties found
No constants found
getFileName()
asString()
asArray()
setMessage()
$template
$fileName
$messages
N/A
No private methods found
No private properties found
N/A

Properties

$template

$template : 

Template context

Type

$fileName

$fileName : 

Template filename

Type

$messages

$messages : 

Message container

Type

Methods

setFileName()

setFileName(\Ceo\Lint\Twig\Checks\string  $name) : self

Set template filename

Parameters

\Ceo\Lint\Twig\Checks\string $name

Returns

self

loadTemplate()

loadTemplate(\Ceo\Lint\Twig\Checks\string  $template) : self

Handle the loading of the template

Parameters

\Ceo\Lint\Twig\Checks\string $template

Returns

self

getMessages()

getMessages() : array

Return messages, if it exists

Returns

array —

of Ceo\Lint\Twig\Message or NULL

execute()

execute() : boolean

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

Returns

boolean —

TRUE for success, FALSE for failure

getFileName()

getFileName() : string

Return filename

Returns

string

asString()

asString() : string

Return template as a string

Returns

string

asArray()

asArray() : array

Return template as an array of lines

Returns

array

setMessage()

setMessage(  $type,   $message) 

Parameters

$type
$message