class Connect extends DashboardPageController (View source)

deprecated This will be removed in version 10

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 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
protected $editingDisabled 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

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.

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.

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

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

getTask() 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.

isPost() deprecated

No description

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

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

redirect() 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

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

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

  1. Grab the controller of THAT page.

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

disableEditing()

Disables the display of an editing toolbar on the page. This does not impact permissions – it's an additional check that is used when pages are previewed (e.g. when we want to show a page but not the toolbar, even if the user is logged in.) This has to be a separate check because sometimes pages are protected but we still want to act like the user can't edit the page. We can't just use setCustomRequestUser and set it to -1.

bool
isEditingDisabled()

No description

isValidControllerTask($action, $parameters = array())

No description

setPassThruBlockController(Block $b, BlockController $controller)

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.

mixed
createBreadcrumbFactory()

No description

BreadcrumbInterface|null
getBreadcrumb()

No description

setBreadcrumb(BreadcrumbInterface $breadcrumb)

No description

EntityManagerInterface|null
getEntityManager()

Get the EntityManager instance (available after the on_start method has been called).

view()

No description

do_connect()

No description

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(Page $c)

Initialize the instance.

Parameters

Page $c

Request getRequest()

Get the current request instance.

Return Value

Request

setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

requireAsset()

Add an asset required in views.

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

See also

ResponseAssetGroup::requireAsset

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

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

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

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

Return Value

array

bool shouldRunControllerTask()

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

Return Value

bool

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

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

getTask() deprecated

deprecated use the getAction() method

No description

string|null getAction()

Get the action to be performed.

Return Value

string|null

array|null getParameters()

Get the action parameters.

Return Value

array|null

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 Use $this->getRequest()->isPost();

No description

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

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).

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).

Parameters

array|string|UrlInterface $destination

use an Url object to specify the destination URL, or a string/array of strings to build the URL with the resolver

int $httpResponseCode

the HTTP response code

Return Value

RedirectResponse

runTask(mixed $action, mixed $parameters) deprecated

deprecated use the runAction method

No description

Parameters

mixed $action
mixed $parameters

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

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

executeCommand(mixed $command)

Dispatches a command to the command bus.

Parameters

mixed $command

dispatchBatch(Batch $batch)

No description

Parameters

Batch $batch

setViewObject(View $view)

No description

Parameters

View $view

setTheme($mixed)

No description

Parameters

$mixed

getTheme()

No description

setThemeViewTemplate($template)

No description

Parameters

$template

string getThemeViewTemplate()

Returns the wrapper file that holds the content of the view. Usually view.php.

Return Value

string

getControllerActionPath()

No description

string getViewPath()

Get the path to the view file.

Return Value

string

flash($key, $value, $isHTML = false)

No description

Parameters

$key
$value
$isHTML

getViewObject()

No description

action()

No description

protected Controller setViewPath(string $viewPath)

Set the path to the view file.

Parameters

string $viewPath

Return Value

Controller

supportsPageCache()

No description

replace($var)

Given either a path or a Page object, this is a shortcut to

  1. Grab the controller of THAT page.

  1. Grab the view of THAT controller
  2. Render that view.
  3. Exit – so we immediately stop all other output in the controller that called render().

Parameters

$var

setCustomRequestPath(string|null $requestPath)

Set the custom request path (useful when replacing controllers).

Parameters

string|null $requestPath

Set to null to use the default request path

string|null getCustomRequestPath()

Get the custom request path (useful when replacing controllers).

Return Value

string|null

Returns null if no custom request path, a string otherwise

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).

Parameters

$path
$pkgHandle

getPageObject()

No description

getRequestAction()

No description

getRequestActionParameters()

No description

disableEditing()

Disables the display of an editing toolbar on the page. This does not impact permissions – it's an additional check that is used when pages are previewed (e.g. when we want to show a page but not the toolbar, even if the user is logged in.) This has to be a separate check because sometimes pages are protected but we still want to act like the user can't edit the page. We can't just use setCustomRequestUser and set it to -1.

bool isEditingDisabled()

No description

Return Value

bool

setupRequestActionAndParameters(Request $request)

No description

Parameters

Request $request

isValidControllerTask($action, $parameters = array())

No description

Parameters

$action
$parameters

setPassThruBlockController(Block $b, BlockController $controller)

No description

Parameters

Block $b
BlockController $controller

getPassThruBlockController(Block $b)

No description

Parameters

Block $b

void setBlockController(Block $block, BlockController $controller)

Since: 9.0.3

No description

Parameters

Block $block
BlockController $controller

Return Value

void

BlockController|null getBlockController(Block $block)

Since: 9.0.3

No description

Parameters

Block $block

Return Value

BlockController|null

validateRequest()

No description

bool useUserLocale()

Should this page be displayed using the user's language?

Return Value

bool

See also

PageController::useUserLocale

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.

Return Value

RedirectResponse|Response

Return a RedirectResponse if an accessible child page is found, a forbidden Response otherwise

enableNativeMobile()

Check if the current user is using a mobile device: if so, configure the dashboard page accordingly.

protected mixed createBreadcrumbFactory()

No description

Return Value

mixed

protected BreadcrumbInterface createBreadcrumb()

No description

Return Value

BreadcrumbInterface

protected BreadcrumbInterface|null getBreadcrumb()

No description

Return Value

BreadcrumbInterface|null

protected setBreadcrumb(BreadcrumbInterface $breadcrumb)

No description

Parameters

BreadcrumbInterface $breadcrumb

protected getBreadcrumbElement()

No description

EntityManagerInterface|null getEntityManager()

Get the EntityManager instance (available after the on_start method has been called).

Return Value

EntityManagerInterface|null

view()

No description

do_connect()

No description