Index

Dashboard\Controllers\Index

Overview

Index controller for the dashboard

Extends

Implements

Larajax\Contracts\AjaxControllerInterface

Public Properties

public array $implement

Extensions implemented by this controller.

public array $dashConfig

DashController configuration.

public array $requiredPermissions

requiredPermissions to view this page.

public string $turboRouter

Show inherited public properties

Protected Properties

protected object $listAllDashboardsCache

Show inherited protected properties

Public Methods

public __construct()

public __construct(): void

__construct the controller

public dashGetConfig()

public dashGetConfig(): void

dashGetConfig dynamically specifies the dash widget config from the dashboard model configuration.

public index()

public index($code = null): void

index controller action

Show inherited public methods

Inherited Public Methods

__call() - calls an undefined local method. (defined in October\Rain\Extension\Extendable)
__callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
__get() - an undefined property. (defined in October\Rain\Extension\Extendable)
__set() - an undefined property. (defined in October\Rain\Extension\Extendable)
__sleep() - prepare the object for serialization. (defined in October\Rain\Extension\Extendable)
__wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Extension\Extendable)
actionExists() - is always true for wildcards. (defined in Backend\Classes\WildcardController)
actionUrl() - returns a URL for this controller and supplied action. (defined in Backend\Classes\Controller)
addComponentInstance() - binds a view component to this controller under the given alias. (defined in Backend\Classes\Controller)
addCss() - includes a StyleSheet asset to the asset list. (defined in Backend\Classes\Controller)
addCssBundle() - includes a CSS asset to the bundled combiner pipeline. (defined in Backend\Classes\Controller)
addDynamicMethod() - programmatically adds a method to the extendable class. (defined in October\Rain\Extension\Extendable)
addDynamicProperty() - programmatically adds a property to the extendable class. (defined in October\Rain\Extension\Extendable)
addJs() - includes a JavaScript asset to the asset list. (defined in Backend\Classes\Controller)
addJsBundle() - includes a JS asset to the bundled combiner pipeline. (defined in Backend\Classes\Controller)
addRss() - adds an RSS link asset to the asset list. Call $this->makeAssets(). (defined in Backend\Classes\Controller)
addViewPath() - prepends a path on the available view path locations. (defined in Backend\Classes\Controller)
asExtension() - is short hand for getClassExtension() method, except takes the short. (defined in October\Rain\Extension\Extendable)
beforeDisplay() - is a method to override in your controller as a way to execute logic before. (defined in Backend\Classes\Controller)
bindEvent() - creates a new event binding. (defined in Backend\Classes\Controller)
bindEventOnce() - creates a new event binding that fires once only. (defined in Backend\Classes\Controller)
clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
combineAssets() - runs asset paths through the Asset Combiner. (defined in Backend\Classes\Controller)
dispatchBrowserEvent() - queues a browser event. (defined in Backend\Classes\Controller)
dispatchBrowserEventAsync() - dispatchBrowserEvent queues a browser event. (defined in Backend\Classes\Controller)
extend() - this class with a closure. (defined in October\Rain\Extension\Extendable)
extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Extension\Extendable)
extendableCall() - magic method for __call(). (defined in October\Rain\Extension\Extendable)
extendableCallStatic() - magic method for __callStatic(). (defined in October\Rain\Extension\Extendable)
extendableConstruct() - should be called as part of the constructor. (defined in October\Rain\Extension\Extendable)
extendableDestruct() - should be called when serializing the object. (defined in October\Rain\Extension\Extendable)
extendableExtendCallback() - is a helper method for ::extend() static method. (defined in October\Rain\Extension\Extendable)
extendableGet() - magic method for __get(). (defined in October\Rain\Extension\Extendable)
extendableSet() - magic method for __set(). (defined in October\Rain\Extension\Extendable)
fireEvent() - and call the listeners. (defined in Backend\Classes\Controller)
fireSystemEvent() - fires a combination of local and global events. The first segment is removed. (defined in Backend\Classes\Controller)
fireViewEvent() - is a special event function used for extending within view files, (defined in Backend\Classes\Controller)
flushAssets() - disables the use, and subsequent broadcast, of assets. This is useful. (defined in Backend\Classes\Controller)
getAction() - returns the action name. (defined in Backend\Classes\Controller)
getAjaxHandler() - returns the AJAX handler for the current request, if available. (defined in Backend\Classes\Controller)
getAjaxRequest() - returns the parsed AJAX request, constructing it on first access. (defined in Backend\Classes\Controller)
getAssetPath() - locates a file based on it's definition. If the file starts with. (defined in Backend\Classes\Controller)
getAssetPaths() - returns an array of all registered asset paths. (defined in Backend\Classes\Controller)
getAssetPathsWithAttributes() - returns an array of all registered asset paths. (defined in Backend\Classes\Controller)
getBrowserEvents() - returns the queued browser events. (defined in Backend\Classes\Controller)
getClassExtension() - returns a behavior object from an extendable class, example:. (defined in October\Rain\Extension\Extendable)
getClassMethodAsReflector() - (defined in October\Rain\Extension\Extendable)
getClassMethods() - gets a list of class methods, extension equivalent of get_class_methods(). (defined in October\Rain\Extension\Extendable)
getComponentInstance() - returns the bound component for the given alias, or null if. (defined in Backend\Classes\Controller)
getConfigPath() - locates a file based on it's definition. If the file starts with. (defined in Backend\Classes\Controller)
getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
getFatalError() - returns error message. (defined in Backend\Classes\Controller)
getId() - returns a unique ID for the controller and route. Useful in creating HTML markup. (defined in Backend\Classes\Controller)
getParams() - returns the action parameters. (defined in Backend\Classes\Controller)
getPublicActions() - returns the controllers public actions. (defined in Backend\Classes\Controller)
getResponseHeaders() - as a response header bag. (defined in Backend\Classes\Controller)
getStatusCode() - returns the status code for the current web response. (defined in Backend\Classes\Controller)
getTurboMetaTags() - returns an array of turbo meta tag definitions. (defined in Backend\Classes\Controller)
getViewPath() - locates a file based on its definition. The file name can be prefixed. (defined in Backend\Classes\Controller)
getViewPaths() - returns the active view path locations. (defined in Backend\Classes\Controller)
getWidget() - (defined in Backend\Classes\Controller)
guessConfigPath() - guesses the package path for the called class. (defined in Backend\Classes\Controller)
guessConfigPathFrom() - guesses the package path from a specified class. (defined in Backend\Classes\Controller)
guessViewPath() - guesses the package path for the called class. (defined in Backend\Classes\Controller)
guessViewPathFrom() - guesses the package path from a specified class, including. (defined in Backend\Classes\Controller)
handleError() - sets standard page variables in the case of a controller error. (defined in Backend\Classes\Controller)
hasAssetsDefined() - returns true if assets any have been added. (defined in Backend\Classes\Controller)
hasFatalError() - returns true if a fatal error has been set. (defined in Backend\Classes\Controller)
implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
isBackendHintHidden() - checks if a hint has been hidden by the user. (defined in Backend\Classes\Controller)
isClassExtendedWith() - checks if extendable class is extended with a behavior object. (defined in October\Rain\Extension\Extendable)
isClassInstanceOf() - checks if the class implements the supplied interface methods. (defined in October\Rain\Extension\Extendable)
isPublicAction() - returns true if the current action is public. (defined in Backend\Classes\Controller)
makeAssets() - outputs <link> and <script> tags to load assets previously added with addJs and addCss method calls. (defined in Backend\Classes\Controller)
makeConfig() - reads the contents of the supplied file and applies it to this object. (defined in Backend\Classes\Controller)
makeConfigFromArray() - makes a config object from an array, making the first. (defined in Backend\Classes\Controller)
makeFileContents() - includes a file path using output buffering. (defined in Backend\Classes\Controller)
makeFormWidget() - object with the supplied form field and widget configuration. (defined in Backend\Classes\Controller)
makeHintPartial() - renders a hint partial, used for displaying informative information that. (defined in Backend\Classes\Controller)
makeLayout() - renders a layout. (defined in Backend\Classes\Controller)
makeLayoutPartial() - renders a layout partial. (defined in Backend\Classes\Controller)
makePartial() - renders a partial file contents located in the views folder. (defined in Backend\Classes\Controller)
makeResponse() - prepares a response that considers overrides and custom responses. (defined in Backend\Classes\Controller)
makeView() - loads a view with the name specified. Applies layout if its name is provided. (defined in Backend\Classes\Controller)
makeViewContent() - renders supplied contents inside a layout. (defined in Backend\Classes\Controller)
makeWidget() - object with the supplied configuration file. (defined in Backend\Classes\Controller)
mergeConfig() - merges two configuration sources, either prepared or not, and returns. (defined in Backend\Classes\Controller)
methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
onAjax() - generic handler. (defined in Backend\Classes\Controller)
onHideBackendHint() - ajax handler to hide a backend hint, once hidden the partial. (defined in Backend\Classes\Controller)
outputVueComponentTemplates() - outputs templates and ESM component registration. (defined in Backend\Classes\Controller)
outputVueComponentsForAjax() - sends Vue component ESM files and registration. (defined in Backend\Classes\Controller)
pageAction() - invokes the current controller action without rendering a view. (defined in Backend\Classes\Controller)
propertyExists() - checks if a property exists, extension equivalent of property_exists(). (defined in October\Rain\Extension\Extendable)
registerVueComponent() - to be loaded when the action view renders. (defined in Backend\Classes\Controller)
run() - the action that is always index. (defined in Backend\Classes\WildcardController)
setResponse() - for the current page request cycle, this value takes priority. (defined in Backend\Classes\Controller)
setResponseCookie() - adds a cookie to the response. (defined in Backend\Classes\Controller)
setResponseHeader() - value. (defined in Backend\Classes\Controller)
setStatusCode() - Sets the status code for the current web response. (defined in Backend\Classes\Controller)
unbindEvent() - destroys an event binding. (defined in Backend\Classes\Controller)

Protected Methods

protected checkPermissionRedirect()

protected checkPermissionRedirect(): void

checkPermissionRedirect custom permissions check that will redirect to the next available menu item, if permission to this page is denied.

protected listAllDashboards()

protected listAllDashboards(): void

protected listDefinedDashboards()

protected listDefinedDashboards(): array

listDefinedDashboards returns the dashboards defined by the controller configuration, followed by those registered by plugins

protected syncAllDashboards()

protected syncAllDashboards(): void

Show inherited protected methods

Inherited Protected Methods

callAjaxAction() - initializes the AJAX request and component container, then dispatches. (defined in Backend\Classes\Controller)
combineBundledAssets() - spins over every bundle definition and combines them to an asset. (defined in Backend\Classes\Controller)
dispatchAjaxAction() - is the main entry point for Larajax dispatch. (defined in Backend\Classes\Controller)
emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in Backend\Classes\Controller)
execAjaxHandlers() - is used internally and invokes a controller event handler and. (defined in Backend\Classes\Controller)
execPageAction() - This method is used internally. (defined in Backend\Classes\Controller)
extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
getAjaxHandlerMethod() - resolves the AJAX handler name to a [object, method] callable, (defined in Backend\Classes\Controller)
getAssetEntryBuildPath() - is an internal marker that returns the asset path. (defined in Backend\Classes\Controller)
getAssetScheme() - is an internal helper to get the asset scheme. (defined in Backend\Classes\Controller)
getConfigValueFrom() - will apply the config getter convention. (defined in Backend\Classes\Controller)
getEsmModuleUrl() - converts a file path to a public URL. (defined in Backend\Classes\Controller)
getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
getLocalPath() - converts a relative path to a local path. (defined in Backend\Classes\Controller)
getVueComponentRegistrations() - builds a flat list of component registrations. (defined in Backend\Classes\Controller)
handleViewException() - handles a view exception. (defined in Backend\Classes\Controller)
initAjaxComponents() - ensures the component container is constructed and booted. (defined in Backend\Classes\Controller)
isVueComponentRegistered() - (defined in Backend\Classes\Controller)
makeCallForAjax() - proxies to makeCallMethod. (defined in Backend\Classes\Controller)
makeCallMethod() - will prepare method args with DI and call the method. (defined in Backend\Classes\Controller)
makePartialForAjax() - proxies to makePartial. (defined in Backend\Classes\Controller)
makeVueComponent() - (defined in Backend\Classes\Controller)
makeXsrfCookie() - adds anti-CSRF cookie. (defined in Backend\Classes\Controller)
processAssetAttributes() - (defined in Backend\Classes\Controller)
removeDuplicateAssets() - removes duplicate and global assets from the entire collection. (defined in Backend\Classes\Controller)
renderAssetAttributes() - takes an asset definition and returns the necessary HTML output. (defined in Backend\Classes\Controller)
runAjaxAction() - validates the requested handler name, resolves it to a callable via. (defined in Backend\Classes\Controller)
verifyCsrfToken() - checks if the request requires verification first (not GET, HEAD, OPTIONS) and. (defined in Backend\Classes\Controller)
verifyForceSecure() - checks if the back-end should force a secure protocol. (defined in Backend\Classes\Controller)
withAjaxControllerContext() - registers this controller as the current Larajax host. (defined in Backend\Classes\Controller)

Contents