abstract class Control extends Component implements Renderable

Control is renderable Presenter component.

Properties

$snippetMode
Template|DefaultTemplate|stdClass read-only $template

Methods

setTemplateFactory(TemplateFactory $templateFactory)

No description

getTemplate()

No description

createTemplate(string|null $class = null)

No description

string|null
formatTemplateClass()

No description

string|null
checkTemplateClass(string $class)

No description

void
templatePrepareFilters(Template $template) deprecated

Descendant can override this method to customize template compile-time filters.

flashMessage(string|stdClass|Stringable $message, string $type = 'info')

Saves the message to template, that can be displayed after redirect.

void
redrawControl(string|null $snippet = null, bool $redraw = true)

Forces control or its snippet to repaint.

bool
isControlInvalid(string|null $snippet = null)

Is required to repaint the control or its snippet?

string
getSnippetId(string $name)

Returns snippet HTML ID.

Details

at line 31
final Control setTemplateFactory(TemplateFactory $templateFactory)

No description

Parameters

TemplateFactory $templateFactory

Return Value

Control

at line 38
final Template getTemplate()

No description

Return Value

Template

at line 48
protected Template createTemplate(string|null $class = null)

No description

Parameters

string|null $class

Return Value

Template

at line 56
string|null formatTemplateClass()

No description

Return Value

string|null

at line 63
protected string|null checkTemplateClass(string $class)

internal  
 

No description

Parameters

string $class

Return Value

string|null

at line 85
void templatePrepareFilters(Template $template) deprecated

deprecated

Descendant can override this method to customize template compile-time filters.

Parameters

Template $template

Return Value

void

at line 93
stdClass flashMessage(string|stdClass|Stringable $message, string $type = 'info')

Saves the message to template, that can be displayed after redirect.

Parameters

string|stdClass|Stringable $message
string $type

Return Value

stdClass

at line 114
void redrawControl(string|null $snippet = null, bool $redraw = true)

Forces control or its snippet to repaint.

Parameters

string|null $snippet
bool $redraw

Return Value

void

at line 131
bool isControlInvalid(string|null $snippet = null)

Is required to repaint the control or its snippet?

Parameters

string|null $snippet

Return Value

bool

at line 161
string getSnippetId(string $name)

Returns snippet HTML ID.

Parameters

string $name

Return Value

string