1. class
  2. Bolt
  3. \
  4. Widget
  5. \
  6. BaseWidget

BaseWidget

abstract class BaseWidget implements WidgetInterface (View source)

BaseWidget can be used as easy starter pack or as a base for your own widgets.

Traits

TwigTrait
RequestTrait
ResponseTrait

Properties

protected string $name
protected string $target
protected string $zone
protected ExtensionInterface $extension
protected int $priority
protected string $template
protected string $templateFolder
protected ?string $slug
protected int $cacheDuration

Methods

TwigTrait
setTwig(Environment $twig)

No description

from  TwigTrait
Environment
getTwig()

No description

from  TwigTrait
RequestTrait
setRequest(Request $request)

No description

from  RequestTrait
Request
getRequest()

No description

from  RequestTrait
ResponseTrait
setResponse(Response $response)

No description

from  ResponseTrait
Response
getResponse()

No description

from  ResponseTrait
BaseWidget
setName(string $name)

No description

string
getName()

No description

BaseWidget
setTarget(string $target)

No description

string
getTarget()

No description

BaseWidget
setPriority(int $priority)

No description

int
getPriority()

No description

void
injectExtension(ExtensionInterface $extension)

No description

getExtension()

No description

string|null
__invoke(array $params = [])

Method to 'invoke' the widget. Simple wrapper around the 'run' method, which can be overridden in a custom Widget or trait

string|null
run(array $params = [])

Actual method that 'runs' the widget and returns the output. For reasons of extensibility: Do not call directly, but call $widget() to invoke.

BaseWidget
setTemplate(string $template)

No description

string
getTemplate()

No description

string|null
getTemplateFolder()

No description

BaseWidget
setZone(string $zone)

No description

string
getZone()

No description

string
getSlug()

No description

int
getCacheDuration()

No description

Details

in TwigTrait at line 15
TwigTrait setTwig(Environment $twig)

Parameters

Environment $twig

Return Value

TwigTrait

in TwigTrait at line 22
Environment getTwig()

Return Value

Environment

in RequestTrait at line 15
RequestTrait setRequest(Request $request)

Parameters

Request $request

Return Value

RequestTrait

in RequestTrait at line 22
Request getRequest()

Return Value

Request

in ResponseTrait at line 15
ResponseTrait setResponse(Response $response)

Parameters

Response $response

Return Value

ResponseTrait

in ResponseTrait at line 22
Response getResponse()

Return Value

Response

at line 49
BaseWidget setName(string $name)

Parameters

string $name

Return Value

BaseWidget

at line 57
string getName()

Return Value

string

at line 66
BaseWidget setTarget(string $target)

Parameters

string $target

Return Value

BaseWidget

at line 73
string getTarget()

Return Value

string from Bolt\Widget\Injector\Target constants enum

at line 82
BaseWidget setPriority(int $priority)

Parameters

int $priority

Return Value

BaseWidget

at line 89
int getPriority()

Return Value

int

at line 98
void injectExtension(ExtensionInterface $extension)

Parameters

ExtensionInterface $extension

Return Value

void

at line 103
getExtension()

at line 112
string|null __invoke(array $params = [])

Method to 'invoke' the widget. Simple wrapper around the 'run' method, which can be overridden in a custom Widget or trait

Parameters

array $params

Return Value

string|null

at line 121
protected string|null run(array $params = [])

Actual method that 'runs' the widget and returns the output. For reasons of extensibility: Do not call directly, but call $widget() to invoke.

Parameters

array $params

Return Value

string|null

at line 154
BaseWidget setTemplate(string $template)

Parameters

string $template

Return Value

BaseWidget

at line 161
string getTemplate()

Return Value

string

at line 170
string|null getTemplateFolder()

Return Value

string|null

at line 200
BaseWidget setZone(string $zone)

Parameters

string $zone

Return Value

BaseWidget

at line 207
string getZone()

Return Value

string from Bolt\Widget\Injector\RequestZone constants enum

at line 216
string getSlug()

Return Value

string

at line 225
int getCacheDuration()

Return Value

int