Standard
abstract class Standard extends AbstractController (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 |
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 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).
Perform an action of this controller (if shouldRunControllerTask returns true).
Get the whole $_REQUEST array or a specific requested value.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
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).
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.
abstract protected
canAccess()
No description
abstract protected AdvancedSearch
getAdvancedSearchDialogController()
No description
protected
getDefaultResetSearchResultObject()
No description
protected
getDefaultBasicSearchResultObject()
No description
abstract protected
getSavedSearchPreset($presetID)
No description
protected
getBasicSearchFieldsFromRequest()
No description
searchBasic()
No description
clearSearch()
No description
getCurrentSearchObject()
No description
searchCurrent()
No description
protected
onAfterSearchPreset(Result $result, SavedSearch $search)
No description
searchPreset($presetID)
No description