1. interface
  2. Bolt
  3. \
  4. Widget
  5. \
  6. RequestAwareInterface

RequestAwareInterface

interface RequestAwareInterface implements WidgetInterface (View source)

Interface RequestAwareInterface - Widgets that make use of the Request to provide their functionality need to implement this interface.

Methods

string
getName()

No description

from  WidgetInterface
string
getTarget()

No description

from  WidgetInterface
int
getPriority()

No description

from  WidgetInterface
string
getZone()

No description

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

No description

from  WidgetInterface
void
injectExtension(ExtensionInterface $extension)

No description

from  WidgetInterface
setRequest(Request $request)

No description

Request
getRequest()

No description

Details

in WidgetInterface at line 14
string getName()

Return Value

string

in WidgetInterface at line 19
string getTarget()

Return Value

string from Bolt\Widget\Injector\Target constants enum

in WidgetInterface at line 21
int getPriority()

Return Value

int

in WidgetInterface at line 26
string getZone()

Return Value

string from Bolt\Widget\Injector\RequestZone constants enum

in WidgetInterface at line 28
string|null __invoke(array $params = [])

Parameters

array $params

Return Value

string|null

in WidgetInterface at line 30
void injectExtension(ExtensionInterface $extension)

Parameters

ExtensionInterface $extension

Return Value

void

at line 15
setRequest(Request $request)

Parameters

Request $request

at line 17
Request getRequest()

Return Value

Request