Filter

Filter Widget Renders a container used for filtering things.

 class Backend\Widgets\Filter
extends Backend\Classes\WidgetBase

# Extends

# Traits

# Properties

# public $context : string

# public $cssClasses : array = []

# public $scopes : array

# protected $allScopes : array = []

# protected $defaultAlias : mixed = "filter"

# protected $scopeModels : array = []

# protected $scopesDefined : bool = false

# inherited public $alias : string

# inherited public $assetPath : string

# inherited public $config : object

# inherited public $implement : string | array | null = null

# inherited public $layout : string

# inherited public $suppressLayout : bool = false

# inherited public $vars : array = []

# inherited protected $assets : array = {"js":[],"css":[],"rss":[],"vite":[]}

# inherited protected $configPath : string

# inherited protected $controller : Backend\Classes\Controller

# inherited protected static $extendableCallbacks : array = []

# inherited protected static $extendableClassLoader : ClassLoader | null = null

# inherited protected $extendableConstructed : bool = false

# inherited protected static $extendableStaticMethods : array = []

# inherited protected $extensionData : array = {"extensions":[],"methods":[],"dynamicMethods":[],"dynamicProperties":[]}

# inherited protected $fatalError : string

# inherited protected $layoutPath : string

# inherited protected $localCallbacks : array = []

# inherited protected $orderFactor : integer

# inherited protected $viewPath : string | array

# Methods

# public addScopes (array $scopes)

# public applyAllScopesToQuery (Builder $query) : Builder

# public applyScopeToQuery (string $scope, Builder $query) : Builder

# public getContext () : string

# public getScope (string $scope) : mixed

# public getScopeNameFrom (string $scope) : string

# public getScopeValue ($scope, $default = null)

# public getScopes () : array

# public init ()

# public onFilterGetOptions () : array

# public onFilterUpdate () : array

# public prepareVars ()

# public removeScope (string $scopeName)

# public render ()

# public renderScopeElement ($scope)

# public setScopeValue ($scope, $value)

# protected datesFromAjax ($ajaxDates) : array

# protected defineFilterScopes ()

# protected filterActiveOptions (array $activeKeys, array $availableOptions) : array

# protected filterOptionsBySearch (array $options, string $query) : array

# protected getAvailableOptions (Backend\Classes\Filter $scope, string $searchQuery = null) : array

# protected getFilterDateFormat (mixed $scope) : string

# protected getOptionsFromArray ($scope, $searchQuery = null) : array

# protected getOptionsFromModel (Backend\Classes\FilterScope $scope, string | null $searchQuery = null) : Collection

# protected getScopeDepends (Backend\Classes\FilterScope $scope) : string

# protected makeFilterScope ($name, $config)

# protected numbersFromAjax ($ajaxNumbers) : array

# protected optionsFromAjax (array $options) : array

# protected optionsToAjax (array $options) : array

# inherited public __call ($name, $params)

# inherited public static __callStatic ($name, $params)

# inherited public __construct (Backend\Classes\Controller $controller, array $configuration = [])

# inherited public __get ($name)

# inherited public __set ($name, $value)

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

# inherited public addDynamicMethod (string $dynamicName, callable $method, string $extension = null)

# inherited public addDynamicProperty (string $dynamicName, mixed $value = null) : 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 asExtension (string $shortName) : mixed

# inherited public bindToController () : void

# inherited public static clearExtendedClasses () : void

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

# inherited public extendClassWith (string $extensionName) : void

# inherited public static extendableAddExtension (callable $callback, boolean $scoped = false, $outerScope = null) : void

# inherited public extendableCall (string $name, array $params = null) : mixed

# inherited public static extendableCallStatic (string $name, array $params = null) : mixed

# inherited public extendableConstruct ()

# inherited public static extendableExtendCallback (callable $callback, boolean $scoped = false, $outerScope = null) : void

# inherited public extendableGet (string $name) : mixed | null

# inherited public extendableSet (string $name, mixed $value) : void

# inherited public fireSystemEvent (string $event, array $params = [], boolean $halt = true) : mixed

$this->fireSystemEvent('backend.list.myEvent', ['my value']);

$this->fireEvent('list.myEvent', ['myvalue'], true);

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);

# inherited public fireViewEvent (string $event, array $params = []) : string

# inherited public flushAssets () : void

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

# inherited public getAssetPaths () : array

# inherited public getClassExtension (string $name) : mixed

# inherited public getClassMethods () : array

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

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

# inherited public getController ()

# inherited public getDynamicProperties () : array

# inherited public getEventHandler (string $name) : string

# inherited public getFatalError () : string

# inherited public getId (string $suffix = 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 handleError ($exception)

# inherited public hasAssetsDefined () : bool

# inherited public hasFatalError () : bool

# inherited public isClassExtendedWith (string $name) : 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 methodExists (string $name) : bool

# inherited public orderAssets (array $assets) : array

# inherited public propertyExists (string $name) : bool

# inherited public resetSession () : void

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

# inherited protected extendableAddLocalExtension (Closure $callback, $outerScope = null)

# inherited protected extendableIsAccessible (mixed $class, string $propertyName) : bool

# inherited protected extensionCallMethod (ReflectionClass $class, string $method, array $params)

# inherited protected extensionExtractMethods (string $extensionName, object $extensionObject) : void

# inherited protected extensionGetClassLoader () : Winter\Storm\Support\ClassLoader | null

# inherited protected extensionGetParentClass ($instance = null) : ReflectionClass | false

# inherited protected extensionMethodExists (ReflectionClass $class, string $methodName) : bool

# inherited protected extensionNormalizeClassName (string $name) : string

# inherited protected fillFromConfig (array $properties = null) : void

# 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 loadAssets () : void

# inherited protected makeSessionId () : string

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

# inherited protected removeDuplicates () : void