Search
class Search extends DashboardPageController (View source)
Traits
Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface
Properties
| protected Application | $app | from ApplicationAwareTrait | |
| protected | $helpers | {@inheritdoc} | from DashboardPageController |
| protected array | $sets | The values to be sent to views. |
from AbstractController |
| protected | $action | from PageController | |
| protected Request|null | $request | The current request instance. |
from AbstractController |
| protected | $parameters | from PageController | |
| protected | $view | from Controller | |
| protected | $viewPath | from Controller | |
| protected | $theme | from Controller | |
| protected | $controllerActionPath | from Controller | |
| protected | $themeViewTemplate | from Controller | |
| protected | $supportsPageCache | from PageController | |
| protected | $passThruBlocks | from PageController | |
| protected | $replacement | from PageController | |
| protected | $requestValidated | from PageController | |
| protected | $restrictedMethods | {@inheritdoc} | from DashboardPageController |
| protected string|null | $customRequestPath | Custom request path - overrides Request::getPath() (useful when replacing controllers). |
from PageController |
| Page | $c | from PageController | |
| Token|null | $token | The Token instance (available after the on_start method has been called). |
from DashboardPageController |
| protected ErrorList|null | $error | The ErrorList instance (available after the on_start method has been called). |
from DashboardPageController |
| protected EntityManagerInterface|null | $entityManager | The EntityManager instance (available after the on_start method has been called). |
from DashboardPageController |
| protected UserInfo|false | $user |
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.
Given either a path or a Page object, this is a shortcut to
- Grab the controller of THAT page.
Set the custom request path (useful when replacing controllers).
Get the custom request path (useful when replacing controllers).
Given a path to a single page, this command uses the CURRENT controller and renders the contents of the single page within this request. The current controller is not replaced, and has already fired (since it is meant to be called from within a view() or similar method).
Should this page be displayed using the user's language?
Check if the current user is using a mobile device: if so, configure the dashboard page accordingly.
Get the EntityManager instance (available after the on_start method has been called).
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Export Users using the current search filters into a CSV.
No description
Details
setApplication(Application $app)
Setter method for the application
__construct(Page $c)
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.
setViewObject(AbstractView $view)
No description
setTheme($mixed)
No description
getTheme()
No description
setThemeViewTemplate($template)
No description
getThemeViewTemplate()
No description
getControllerActionPath()
No description
flash($key, $value, $isHTML = false)
No description
getViewObject()
No description
action()
No description
supportsPageCache()
No description
replace($var)
Given either a path or a Page object, this is a shortcut to
- Grab the controller of THAT page.
- Grab the view of THAT controller
- Render that view.
- Exit – so we immediately stop all other output in the controller that called render().
setCustomRequestPath(string|null $requestPath)
Set the custom request path (useful when replacing controllers).
string|null
getCustomRequestPath()
Get the custom request path (useful when replacing controllers).
isReplaced()
No description
getReplacement()
No description
render($path, $pkgHandle = null)
Given a path to a single page, this command uses the CURRENT controller and renders the contents of the single page within this request. The current controller is not replaced, and has already fired (since it is meant to be called from within a view() or similar method).
getPageObject()
No description
getRequestAction()
No description
getRequestActionParameters()
No description
setupRequestActionAndParameters(Request $request)
No description
isValidControllerTask($action, $parameters = array())
No description
setPassThruBlockController(Block $b, BlockController $controller)
No description
getPassThruBlockController(Block $b)
No description
validateRequest()
No description
bool
useUserLocale()
Should this page be displayed using the user's language?
enableNativeMobile()
Check if the current user is using a mobile device: if so, configure the dashboard page accordingly.
EntityManagerInterface|null
getEntityManager()
Get the EntityManager instance (available after the on_start method has been called).
update_avatar($uID = false)
No description
update_status($uID = false)
No description
update_email($uID = false)
No description
update_timezone($uID = false)
No description
update_language($uID = false)
No description
update_username($uID = false)
No description
update_attribute($uID = false)
No description
clear_attribute($uID = false)
No description
change_password($uID = false)
No description
get_timezones()
No description
get_languages()
No description
delete_complete()
No description
view($uID = false, $status = false)
No description
csv_export()
Export Users using the current search filters into a CSV.
protected
setupUser($uID)
No description