Attributes
class Attributes extends Page (View source)
Traits
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 | $view | from Controller | |
| protected | $viewPath | ||
| protected | $theme | from Controller | |
| protected | $controllerActionPath | ||
| protected | $themeViewTemplate | from Controller | |
| protected ErrorList | $error | The current errors container. |
from UserInterface |
| protected string|null | $validationToken | An identifier to be used when checking tokens. |
from UserInterface |
| protected Page | $page | from Page | |
| protected Permissions | $permissions | from Page |
Methods
Adds an item to the view's header. This item will then be automatically printed out before the
section of the page.Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.
Should the action be executed? Override this method to answer something different than true.
Get the the helpers that will be be automatically sent to Views as variables.
Get the whole $_GET array or a specific querystring value.
Override this method to perform controller initializations.
Override this method to do something right before the view is rendered.
Get the whole $_POST array or a specific posted value.
Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).
Build a response that redirects clients to a specific URL/page (specify path(s) as argument(s) of $args).
Perform an action of this controller (if shouldRunControllerTask returns true).
Get the whole $_REQUEST array or a specific requested value.
Returns the wrapper file that holds the content of the view. Usually view.php.
Can the current page be accessed?
Check whether the token is valid and if the current page be accessed.
No description
No description
Retrieve attribute HTML to inject into the other view.
Details
setApplication(Application $app)
Setter method for the application
__construct()
Initialize the instance.
Request
getRequest()
Get the current request instance.
setRequest(Request $request)
Set the current request instance.
requireAsset()
Add an asset required in views.
This function accept the same parameters as the requireAsset method of the ResponseAssetGroup.
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.
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.
set(string $key, mixed $val)
Set a value to be sent to the view.
array
getSets()
Get the values to be sent to views.
bool
shouldRunControllerTask()
Should the action be executed? Override this method to answer something different than true.
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.
mixed
get(string|null $key = null, mixed $defaultValue = null)
Get the whole $_GET array or a specific querystring value.
getTask()
deprecated
deprecated
No description
string|null
getAction()
Get the action to be performed.
array|null
getParameters()
Get the action parameters.
on_start()
Override this method to perform controller initializations.
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.
isPost()
deprecated
deprecated
No description
mixed
post(string|null $key = null, mixed $defaultValue = null)
Get the whole $_POST array or a specific posted value.
redirect()
deprecated
deprecated
Redirect the clients to a specific URL/page (specify path(s) as argument(s) of this function).
RedirectResponse
buildRedirect(array|string|UrlInterface $destination, int $httpResponseCode = Response::HTTP_FOUND)
Build a response that redirects clients to a specific URL/page (specify path(s) as argument(s) of $args).
runTask(mixed $action, mixed $parameters)
deprecated
deprecated
No description
mixed
runAction(string $action, array $parameters = [])
Perform an action of this controller (if shouldRunControllerTask returns true).
mixed
request(string|null $key = null)
Get the whole $_REQUEST array or a specific requested value.
executeCommand(mixed $command)
Dispatches a command to the command bus.
dispatchBatch(Batch $batch)
No description
setViewObject(View $view)
No description
setTheme($mixed)
No description
getTheme()
No description
setThemeViewTemplate($template)
No description
string
getThemeViewTemplate()
Returns the wrapper file that holds the content of the view. Usually view.php.
getControllerActionPath()
No description
string
getViewPath()
Get the path to the view file.
flash($key, $value, $isHTML = false)
No description
getViewObject()
No description
in
Page at line 46
action()
No description
protected Controller
setViewPath(string $viewPath)
Set the path to the view file.
protected bool
canAccess()
Can the current page be accessed?
protected bool
validateAction()
Check whether the token is valid and if the current page be accessed.
in
Page at line 38
setPageObject(Page $c)
No description
protected
getAttributeJSONRepresentation(PageKey $ak, $mode = 'edit')
No description
view()
No description
submit()
No description
add_attribute()
Retrieve attribute HTML to inject into the other view.