Users
extends Controller
in package
Backend user controller
Tags
Table of Contents
- $assetPath : string
- $bodyClass : string
- $formConfig : array<string|int, mixed>
- $hiddenActions : array<string|int, mixed>
- $implement : array<string|int, mixed>
- $layout : string
- $listConfig : array<string|int, mixed>
- $pageTitle : string
- $pageTitleTemplate : string
- $requiredPermissions : array<string|int, mixed>
- $suppressLayout : bool
- $suppressView : bool
- $vars : array<string|int, mixed>
- $widget : array<string|int, mixed>
- $action : string
- $assets : array<string|int, mixed>
- $configPath : string
- $extendableCallbacks : array<string|int, mixed>
- $extendableGuardProperties : bool
- $extendableStaticMethods : array<string|int, mixed>
- $extensionData : array<string|int, mixed>
- $fatalError : string
- $guarded : array<string|int, mixed>
- $layoutPath : string
- $middleware : array<string|int, mixed>
- The middleware registered on the controller.
- $params : array<string|int, mixed>
- $publicActions : array<string|int, mixed>
- $responseHeaderBag : ResponseHeaderBag
- $responseOverride : mixed
- $statusCode : int
- $user : object
- $viewPath : string|array<string|int, mixed>
- __call() : mixed
- Handle calls to missing methods on the controller.
- __callStatic() : mixed
- __construct() : mixed
- Constructor.
- __get() : mixed
- __set() : mixed
- actionExists() : bool
- This method is used internally.
- actionUrl() : mixed
- Returns a URL for this controller and supplied action.
- addCss() : void
- Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
- addDynamicMethod() : mixed
- Programmatically adds a method to the extendable class
- addDynamicProperty() : mixed
- Programmatically adds a property to the extendable class
- addJs() : void
- Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
- addRss() : void
- Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
- addViewPath() : void
- Prepends a path on the available view path locations.
- asExtension() : mixed
- Short hand for `getClassExtension()` method, except takes the short extension name, example:
- callAction() : Response
- Execute an action on the controller.
- clearExtendedClasses() : void
- Clear the list of extended classes so they will be re-extended.
- combineAssets() : string
- Run the provided assets through the Asset Combiner
- extend() : mixed
- Extend this object properties upon construction.
- extendableCall() : mixed
- Magic method for `__call()`
- extendableCallStatic() : mixed
- Magic method for `__callStatic()`
- extendableConstruct() : mixed
- This method should be called as part of the constructor.
- extendableExtendCallback() : void
- Helper method for `::extend()` static method
- extendableGet() : string
- Magic method for `__get()`
- extendableSet() : string
- Magic method for `__set()`
- extendClassWith() : void
- Dynamically extend a class with a specified behavior
- fireSystemEvent() : mixed
- Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.
- fireViewEvent() : string
- Special event function used for extending within view files, allowing HTML to be injected multiple times.
- flushAssets() : void
- Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.
- formExtendFields() : mixed
- Add available permission fields to the User form.
- formExtendQuery() : mixed
- Extends the form query to prevent non-superusers from accessing superusers at all
- getAjaxHandler() : string
- Returns the AJAX handler for the current request, if available.
- getAssetPath() : string
- Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.
- getAssetPaths() : array<string|int, mixed>
- Returns an array of all registered asset paths.
- getClassExtension() : mixed
- Returns a behavior object from an extendable class, example:
- getClassMethods() : array<string|int, mixed>
- Get a list of class methods, extension equivalent of get_class_methods()
- getConfigPath() : string
- Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
- getDynamicProperties() : array<string|int, mixed>
- Returns all dynamic properties and their values
- getFatalError() : string
- getId() : mixed
- Returns a unique ID for the controller and route. Useful in creating HTML markup.
- getMiddleware() : array<string|int, mixed>
- Get the middleware assigned to the controller.
- getPublicActions() : mixed
- Returns the controllers public actions.
- getResponseHeaders() : ResponseHeaderBag|null
- Get the header response bag
- getStatusCode() : int
- Returns the status code for the current web response.
- getViewPath() : string
- Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.
- getViewPaths() : array<string|int, mixed>
- Returns the active view path locations.
- guessConfigPath() : string
- Guess the package path for the called class.
- guessConfigPathFrom() : string
- Guess the package path from a specified class.
- guessViewPath() : string
- Guess the package path for the called class.
- guessViewPathFrom() : string
- Guess the package path from a specified class.
- handleError() : mixed
- Sets standard page variables in the case of a controller error.
- hasAssetsDefined() : bool
- Returns true if assets any have been added.
- hasFatalError() : bool
- isBackendHintHidden() : bool
- Checks if a hint has been hidden by the user.
- isClassExtendedWith() : bool
- Check if extendable class is extended with a behavior object
- listExtendQuery() : mixed
- Extends the list query to hide superusers if the current user is not a superuser themselves
- listFilterExtendScopes() : mixed
- Prevents non-superusers from even seeing the is_superuser filter
- listInjectRowClass() : mixed
- Strike out deleted records
- makeAssets() : string
- Outputs `<link>` and `<script>` tags to load assets previously added with addJs and addCss method calls
- makeConfig() : array<string|int, mixed>|stdClass
- Reads the contents of the supplied file and applies it to this object.
- makeConfigFromArray() : stdClass
- Makes a config object from an array, making the first level keys properties of a new object.
- makeFileContents() : string
- Includes a file path using output buffering.
- makeFormWidget() : FormWidgetBase
- Makes a form widget object with the supplied form field and widget configuration.
- makeHintPartial() : string
- Renders a hint partial, used for displaying informative information that can be hidden by the user. If you don't want to render a partial, you can supply content via the 'content' key of $params.
- makeLayout() : mixed
- Render a layout.
- makeLayoutPartial() : string
- Renders a layout partial
- makePartial() : mixed
- Render a partial file contents located in the views folder.
- makeResponse() : mixed
- Prepares a response that considers overrides and custom responses.
- makeView() : string
- Loads a view with the name specified. Applies layout if its name is provided by the parent object.
- makeViewContent() : string
- Renders supplied contents inside a layout.
- makeWidget() : mixed|WidgetBase
- Makes a widget object with the supplied configuration file.
- mergeConfig() : stdClass
- Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
- methodExists() : bool
- Checks if a method exists, extension equivalent of method_exists()
- middleware() : ControllerMiddlewareOptions
- Register middleware on the controller.
- myaccount() : mixed
- My Settings controller
- myaccount_onSave() : mixed
- Proxy update onSave event
- onHideBackendHint() : void
- Ajax handler to hide a backend hint, once hidden the partial will no longer display for the user.
- pageAction() : mixed
- Invokes the current controller action without rendering a view, used by AJAX handler that may rely on the logic inside the action.
- propertyExists() : bool
- Checks if a property exists, extension equivalent of `property_exists()`
- run() : mixed
- Execute the controller action.
- setResponse() : $this
- Sets the response for the current page request cycle, this value takes priority over the standard response prepared by the controller.
- setResponseCookie() : $this
- Add a cookie to the response.
- setResponseHeader() : $this
- Set a header on the Response.
- setStatusCode() : $this
- Sets the status code for the current web response.
- update() : mixed
- Update controller
- update_onImpersonateUser() : mixed
- Impersonate this user
- update_onRestore() : mixed
- Handle restoring users
- update_onUnsuspendUser() : mixed
- Unsuspend this user
- addAsset() : mixed
- Adds the provided asset to the internal asset collections
- execAjaxHandlers() : mixed
- This method is used internally.
- execPageAction() : mixed
- This method is used internally.
- extendableIsAccessible() : bool
- Checks if a property is accessible, property equivalent of `is_callable()`
- extensionExtractMethods() : void
- Extracts the available methods from a behavior and adds it to the list of callable methods.
- generatePermissionsField() : array<string|int, mixed>
- Adds the permissions editor widget to the form.
- getAssetEntryBuildPath() : string
- Internal helper, attaches a build code to an asset path
- getAssetScheme() : string
- Internal helper, get asset scheme
- getLocalPath() : mixed
- handleViewException() : void
- Handle a view exception.
- makeXsrfCookie() : Cookie
- Adds anti-CSRF cookie.
- removeDuplicates() : void
- Removes duplicate assets from the entire collection.
- runAjaxHandler() : bool
- Tries to find and run an AJAX handler in the page action.
- runAjaxHandlerForWidget() : mixed
- Specific code for executing an AJAX handler for a widget.
- verifyCsrfToken() : bool
- Checks the request data / headers for a valid CSRF token.
- verifyForceSecure() : bool
- Checks if the back-end should force a secure protocol (HTTPS) enabled by config.
Properties
$assetPath
public
string
$assetPath
Specifies a path to the asset directory.
$bodyClass
public
string
$bodyClass
= 'compact-container'
HTML body tag class
$formConfig
public
array<string|int, mixed>
$formConfig
= 'config_form.yaml'
FormController configuration.
$hiddenActions
public
array<string|int, mixed>
$hiddenActions
= ['run', 'actionExists', 'pageAction', 'getId', 'setStatusCode', 'handleError', 'makeHintPartial']
Default methods which cannot be called as actions.
$implement
public
array<string|int, mixed>
$implement
= [BackendBehaviorsFormController::class, BackendBehaviorsListController::class]
Extensions implemented by this controller.
$layout
public
string
$layout
Layout to use for the view.
$listConfig
public
array<string|int, mixed>
$listConfig
= 'config_list.yaml'
ListController configuration.
$pageTitle
public
string
$pageTitle
Page title
$pageTitleTemplate
public
string
$pageTitleTemplate
Page title template
$requiredPermissions
public
array<string|int, mixed>
$requiredPermissions
= ['backend.manage_users']
Permissions required to view this page.
$suppressLayout
public
bool
$suppressLayout
= false
Prevents the use of a layout.
$suppressView
public
bool
$suppressView
= false
Prevents the automatic view display.
$vars
public
array<string|int, mixed>
$vars
= []
A list of variables to pass to the page.
$widget
public
array<string|int, mixed>
$widget
Collection of WidgetBase objects used on this page.
$action
protected
string
$action
Page action being called.
$assets
protected
array<string|int, mixed>
$assets
= ['js' => [], 'css' => [], 'rss' => []]
Collection of assets to display in the layout.
$configPath
protected
string
$configPath
Specifies a path to the config directory.
$extendableCallbacks
protected
static array<string|int, mixed>
$extendableCallbacks
= []
Used to extend the constructor of an extendable class. Eg:
Class::extend(function($obj) { })
$extendableGuardProperties
protected
static bool
$extendableGuardProperties
= true
Indicates if dynamic properties can be created.
$extendableStaticMethods
protected
static array<string|int, mixed>
$extendableStaticMethods
= []
Collection of static methods used by behaviors.
$extensionData
protected
array<string|int, mixed>
$extensionData
= ['extensions' => [], 'methods' => [], 'dynamicMethods' => [], 'dynamicProperties' => []]
Class reflection information, including behaviors.
$fatalError
protected
string
$fatalError
Object used for storing a fatal error.
$guarded
protected
array<string|int, mixed>
$guarded
= []
Controller specified methods which cannot be called as actions.
$layoutPath
protected
string
$layoutPath
Specifies a path to the layout directory.
$middleware
The middleware registered on the controller.
protected
array<string|int, mixed>
$middleware
= []
$params
protected
array<string|int, mixed>
$params
Routed parameters.
$publicActions
protected
array<string|int, mixed>
$publicActions
= []
Defines a collection of actions available without authentication.
$responseHeaderBag
protected
ResponseHeaderBag
$responseHeaderBag
= null
$responseOverride
protected
mixed
$responseOverride
= null
Override the standard controller response.
$statusCode
protected
int
$statusCode
= 200
Response status code
$user
protected
object
$user
Reference the logged in admin user.
$viewPath
protected
string|array<string|int, mixed>
$viewPath
Specifies a path to the views directory.
Methods
__call()
Handle calls to missing methods on the controller.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —__callStatic()
public
static __callStatic(mixed $name, mixed $params) : mixed
Parameters
- $name : mixed
- $params : mixed
Return values
mixed —__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__set()
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixed —actionExists()
This method is used internally.
public
actionExists(string $name[, bool $internal = false ]) : bool
Determines whether an action with the specified name exists. Action must be a class public method. Action name can not be prefixed with the underscore character.
Parameters
- $name : string
-
Specifies the action name.
- $internal : bool = false
-
Allow protected actions.
Return values
bool —actionUrl()
Returns a URL for this controller and supplied action.
public
actionUrl([mixed $action = null ][, mixed $path = null ]) : mixed
Parameters
- $action : mixed = null
- $path : mixed = null
Return values
mixed —addCss()
Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
public
addCss(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
- $name : string
-
Specifies a path (URL) to the script.
- $attributes : array<string|int, mixed> = []
-
Adds extra HTML attributes to the asset link.
Return values
void —addDynamicMethod()
Programmatically adds a method to the extendable class
public
addDynamicMethod(string $dynamicName, callable $method[, string $extension = null ]) : mixed
Parameters
- $dynamicName : string
- $method : callable
- $extension : string = null
Return values
mixed —addDynamicProperty()
Programmatically adds a property to the extendable class
public
addDynamicProperty(string $dynamicName[, string $value = null ]) : mixed
Parameters
- $dynamicName : string
- $value : string = null
Return values
mixed —addJs()
Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
public
addJs(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
- $name : string
-
Specifies a path (URL) to the script.
- $attributes : array<string|int, mixed> = []
-
Adds extra HTML attributes to the asset link.
Return values
void —addRss()
Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
public
addRss(string $name[, array<string|int, mixed> $attributes = [] ]) : void
Parameters
- $name : string
-
Specifies a path (URL) to the RSS channel
- $attributes : array<string|int, mixed> = []
-
Adds extra HTML attributes to the asset link.
Return values
void —addViewPath()
Prepends a path on the available view path locations.
public
addViewPath(string|array<string|int, mixed> $path) : void
Parameters
- $path : string|array<string|int, mixed>
Return values
void —asExtension()
Short hand for `getClassExtension()` method, except takes the short extension name, example:
public
asExtension(string $shortName) : mixed
$this->asExtension('FormController')
Parameters
- $shortName : string
Return values
mixed —callAction()
Execute an action on the controller.
public
callAction(string $method, array<string|int, mixed> $parameters) : Response
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Return values
Response —clearExtendedClasses()
Clear the list of extended classes so they will be re-extended.
public
static clearExtendedClasses() : void
Return values
void —combineAssets()
Run the provided assets through the Asset Combiner
public
combineAssets(array<string|int, mixed> $assets[, string $localPath = '' ]) : string
Parameters
- $assets : array<string|int, mixed>
-
Collection of assets
- $localPath : string = ''
-
Prefix all assets with this path (optional)
Return values
string —extend()
Extend this object properties upon construction.
public
static extend(Closure $callback) : mixed
Parameters
- $callback : Closure
Return values
mixed —extendableCall()
Magic method for `__call()`
public
extendableCall(string $name[, array<string|int, mixed> $params = null ]) : mixed
Parameters
- $name : string
- $params : array<string|int, mixed> = null
Return values
mixed —extendableCallStatic()
Magic method for `__callStatic()`
public
static extendableCallStatic(string $name[, array<string|int, mixed> $params = null ]) : mixed
Parameters
- $name : string
- $params : array<string|int, mixed> = null
Return values
mixed —extendableConstruct()
This method should be called as part of the constructor.
public
extendableConstruct() : mixed
Return values
mixed —extendableExtendCallback()
Helper method for `::extend()` static method
public
static extendableExtendCallback(callable $callback) : void
Parameters
- $callback : callable
Return values
void —extendableGet()
Magic method for `__get()`
public
extendableGet(string $name) : string
Parameters
- $name : string
Return values
string —extendableSet()
Magic method for `__set()`
public
extendableSet(string $name, string $value) : string
Parameters
- $name : string
- $value : string
Return values
string —extendClassWith()
Dynamically extend a class with a specified behavior
public
extendClassWith(string $extensionName) : void
Parameters
- $extensionName : string
Return values
void —fireSystemEvent()
Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.
public
fireSystemEvent(string $event[, array<string|int, mixed> $params = [] ][, bool $halt = true ]) : mixed
For example:
$this->fireSystemEvent('backend.list.myEvent', ['my value']);
Is equivalent to:
$this->fireEvent('list.myEvent', ['myvalue'], true);
Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);
Parameters
- $event : string
-
Event name
- $params : array<string|int, mixed> = []
-
Event parameters
- $halt : bool = true
-
Halt after first non-null result
Return values
mixed —fireViewEvent()
Special event function used for extending within view files, allowing HTML to be injected multiple times.
public
fireViewEvent(string $event[, array<string|int, mixed> $params = [] ]) : string
For example:
fireViewEvent('backend.auth.extendSigninView') ?>Parameters
- $event : string
-
Event name
- $params : array<string|int, mixed> = []
-
Event parameters
Return values
string —flushAssets()
Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.
public
flushAssets() : void
Return values
void —formExtendFields()
Add available permission fields to the User form.
public
formExtendFields(mixed $form) : mixed
Mark default groups as checked for new Users.
Parameters
- $form : mixed
Return values
mixed —formExtendQuery()
Extends the form query to prevent non-superusers from accessing superusers at all
public
formExtendQuery(mixed $query) : mixed
Parameters
- $query : mixed
Return values
mixed —getAjaxHandler()
Returns the AJAX handler for the current request, if available.
public
getAjaxHandler() : string
Return values
string —getAssetPath()
Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.
public
getAssetPath(string $fileName[, string $assetPath = null ]) : string
Parameters
- $fileName : string
-
File to load.
- $assetPath : string = null
-
Explicitly define an asset path.
Return values
string —Relative path to the asset file.
getAssetPaths()
Returns an array of all registered asset paths.
public
getAssetPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —getClassExtension()
Returns a behavior object from an extendable class, example:
public
getClassExtension(string $name) : mixed
$this->getClassExtension('Backend.Behaviors.FormController')
Parameters
- $name : string
-
Fully qualified behavior name
Return values
mixed —getClassMethods()
Get a list of class methods, extension equivalent of get_class_methods()
public
getClassMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —getConfigPath()
Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
public
getConfigPath(string $fileName[, mixed $configPath = null ]) : string
Parameters
- $fileName : string
-
File to load.
- $configPath : mixed = null
-
Explicitly define a config path.
Return values
string —Full path to the config file.
getDynamicProperties()
Returns all dynamic properties and their values
public
getDynamicProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —['property' => 'value']
getFatalError()
public
getFatalError() : string
Return values
string —The fatal error message
getId()
Returns a unique ID for the controller and route. Useful in creating HTML markup.
public
getId([mixed $suffix = null ]) : mixed
Parameters
- $suffix : mixed = null
Return values
mixed —getMiddleware()
Get the middleware assigned to the controller.
public
getMiddleware() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublicActions()
Returns the controllers public actions.
public
getPublicActions() : mixed
Return values
mixed —getResponseHeaders()
Get the header response bag
public
getResponseHeaders() : ResponseHeaderBag|null
Return values
ResponseHeaderBag|null —getStatusCode()
Returns the status code for the current web response.
public
getStatusCode() : int
Return values
int —Status code
getViewPath()
Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.
public
getViewPath(string $fileName[, mixed $viewPath = null ]) : string
Parameters
- $fileName : string
-
File to load.
- $viewPath : mixed = null
-
Explicitly define a view path.
Return values
string —Full path to the view file.
getViewPaths()
Returns the active view path locations.
public
getViewPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —guessConfigPath()
Guess the package path for the called class.
public
guessConfigPath([string $suffix = '' ]) : string
Parameters
- $suffix : string = ''
-
An extra path to attach to the end
Return values
string —guessConfigPathFrom()
Guess the package path from a specified class.
public
guessConfigPathFrom(string $class[, string $suffix = '' ]) : string
Parameters
- $class : string
-
Class to guess path from.
- $suffix : string = ''
-
An extra path to attach to the end
Return values
string —guessViewPath()
Guess the package path for the called class.
public
guessViewPath([string $suffix = '' ][, bool $isPublic = false ]) : string
Parameters
- $suffix : string = ''
-
An extra path to attach to the end
- $isPublic : bool = false
-
Returns public path instead of an absolute one
Return values
string —guessViewPathFrom()
Guess the package path from a specified class.
public
guessViewPathFrom(string $class[, string $suffix = '' ][, bool $isPublic = false ]) : string
Parameters
- $class : string
-
Class to guess path from.
- $suffix : string = ''
-
An extra path to attach to the end
- $isPublic : bool = false
-
Returns public path instead of an absolute one
Return values
string —handleError()
Sets standard page variables in the case of a controller error.
public
handleError(mixed $exception) : mixed
Parameters
- $exception : mixed
Return values
mixed —hasAssetsDefined()
Returns true if assets any have been added.
public
hasAssetsDefined() : bool
Return values
bool —hasFatalError()
public
hasFatalError() : bool
Return values
bool —Whether a fatal error has been set or not.
isBackendHintHidden()
Checks if a hint has been hidden by the user.
public
isBackendHintHidden(string $name) : bool
Parameters
- $name : string
-
Unique key name
Return values
bool —isClassExtendedWith()
Check if extendable class is extended with a behavior object
public
isClassExtendedWith(string $name) : bool
Parameters
- $name : string
-
Fully qualified behavior name
Return values
bool —listExtendQuery()
Extends the list query to hide superusers if the current user is not a superuser themselves
public
listExtendQuery(mixed $query) : mixed
Parameters
- $query : mixed
Return values
mixed —listFilterExtendScopes()
Prevents non-superusers from even seeing the is_superuser filter
public
listFilterExtendScopes(mixed $filterWidget) : mixed
Parameters
- $filterWidget : mixed
Return values
mixed —listInjectRowClass()
Strike out deleted records
public
listInjectRowClass(mixed $record[, mixed $definition = null ]) : mixed
Parameters
- $record : mixed
- $definition : mixed = null
Return values
mixed —makeAssets()
Outputs `<link>` and `<script>` tags to load assets previously added with addJs and addCss method calls
public
makeAssets([string $type = null ]) : string
Parameters
- $type : string = null
-
Return an asset collection of a given type (css, rss, js) or null for all.
Return values
string —makeConfig()
Reads the contents of the supplied file and applies it to this object.
public
makeConfig([array<string|int, mixed> $configFile = [] ][, array<string|int, mixed> $requiredConfig = [] ]) : array<string|int, mixed>|stdClass
Parameters
- $configFile : array<string|int, mixed> = []
- $requiredConfig : array<string|int, mixed> = []
Return values
array<string|int, mixed>|stdClass —makeConfigFromArray()
Makes a config object from an array, making the first level keys properties of a new object.
public
makeConfigFromArray([array<string|int, mixed> $configArray = [] ]) : stdClass
Parameters
- $configArray : array<string|int, mixed> = []
-
Config array.
Return values
stdClass —The config object
makeFileContents()
Includes a file path using output buffering.
public
makeFileContents(string $filePath[, array<string|int, mixed> $extraParams = [] ]) : string
Ensures that vars are available.
Parameters
- $filePath : string
-
Absolute path to the view file.
- $extraParams : array<string|int, mixed> = []
-
Parameters that should be available to the view.
Return values
string —makeFormWidget()
Makes a form widget object with the supplied form field and widget configuration.
public
makeFormWidget(string $class[, mixed $fieldConfig = [] ][, array<string|int, mixed> $widgetConfig = [] ]) : FormWidgetBase
Parameters
- $class : string
-
Widget class name
- $fieldConfig : mixed = []
-
A field name, an array of config or a FormField object.
- $widgetConfig : array<string|int, mixed> = []
-
An array of config.
Return values
FormWidgetBase —The widget object
makeHintPartial()
Renders a hint partial, used for displaying informative information that can be hidden by the user. If you don't want to render a partial, you can supply content via the 'content' key of $params.
public
makeHintPartial(string $name[, string $partial = null ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $name : string
-
Unique key name
- $partial : string = null
-
Reference to content (partial name)
- $params : array<string|int, mixed> = []
-
Extra parameters
Return values
string —makeLayout()
Render a layout.
public
makeLayout([string $name = null ][, array<string|int, mixed> $params = [] ][, bool $throwException = true ]) : mixed
Parameters
- $name : string = null
-
Specifies the layout name. If this parameter is omitted, the $layout property will be used.
- $params : array<string|int, mixed> = []
-
Parameter variables to pass to the view.
- $throwException : bool = true
-
Throw an exception if the layout is not found
Return values
mixed —The layout contents, or false.
makeLayoutPartial()
Renders a layout partial
public
makeLayoutPartial(string $partial[, array<string|int, mixed> $params = [] ]) : string
Parameters
- $partial : string
-
The view to load.
- $params : array<string|int, mixed> = []
-
Parameter variables to pass to the view.
Return values
string —The layout partial contents
makePartial()
Render a partial file contents located in the views folder.
public
makePartial(string $partial[, array<string|int, mixed> $params = [] ][, bool $throwException = true ]) : mixed
Parameters
- $partial : string
-
The view to load.
- $params : array<string|int, mixed> = []
-
Parameter variables to pass to the view.
- $throwException : bool = true
-
Throw an exception if the partial is not found.
Return values
mixed —Partial contents or false if not throwing an exception.
makeResponse()
Prepares a response that considers overrides and custom responses.
public
makeResponse(mixed $contents) : mixed
Parameters
- $contents : mixed
Return values
mixed —makeView()
Loads a view with the name specified. Applies layout if its name is provided by the parent object.
public
makeView(string $view) : string
The view file must be situated in the views directory, and has the extension "htm".
Parameters
- $view : string
-
Specifies the view name, without extension. Eg: "index".
Return values
string —makeViewContent()
Renders supplied contents inside a layout.
public
makeViewContent(string $contents[, string $layout = null ]) : string
Parameters
- $contents : string
-
The inner contents as a string.
- $layout : string = null
-
Specifies the layout name.
Return values
string —makeWidget()
Makes a widget object with the supplied configuration file.
public
makeWidget(string $class[, array<string|int, mixed> $widgetConfig = [] ]) : mixed|WidgetBase
Parameters
- $class : string
-
Widget class name
- $widgetConfig : array<string|int, mixed> = []
-
An array of config.
Return values
mixed|WidgetBase —The widget object
mergeConfig()
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
public
mergeConfig(mixed $configA, mixed $configB) : stdClass
Parameters
- $configA : mixed
- $configB : mixed
Return values
stdClass —The config object
methodExists()
Checks if a method exists, extension equivalent of method_exists()
public
methodExists(string $name) : bool
Parameters
- $name : string
Return values
bool —middleware()
Register middleware on the controller.
public
middleware(array<string|int, mixed>|string|Closure $middleware[, array<string|int, mixed> $options = [] ]) : ControllerMiddlewareOptions
Parameters
- $middleware : array<string|int, mixed>|string|Closure
- $options : array<string|int, mixed> = []
Return values
ControllerMiddlewareOptions —myaccount()
My Settings controller
public
myaccount() : mixed
Return values
mixed —myaccount_onSave()
Proxy update onSave event
public
myaccount_onSave() : mixed
Return values
mixed —onHideBackendHint()
Ajax handler to hide a backend hint, once hidden the partial will no longer display for the user.
public
onHideBackendHint() : void
Return values
void —pageAction()
Invokes the current controller action without rendering a view, used by AJAX handler that may rely on the logic inside the action.
public
pageAction() : mixed
Return values
mixed —propertyExists()
Checks if a property exists, extension equivalent of `property_exists()`
public
propertyExists(string $name) : bool
Parameters
- $name : string
Return values
bool —run()
Execute the controller action.
public
run([string $action = null ][, array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $action : string = null
-
The action name.
- $params : array<string|int, mixed> = []
-
Routing parameters to pass to the action.
Return values
mixed —The action result.
setResponse()
Sets the response for the current page request cycle, this value takes priority over the standard response prepared by the controller.
public
setResponse(mixed $response) : $this
Parameters
- $response : mixed
-
Response object or string
Return values
$this —setResponseCookie()
Add a cookie to the response.
public
setResponseCookie(Cookie|mixed $cookie) : $this
Parameters
- $cookie : Cookie|mixed
Return values
$this —setResponseHeader()
Set a header on the Response.
public
setResponseHeader(string $key, array<string|int, mixed>|string $values[, bool $replace = true ]) : $this
Parameters
- $key : string
- $values : array<string|int, mixed>|string
- $replace : bool = true
Return values
$this —setStatusCode()
Sets the status code for the current web response.
public
setStatusCode(int $code) : $this
Parameters
- $code : int
-
Status code
Return values
$this —update()
Update controller
public
update(mixed $recordId[, mixed $context = null ]) : mixed
Parameters
- $recordId : mixed
- $context : mixed = null
Return values
mixed —update_onImpersonateUser()
Impersonate this user
public
update_onImpersonateUser(mixed $recordId) : mixed
Parameters
- $recordId : mixed
Return values
mixed —update_onRestore()
Handle restoring users
public
update_onRestore(mixed $recordId) : mixed
Parameters
- $recordId : mixed
Return values
mixed —update_onUnsuspendUser()
Unsuspend this user
public
update_onUnsuspendUser(mixed $recordId) : mixed
Parameters
- $recordId : mixed
Return values
mixed —addAsset()
Adds the provided asset to the internal asset collections
protected
addAsset(string $type, string $path, array<string|int, mixed> $attributes) : mixed
Parameters
- $type : string
-
The type of the asset: 'js' || 'css' || 'rss'
- $path : string
-
The path to the asset
- $attributes : array<string|int, mixed>
-
The attributes for the asset
Return values
mixed —execAjaxHandlers()
This method is used internally.
protected
execAjaxHandlers() : mixed
Invokes a controller event handler and loads the supplied partials.
Return values
mixed —execPageAction()
This method is used internally.
protected
execPageAction(string $actionName, array<string|int, mixed> $parameters) : mixed
Invokes the controller action and loads the corresponding view.
Parameters
- $actionName : string
-
Specifies a action name to execute.
- $parameters : array<string|int, mixed>
-
A list of the action parameters.
Return values
mixed —extendableIsAccessible()
Checks if a property is accessible, property equivalent of `is_callable()`
protected
extendableIsAccessible(mixed $class, string $propertyName) : bool
Parameters
- $class : mixed
- $propertyName : string
Return values
bool —extensionExtractMethods()
Extracts the available methods from a behavior and adds it to the list of callable methods.
protected
extensionExtractMethods(string $extensionName, object $extensionObject) : void
Parameters
- $extensionName : string
- $extensionObject : object
Return values
void —generatePermissionsField()
Adds the permissions editor widget to the form.
protected
generatePermissionsField() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAssetEntryBuildPath()
Internal helper, attaches a build code to an asset path
protected
getAssetEntryBuildPath(array<string|int, mixed> $asset) : string
Parameters
- $asset : array<string|int, mixed>
-
Stored asset array
Return values
string —getAssetScheme()
Internal helper, get asset scheme
protected
getAssetScheme(string $asset) : string
Parameters
- $asset : string
-
Specifies a path (URL) to the asset.
Return values
string —getLocalPath()
protected
getLocalPath(string $relativePath) : mixed
Parameters
- $relativePath : string
Return values
mixed —handleViewException()
Handle a view exception.
protected
handleViewException(Exception $e, int $obLevel) : void
Parameters
- $e : Exception
- $obLevel : int
Return values
void —makeXsrfCookie()
Adds anti-CSRF cookie.
protected
makeXsrfCookie() : Cookie
Adds a cookie with a token for CSRF checks to the response.
Return values
Cookie —removeDuplicates()
Removes duplicate assets from the entire collection.
protected
removeDuplicates() : void
Return values
void —runAjaxHandler()
Tries to find and run an AJAX handler in the page action.
protected
runAjaxHandler(mixed $handler) : bool
The method stops as soon as the handler is found.
Parameters
- $handler : mixed
Return values
bool —Returns true if the handler was found. Returns false otherwise.
runAjaxHandlerForWidget()
Specific code for executing an AJAX handler for a widget.
protected
runAjaxHandlerForWidget(mixed $widget, mixed $handler) : mixed
This will append the widget view paths to the controller and merge the vars.
Parameters
- $widget : mixed
- $handler : mixed
Return values
mixed —verifyCsrfToken()
Checks the request data / headers for a valid CSRF token.
protected
verifyCsrfToken() : bool
Returns false if a valid token is not found. Override this method to disable the check.
Return values
bool —verifyForceSecure()
Checks if the back-end should force a secure protocol (HTTPS) enabled by config.
protected
verifyForceSecure() : bool