1. class
  2. Concrete
  3. \
  4. Controller
  5. \
  6. Element
  7. \
  8. Search
  9. \
  10. Files
  11. \
  12. Header

Header

class Header extends ElementController (View source)

Traits

ApplicationAwareTrait
Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from ApplicationAwareTrait
protected string[] $helpers The handles of the helpers to be returned by the getHelperObjects method. from AbstractController
protected array $sets The values to be sent to views. from AbstractController
protected string|null $action The action to be performed. from AbstractController
protected Request|null $request The current request instance. from AbstractController
protected array|null $parameters The action parameters. from AbstractController
protected $pkgHandle from ElementController
protected $view from ElementController
protected $query
protected $includeBreadcrumb

Methods

setApplication(Application $app)

Setter method for the application

from ApplicationAwareTrait
__construct(Query $query = null)

Initialize the instance.

Request
getRequest()

Get the current request instance.

from AbstractController
setRequest(Request $request)

Set the current request instance.

from AbstractController
requireAsset()

Add an asset required in views.

from AbstractController
addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

from AbstractController
addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

from AbstractController
set(string $key, mixed $val)

Set a value to be sent to the view.

from AbstractController
array
getSets()

Get the values to be sent to views.

from AbstractController
bool
shouldRunControllerTask()

Should the action be executed? Override this method to answer something different than true.

from AbstractController
array
getHelperObjects()

Get the the helpers that will be be automatically sent to Views as variables.

from AbstractController
mixed
get(string|null $key = null, mixed $defaultValue = null)

Get the whole $_GET array or a specific querystring value.

from AbstractController
getTask() deprecated

No description

from AbstractController
string|null
getAction()

Get the action to be performed.

from AbstractController
array|null
getParameters()

Get the action parameters.

from AbstractController
on_start()

Override this method to perform controller initializations.

from AbstractController
on_before_render()

Override this method to do something right before the view is rendered.

from AbstractController
isPost() deprecated

No description

from AbstractController
mixed
post(string|null $key = null, mixed $defaultValue = null)

Get the whole $_POST array or a specific posted value.

from AbstractController
redirect() deprecated

Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).

from AbstractController
runTask(mixed $action, mixed $parameters) deprecated

No description

from AbstractController
mixed
runAction(string $action, array $parameters = [])

Perform an action of this controller (if shouldRunControllerTask returns true).

from AbstractController
mixed
request(string|null $key = null)

Get the whole $_REQUEST array or a specific requested value.

from AbstractController
getElement()

No description

getViewObject()

No description

from ElementController
mixed
getPackageHandle()

No description

from ElementController
setPackageHandle(mixed $pkgHandle)

No description

from ElementController
render() deprecated

No description

from ElementController
setIncludeBreadcrumb(boolean $includeBreadcrumb)

No description

view()

No description

Details

in ApplicationAwareTrait at line 19
setApplication(Application $app)

Setter method for the application

Parameters

Application $app

at line 22
__construct(Query $query = null)

Initialize the instance.

Parameters

Query $query

in AbstractController at line 67
Request getRequest()

Get the current request instance.

Return Value

Request

in AbstractController at line 81
setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

in AbstractController at line 92
requireAsset()

Add an asset required in views.

This function accept the same parameters as the requireAsset method of the ResponseAssetGroup.

See also

ResponseAssetGroup::requireAsset

in AbstractController at line 104
addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

Parameters

string $item

in AbstractController at line 115
addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

Parameters

string $item

in AbstractController at line 127
set(string $key, mixed $val)

Set a value to be sent to the view.

Parameters

string $key The name of the value
mixed $val The value

in AbstractController at line 137
array getSets()

Get the values to be sent to views.

Return Value

array

in AbstractController at line 147
bool shouldRunControllerTask()

Should the action be executed? Override this method to answer something different than true.

Return Value

bool

in AbstractController at line 158
array getHelperObjects()

Get the the helpers that will be be automatically sent to Views as variables.

Array keys are the variable names, array values are the helper instances.

Return Value

array

in AbstractController at line 177
mixed get(string|null $key = null, mixed $defaultValue = null)

Get the whole $_GET array or a specific querystring value.

Parameters

string|null $key set to null to get the whole $_GET array, or a string to get a specific value in the controller sets or from the querystring parameters
mixed $defaultValue what to return if $key is specified but it does not exist neither in the sets nor in the querystring

Return Value

mixed

in AbstractController at line 195
getTask() deprecated

deprecated use the getAction() method

in AbstractController at line 205
string|null getAction()

Get the action to be performed.

Return Value

string|null

in AbstractController at line 215
array|null getParameters()

Get the action parameters.

Return Value

array|null

in AbstractController at line 223
on_start()

Override this method to perform controller initializations.

in AbstractController at line 231
on_before_render()

Override this method to do something right before the view is rendered.

For instance, you can call $this->set('variableName', $variableValue) to send the view additional sets.

in AbstractController at line 238
isPost() deprecated

deprecated Use $this->getRequest()->isPost();

in AbstractController at line 251
mixed post(string|null $key = null, mixed $defaultValue = null)

Get the whole $_POST array or a specific posted value.

Parameters

string|null $key set to null to get the whole $_POST array, or a string to get a specific posted value (resulting strings will be trimmed)
mixed $defaultValue what to return if $key is specified but it does not exist in the $_POST

Return Value

mixed

in AbstractController at line 261
redirect() deprecated

deprecated you should return a Response instance from your methods

Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).

in AbstractController at line 275
runTask(mixed $action, mixed $parameters) deprecated

deprecated use the runAction method

Parameters

mixed $action
mixed $parameters

in AbstractController at line 288
mixed runAction(string $action, array $parameters = [])

Perform an action of this controller (if shouldRunControllerTask returns true).

Parameters

string $action the action to be performed
array $parameters the action parameters

Return Value

mixed in case the action is executed, you'll receive the result of the action, or NULL otherwise

in AbstractController at line 306
mixed request(string|null $key = null)

Get the whole $_REQUEST array or a specific requested value.

Parameters

string|null $key set to null to get the whole $_REQUEST array, or a string to get a specific value in $_GET or in $_POST

Return Value

mixed

at line 28
getElement()

in ElementController at line 16
getViewObject()

in ElementController at line 37
mixed getPackageHandle()

Return Value

mixed

in ElementController at line 45
setPackageHandle(mixed $pkgHandle)

Parameters

mixed $pkgHandle

in ElementController at line 54
render() deprecated

deprecated Consider using the Element class instead.

at line 17
setIncludeBreadcrumb(boolean $includeBreadcrumb)

Parameters

boolean $includeBreadcrumb

at line 33
view()