ListController

Adds features for working with backend lists.

 class Backend\Behaviors\ListController
extends Backend\Classes\ControllerBehavior

public $implement = [
    \Backend\Behaviors\ListController::class,
];

public $listConfig = 'config_list.yaml';

Configuration for this behaviour

Visible actions in context of the controller

Reference to the filter widget objects.

List definitions, keys for alias and value for configuration.

Reference to the list widget object.

The primary list alias to use. Default: list

Configuration values that must exist when applying the primary config file.

• modelClass: Class name for the model
• list: List column definitions

Reference to the toolbar widget objects.

Specifies a path to the asset directory.

The calling class when using a static method.

Layout to use for the view.

Prevents the use of a layout.

A list of variables to pass to the page.

Collection of assets to display in the layout.

Supplied configuration.

Specifies a path to the config directory.

Reference to the back end controller.

Used to extend the constructor of an extension class. Eg:

BehaviorClass::extend(function($obj) { })

Specifies a path to the layout directory.

Ensures "first-come, first-served" applies to assets of the same ordering.

Properties that must exist in the controller using this behavior.

Specifies a path to the views directory.

Behavior constructor

Static helper for extending list columns.

Static helper for extending filter scopes.

Index Controller action.

Bulk delete records.

Called after the list columns are defined.

Called before the list columns are defined.

Controller override: Extend supplied model

Controller override: Extend the query used for populating the list after the default query is processed.

Controller override: Extend the query used for populating the list before the default query is processed.

Controller override: Extend the records used for populating the list after the query is processed.

Controller override: Extend the query used for populating the filter options before the default query is processed.

Called after the filter scopes are defined.

Returns the configuration used by this behavior.

Returns the widget used by this behavior.

Returns a CSS class name for a list row (

).

# public listMakePartial (string $partial, array $params = []) : string

# public listOverrideColumnValue (Winter\Storm\Database\Model $record, string $columnName, string | null $definition = null) : string | void

# public listOverrideHeaderValue (string $columnName, string | null $definition = null) : string | void

# public listRefresh ($definition = null) : array

# public listRender (string $definition = null) : string

# public makeList ($definition = null) : Backend\Widgets\Lists

# public makeLists () : array

# inherited public addCss (string | array $name, array $attributes = []) : void

# inherited public addJs (string | array $name, array $attributes = []) : void

# inherited public addRss (string $name, array $attributes = []) : void

# inherited public addViewPath (string | array $path) : void

# inherited public addVite (array | string $entrypoints, ?string $package = null) : void

# inherited public combineAssets (array $assets, string $localPath = "") : string

# inherited public static extend (callable $callback)

# inherited public extensionApplyInitCallbacks ()

# inherited public static extensionExtendCallback (callable $callback) : void

# inherited public extensionIsHiddenField ($name)

# inherited public extensionIsHiddenMethod ($name)

# inherited public flushAssets () : void

# inherited public getAssetPath (string $fileName, $assetPath = null) : string

# inherited public getAssetPaths () : array

# inherited public static getCalledExtensionClass ()

# inherited public getConfig (string $name = null, mixed $default = null) : string

# inherited public getConfigPath (string $fileName, mixed $configPath = null) : string

# inherited public getViewPath (string $fileName, $viewPaths = null) : string

# inherited public getViewPaths () : array

# inherited public guessConfigPath (string $suffix = "") : string

# inherited public guessConfigPathFrom (string $class, string $suffix = "") : string

# inherited public guessViewPath (string $suffix = "", boolean $isPublic = false) : string | null

# inherited public guessViewPathFrom (string $class, string $suffix = "", boolean $isPublic = false) : string | null

# inherited public hasAssetsDefined () : bool

# inherited public makeAssets ($type = null) : string | null

# inherited public makeConfig (array $configFile = [], array $requiredConfig = []) : array | stdClass

# inherited public makeConfigFromArray (array $configArray = []) : stdClass

# inherited public makeFileContents (string $filePath, array $extraParams = []) : string

# inherited public makeFormWidget (string $class, array $fieldConfig = [], array $widgetConfig = []) : Backend\Classes\FormWidgetBase

# inherited public makeLayout ($name = null, array $params = [], boolean $throwException = true) : string | bool

# inherited public makeLayoutPartial (string $partial, array $params = []) : string

# inherited public makePartial (string $partial, array $params = [], boolean $throwException = true) : mixed

# inherited public makeView (string $view) : string

# inherited public makeViewContent (string $contents, $layout = null) : string

# inherited public makeWidget (string $class, array $widgetConfig = []) : mixed | Backend\Classes\WidgetBase

# inherited public mergeConfig (mixed $configA, mixed $configB) : stdClass

# inherited public orderAssets (array $assets) : array

# inherited public resetSession () : void

# inherited public setConfig (mixed $config, array $required = [])

# inherited protected addAsset (string $type, string $path, array $attributes) : void

# inherited protected controllerMethodExists (string $methodName) : bool

# inherited protected extensionHideField ($name)

# inherited protected extensionHideMethod ($name)

# inherited protected getAssetEntryBuildPath (array $asset) : string

# inherited protected getAssetScheme (string $asset) : string

# inherited protected getLocalPath (string | null $relativePath) : string

# inherited protected getSession (string $key = null, string $default = null) : string

# inherited protected handleViewException (Throwable $e, integer $obLevel) : void

# inherited protected hideAction (mixed $methodName)

# inherited protected makeSessionId () : string

# inherited protected putSession (string $key, mixed $value) : void

# inherited protected removeDuplicates () : void