Class Atk4\Ui\Table\Column\FilterModel

`abstract`
`extends`	`Model`
`uses`	`AppScopeTrait, NameTrait, SessionTrait`

Implement a generic filter model for filtering column data.

Located at ui/src/Table/Column/FilterModel.php

Methods
`public`	`__construct(App $app, array $defaults = [])` Creation of the new model can be done in two ways:. Creation of the new model can be done in two ways:. $m = new Model($db); or $m = new Model(); $m->setPersistence($db); The second use actually calls add() but is preferred usage because: it's shorter type hinting will work; you can specify string for a table Overrides `Atk4\Data\Model::__construct()`	#
`public static`	`factoryType(App $app, Field $field): self` Factory method that will return a FilterModel Type class. Factory method that will return a FilterModel Type class.	#
`protected`	`init(): void` Extend this method to define fields of your choice. Extend this method to define fields of your choice. Overrides `Atk4\Data\Model::init()` Overriden by `Atk4\Ui\Table\Column\FilterModel\TypeNumber::init()` `Atk4\Ui\Table\Column\FilterModel\TypeString::init()` `Atk4\Ui\Table\Column\FilterModel\TypeEnum::init()` `Atk4\Ui\Table\Column\FilterModel\TypeBoolean::init()` `Atk4\Ui\Table\Column\FilterModel\TypeDate::init()` `Atk4\Ui\Table\Column\FilterModel\TypeTime::init()` `Atk4\Ui\Table\Column\FilterModel\TypeDatetime::init()`	#
`public`	`afterInit(): void`	#
`public`	`recallData(): ?array`	#
`abstract public`	`setConditionForModel(Model $model): Model` Method that will set conditions on a model base on $op and $value value. Each FilterModel\TypeModel should override… Method that will set conditions on a model base on $op and $value value. Each FilterModel\TypeModel should override this method. Implemented by `Atk4\Ui\Table\Column\FilterModel\TypeNumber::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeString::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeEnum::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeBoolean::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeDate::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeTime::setConditionForModel()` `Atk4\Ui\Table\Column\FilterModel\TypeDatetime::setConditionForModel()`	#
`public`	`getFormDisplayRules(): array` Method that will set Field display condition in a form. If form filter need to have a field display at certain… Method that will set Field display condition in a form. If form filter need to have a field display at certain condition, then override this method in your FilterModel\TypeModel. Overriden by `Atk4\Ui\Table\Column\FilterModel\TypeNumber::getFormDisplayRules()` `Atk4\Ui\Table\Column\FilterModel\TypeDate::getFormDisplayRules()` `Atk4\Ui\Table\Column\FilterModel\TypeTime::getFormDisplayRules()` `Atk4\Ui\Table\Column\FilterModel\TypeDatetime::getFormDisplayRules()`	#
`public`	`clearData(): void`	#

Methods inherited from Atk4\Data\Model
isEntity(), assertIsModel(), assertIsEntity(), getModel(), __clone(), getModelOnlyProperties(), createEntity(), assertIsInitialized(), add(), _addIntoCollection(), getDataRef(), getDirtyRef(), validate(), fieldFactory(), addField(), addFields(), removeField(), hasField(), getField(), setOnlyFields(), isDirty(), getFields(), set(), setNull(), setMulti(), get(), getId(), setId(), getModelCaption(), getTitle(), getTitles(), compare(), _isset(), _unset(), scope(), addCondition(), addCteModel(), setOrder(), setLimit(), issetPersistence(), getPersistence(), setPersistence(), assertHasPersistence(), isLoaded(), assertIsLoaded(), unload(), tryLoad(), load(), tryLoadOne(), loadOne(), tryLoadAny(), loadAny(), reload(), duplicate(), saveAndUnload(), withPersistence(), loadBy(), tryLoadBy(), validateEntityScope(), save(), _insert(), insert(), import(), export(), getIterator(), createIteratorBy(), delete(), atomic(), action(), executeCountQuery(), addExpression(), addCalculatedField(), __isset(), __get(), __set(), __unset(), __debugInfo()

Methods inherited from Atk4\Data\Model

isEntity(), assertIsModel(), assertIsEntity(), getModel(), __clone(), getModelOnlyProperties(), createEntity(), assertIsInitialized(), add(), _addIntoCollection(), getDataRef(), getDirtyRef(), validate(), fieldFactory(), addField(), addFields(), removeField(), hasField(), getField(), setOnlyFields(), isDirty(), getFields(), set(), setNull(), setMulti(), get(), getId(), setId(), getModelCaption(), getTitle(), getTitles(), compare(), _isset(), _unset(), scope(), addCondition(), addCteModel(), setOrder(), setLimit(), issetPersistence(), getPersistence(), setPersistence(), assertHasPersistence(), isLoaded(), assertIsLoaded(), unload(), tryLoad(), load(), tryLoadOne(), loadOne(), tryLoadAny(), loadAny(), reload(), duplicate(), saveAndUnload(), withPersistence(), loadBy(), tryLoadBy(), validateEntityScope(), save(), _insert(), insert(), import(), export(), getIterator(), createIteratorBy(), delete(), atomic(), action(), executeCountQuery(), addExpression(), addCalculatedField(), __isset(), __get(), __set(), __unset(), __debugInfo()

Methods used from Atk4\Core\CollectionTrait
`_removeFromCollection(), _cloneCollection(), _hasInCollection(), _getFromCollection(), _shortenMl()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\DiContainerTrait
`setDefaults(), setMissingProperty(), assertInstanceOf(), _fromSeedPrecheck(), fromSeed(), fromSeedUnsafe()`

Methods used from Atk4\Core\DynamicMethodTrait
`__call(), buildMethodHookName(), addMethod(), hasMethod(), removeMethod()`

Methods used from Atk4\Core\HookTrait
`_rebindHookFxToFakeInstance(), _unbindHookFxIfBoundToThis(), _rebindHooksIfCloned(), onHook(), onHookShort(), _makeHookDynamicFx(), onHookDynamic(), onHookDynamicShort(), hookHasCallbacks(), removeHook(), hook(), breakHook()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), invokeInit()`

Methods used from Atk4\Data\Model\JoinsTrait
`join(), leftJoin(), hasJoin(), getJoin(), getJoins()`

Methods used from Atk4\Data\Model\ReferencesTrait
`_addReference(), addReference(), hasOne(), hasMany(), containsOne(), containsMany(), hasReference(), getReference(), getReferences(), ref(), refModel(), refLink()`

Methods used from Atk4\Data\Model\UserActionsTrait
`addUserAction(), hasUserAction(), addUserActionFromModel(), getUserActions(), getUserAction(), removeUserAction(), executeUserAction(), initUserActions()`

Methods used from Atk4\Core\ReadableCaptionTrait
`readableCaption()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Ui\SessionTrait
`getSessionManager(), atomicSession(), memorize(), learn(), recall(), forget()`

Constants inherited from Atk4\Data\Model
`HOOK_BEFORE_LOAD, HOOK_AFTER_LOAD, HOOK_BEFORE_UNLOAD, HOOK_AFTER_UNLOAD, HOOK_BEFORE_INSERT, HOOK_AFTER_INSERT, HOOK_BEFORE_UPDATE, HOOK_AFTER_UPDATE, HOOK_BEFORE_DELETE, HOOK_AFTER_DELETE, HOOK_BEFORE_SAVE, HOOK_AFTER_SAVE, HOOK_ROLLBACK, HOOK_NORMALIZE, HOOK_VALIDATE, HOOK_ONLY_FIELDS, ID_LOAD_ONE, ID_LOAD_ANY`

Properties
`public`	`Field`	`$op` The operator for defining a condition on a field. The operator for defining a condition on a field.	#
`public`	`Field`	`$value` The value for defining a condition on a field. The value for defining a condition on a field.	#
`public`	`bool`	`$noValueField = false` Determines if this field shouldn't have a value field, and use only op field. Determines if this field shouldn't have a value field, and use only op field.	#
`public`	`Field`	`$lookupField` The field where this filter need to query data. The field where this filter need to query data.	#

Properties inherited from Atk4\Data\Model
`$_model, $_entityId, $_modelOnlyProperties, $_defaultSeedAddField, $_defaultSeedAddExpression, $fields, $table, $tableAlias, $_persistence, $persistenceData, $scope, $limit, $order, $cteModels, $data, $dirty, $readOnly, $idField, $titleField, $caption, $onlyFields, $reloadAfterSave, $containedInEntity, $ownerReference, $fieldSeedByType, $id, $elements`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\HookTrait
`$hooks, $_hookIndexCounter, $_hookOrigThis`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Data\Model\JoinsTrait
`$_defaultSeedJoin`

Properties used from Atk4\Data\Model\ReferencesTrait
`$_defaultSeedAddReference, $_defaultSeedHasOne, $_defaultSeedHasMany, $_defaultSeedContainsOne, $_defaultSeedContainsMany`

Properties used from Atk4\Data\Model\UserActionsTrait
`$_defaultSeedUserAction, $userActions`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\NameTrait
`$name`

Namespaces

Classes

Class Atk4\Ui\Table\Column\FilterModel

Overrides

Overrides

Overriden by

Implemented by

Overriden by