Sets
class Sets extends DashboardPageController (View source)
Traits
Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface
Properties
| protected Application | $app | from ApplicationAwareTrait | |
| $helpers | |||
| 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 string | $viewPath | The path to the view file (update it with the setViewPath method). |
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 BlockController[] | $blocks | from PageController | |
| private bool | $hasCheckedSessionMessages | 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 ElementManager | $elementManager | Useful for traversing the site for elements and their associated controls, while allowing for overriding. |
from DashboardPageController |
| protected BreadcrumbInterface | $breadcrumb | from DashboardPageController |
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.
Get the things "set" against this controller with $this->set(...)
This output array may also contain items set with $this->flash(...) like message error success or other
custom keys
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).
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.
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?
Override this method to send content created by the page controller to the indexer
Build a Redirect Response that instruct the browser to load the first accessible child page of this page.
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
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 things "set" against this controller with $this->set(...)
This output array may also contain items set with $this->flash(...) like message error success or other
custom keys
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
action()
No description
protected Controller
setViewPath(string $viewPath)
Set the path to the view file.
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
void
setBlockController(Block $block, BlockController $controller)
No description
BlockController|null
getBlockController(Block $block)
No description
validateRequest()
No description
bool
useUserLocale()
Should this page be displayed using the user's language?
getSearchableContent()
Override this method to send content created by the page controller to the indexer
RedirectResponse|Response
buildRedirectToFirstAccessibleChildPage()
Build a Redirect Response that instruct the browser to load the first accessible child page of this page.
enableNativeMobile()
Check if the current user is using a mobile device: if so, configure the dashboard page accordingly.
protected mixed
createBreadcrumbFactory()
No description
protected BreadcrumbInterface
createBreadcrumb()
No description
protected BreadcrumbInterface|null
getBreadcrumb()
No description
protected
setBreadcrumb(BreadcrumbInterface $breadcrumb)
No description
protected
getBreadcrumbElement()
No description
EntityManagerInterface|null
getEntityManager()
Get the EntityManager instance (available after the on_start method has been called).
view()
No description
file_set_added()
No description
file_set_deleted()
No description
delete($fsID, $token = '')
No description
view_detail($fsID, $action = false)
No description
file_sets_edit()
No description