Class Atk4\Ui\Form\Control\ScopeBuilder

`extends`	`Control`

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\Form\Control
    - Atk4\Ui\Form\Control\ScopeBuilder

Located at ui/src/Form/Control/ScopeBuilder.php

Methods
`protected`	`init(): void` Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Overrides `Atk4\Ui\Form\Control::init()`	#
`public`	`setModel(Model $model): void` Set the model to build scope for. Set the model to build scope for. Overrides `Atk4\Ui\View::setModel()`	#
`protected`	`buildQuery(Model $model): void` Build query from model scope. Build query from model scope.	#
`protected`	`addFieldRule(Field $field): void` Add the field rules to use in VueQueryBuilder. Add the field rules to use in VueQueryBuilder.	#
`protected`	`getLookupProps(Field $field): array` Set property for AtkLookup component. Set property for AtkLookup component.	#
`protected`	`getDatePickerProps(Field $field): array` Set property for AtkDatePicker component. Set property for AtkDatePicker component.	#
`protected`	`addReferenceRules(Field $field): void` Add rules on the referenced model fields. Add rules on the referenced model fields.	#
`protected`	`getRule(string $type, array $defaults = [], Field $field = null): array`	#
`protected`	`getFieldItems(Field $field, ?int $limit = 250): array` Return an array of items ID and name for a field. Return field enum, values or reference values. Return an array of items ID and name for a field. Return field enum, values or reference values.	#
`protected`	`getChoices(Field $field, array $options = []): array` Returns the choices array for Select field rule. Returns the choices array for Select field rule.	#
`protected`	`renderView(): void` View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic… View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic that integrates with Fomantic-UI. Overrides `Atk4\Ui\Form\Control::renderView()`	#
`public`	`queryToScope(array $query): AbstractScope` Converts an VueQueryBuilder query array to Condition or Scope. Converts an VueQueryBuilder query array to Condition or Scope.	#
`public`	`queryToCondition(array $query): Condition` Converts an VueQueryBuilder rule array to Condition or Scope. Converts an VueQueryBuilder rule array to Condition or Scope.	#
`public`	`scopeToQuery(AbstractScope $scope, array $inputsMap = []): array` Converts Scope or Condition to VueQueryBuilder query array. Converts Scope or Condition to VueQueryBuilder query array.	#
`public`	`conditionToQuery(Condition $condition, array $inputsMap = []): array` Converts a Condition to VueQueryBuilder query array. Converts a Condition to VueQueryBuilder query array.	#
`protected`	`getConditionOption(string $type, mixed $value, Condition $condition): ?array` Return extra value option associate with certain inputType or null otherwise. Return extra value option associate with certain inputType or null otherwise.	#
`public`	`detectDelimiter(string $value): non-empty-string` Auto-detects a string delimiter based on list of predefined values in ScopeBuilder::$listDelimiters in order of… Auto-detects a string delimiter based on list of predefined values in ScopeBuilder::$listDelimiters in order of priority.	#

Methods inherited from Atk4\Ui\Form\Control
`set(), renderTemplateToHtml(), onChange(), jsInput()`

Methods inherited from Atk4\Ui\View
`__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()`

Methods inherited from Atk4\Ui\View

__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

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

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

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

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Constants
`protected`	`OPERATOR_TEXT_EQUALS = 'equals'`	#
`protected`	`OPERATOR_TEXT_DOESNOT_EQUAL = 'does not equal'`	#
`protected`	`OPERATOR_TEXT_GREATER = 'is alphabetically after'`	#
`protected`	`OPERATOR_TEXT_GREATER_EQUAL = 'is alphabetically equal or after'`	#
`protected`	`OPERATOR_TEXT_LESS = 'is alphabetically before'`	#
`protected`	`OPERATOR_TEXT_LESS_EQUAL = 'is alphabetically equal or before'`	#
`protected`	`OPERATOR_TEXT_CONTAINS = 'contains'`	#
`protected`	`OPERATOR_TEXT_DOESNOT_CONTAIN = 'does not contain'`	#
`protected`	`OPERATOR_TEXT_BEGINS_WITH = 'begins with'`	#
`protected`	`OPERATOR_TEXT_DOESNOT_BEGIN_WITH = 'does not begin with'`	#
`protected`	`OPERATOR_TEXT_ENDS_WITH = 'ends with'`	#
`protected`	`OPERATOR_TEXT_DOESNOT_END_WITH = 'does not end with'`	#
`protected`	`OPERATOR_TEXT_MATCHES_REGEX = 'matches regular expression'`	#
`protected`	`OPERATOR_TEXT_DOESNOT_MATCH_REGEX = 'does not match regular expression'`	#
`protected`	`OPERATOR_SIGN_EQUALS = '='`	#
`protected`	`OPERATOR_SIGN_DOESNOT_EQUAL = '<>'`	#
`protected`	`OPERATOR_SIGN_GREATER = '>'`	#
`protected`	`OPERATOR_SIGN_GREATER_EQUAL = '>='`	#
`protected`	`OPERATOR_SIGN_LESS = '<'`	#
`protected`	`OPERATOR_SIGN_LESS_EQUAL = '<='`	#
`protected`	`OPERATOR_TIME_EQUALS = 'is on'`	#
`protected`	`OPERATOR_TIME_DOESNOT_EQUAL = 'is not on'`	#
`protected`	`OPERATOR_TIME_GREATER = 'is after'`	#
`protected`	`OPERATOR_TIME_GREATER_EQUAL = 'is on or after'`	#
`protected`	`OPERATOR_TIME_LESS = 'is before'`	#
`protected`	`OPERATOR_TIME_LESS_EQUAL = 'is on or before'`	#
`protected`	`OPERATOR_EQUALS = 'equals'`	#
`protected`	`OPERATOR_DOESNOT_EQUAL = 'does not equal'`	#
`protected`	`OPERATOR_IN = 'is in'`	#
`protected`	`OPERATOR_NOT_IN = 'is not in'`	#
`protected`	`OPERATOR_EMPTY = 'is empty'`	#
`protected`	`OPERATOR_NOT_EMPTY = 'is not empty'`	#
`protected`	`DATE_OPERATORS = [ self::OPERATOR_TIME_EQUALS, self::OPERATOR_TIME_DOESNOT_EQUAL, self::OPERATOR_TIME_GREATER, self::OPERATOR_TIME_GREATER_EQUAL, self::OPERATOR_TIME_LESS, self::OPERATOR_TIME_LESS_EQUAL, self::OPERATOR_EMPTY, self::OPERATOR_NOT_EMPTY, ]`	#
`protected`	`ENUM_OPERATORS = [ self::OPERATOR_EQUALS, self::OPERATOR_DOESNOT_EQUAL, self::OPERATOR_EMPTY, self::OPERATOR_NOT_EMPTY, ]`	#
`protected`	`DATE_OPERATORS_MAP = [ self::OPERATOR_TIME_EQUALS => Condition::OPERATOR_EQUALS, self::OPERATOR_TIME_DOESNOT_EQUAL => Condition::OPERATOR_DOESNOT_EQUAL, self::OPERATOR_TIME_GREATER => Condition::OPERATOR_GREATER, self::OPERATOR_TIME_GREATER_EQUAL => Condition::OPERATOR_GREATER_EQUAL, self::OPERATOR_TIME_LESS => Condition::OPERATOR_LESS, self::OPERATOR_TIME_LESS_EQUAL => Condition::OPERATOR_LESS_EQUAL, ]`	#

Properties
`public`		`$renderLabel = false`	#
`public`	`array`	`$options = ['enum' => ['limit' => 250], 'debug' => false]`	#
`public`	`int`	`$maxDepth = 5` Max depth of nested conditions allowed. Corresponds to VueQueryBulder maxDepth. Maximum support by JS component is 10. Max depth of nested conditions allowed. Corresponds to VueQueryBulder maxDepth. Maximum support by JS component is 10.	#
`public`	`array`	`$fields = []` Fields to use for creating the rules. Fields to use for creating the rules.	#
`public`	`HtmlTemplate\|null`	`$scopeBuilderTemplate` The template needed for the ScopeBuilder view. The template needed for the ScopeBuilder view.	#
`public static`	`array`	`$listDelimiters = [';', ',']` List of delimiters for auto-detection in order of priority. List of delimiters for auto-detection in order of priority.	#
`public`	`array`	`$atkdDateOptions = ['flatpickr' => []]` The date, time or datetime options. The date, time or datetime options.	#
`public`	`array`	`$atkLookupOptions = ['ui' => 'small basic button']` AtkLookup and Fomantic-UI dropdown options. AtkLookup and Fomantic-UI dropdown options.	#
`protected`	`View`	`$scopeBuilderView` The scopebuilder View. Assigned in init(). The scopebuilder View. Assigned in init().	#
`protected`	`array`	`$rules = []` Definition of VueQueryBuilder rules. Definition of VueQueryBuilder rules.	#
`public`	`array`	`$labels = []` Set Labels for Vue-Query-Builder see https://dabernathy89.github.io/vue-query-builder/configuration.html#labels. Set Labels for Vue-Query-Builder see https://dabernathy89.github.io/vue-query-builder/configuration.html#labels.	#
`protected`	`array`	`$query = []` Default VueQueryBuilder query. Default VueQueryBuilder query.	#
`protected static`	`array<string, array<string, string>>`	$operatorsMap = [ 'number' => [ self::OPERATOR_SIGN_EQUALS => Condition::OPERATOR_EQUALS, self::OPERATOR_SIGN_DOESNOT_EQUAL => Condition::OPERATOR_DOESNOT_EQUAL, self::OPERATOR_SIGN_GREATER => Condition::OPERATOR_GREATER, self::OPERATOR_SIGN_GREATER_EQUAL => Condition::OPERATOR_GREATER_EQUAL, self::OPERATOR_SIGN_LESS => Condition::OPERATOR_LESS, self::OPERATOR_SIGN_LESS_EQUAL => Condition::OPERATOR_LESS_EQUAL, ], 'date' => self::DATE_OPERATORS_MAP, 'time' => self::DATE_OPERATORS_MAP, 'datetime' => self::DATE_OPERATORS_MAP, 'text' => [ self::OPERATOR_TEXT_EQUALS => Condition::OPERATOR_EQUALS, self::OPERATOR_TEXT_DOESNOT_EQUAL => Condition::OPERATOR_DOESNOT_EQUAL, self::OPERATOR_TEXT_GREATER => Condition::OPERATOR_GREATER, self::OPERATOR_TEXT_GREATER_EQUAL => Condition::OPERATOR_GREATER_EQUAL, self::OPERATOR_TEXT_LESS => Condition::OPERATOR_LESS, self::OPERATOR_TEXT_LESS_EQUAL => Condition::OPERATOR_LESS_EQUAL, self::OPERATOR_TEXT_CONTAINS => Condition::OPERATOR_LIKE, self::OPERATOR_TEXT_DOESNOT_CONTAIN => Condition::OPERATOR_NOT_LIKE, self::OPERATOR_TEXT_BEGINS_WITH => Condition::OPERATOR_LIKE, self::OPERATOR_TEXT_DOESNOT_BEGIN_WITH => Condition::OPERATOR_NOT_LIKE, self::OPERATOR_TEXT_ENDS_WITH => Condition::OPERATOR_LIKE, self::OPERATOR_TEXT_DOESNOT_END_WITH => Condition::OPERATOR_NOT_LIKE, self::OPERATOR_IN => Condition::OPERATOR_IN, self::OPERATOR_NOT_IN => Condition::OPERATOR_NOT_IN, self::OPERATOR_TEXT_MATCHES_REGEX => Condition::OPERATOR_REGEXP, self::OPERATOR_TEXT_DOESNOT_MATCH_REGEX => Condition::OPERATOR_NOT_REGEXP, self::OPERATOR_EMPTY => Condition::OPERATOR_EQUALS, self::OPERATOR_NOT_EMPTY => Condition::OPERATOR_DOESNOT_EQUAL, ], 'select' => [ self::OPERATOR_EQUALS => Condition::OPERATOR_EQUALS, self::OPERATOR_DOESNOT_EQUAL => Condition::OPERATOR_DOESNOT_EQUAL, ], 'lookup' => [ self::OPERATOR_EQUALS => Condition::OPERATOR_EQUALS, self::OPERATOR_DOESNOT_EQUAL => Condition::OPERATOR_DOESNOT_EQUAL, ], ]	#
`protected static`	`array<string, string\|array<string, mixed>>`	$ruleTypes = [ 'default' => 'text', 'text' => [ 'type' => 'text', 'operators' => [ self::OPERATOR_TEXT_EQUALS, self::OPERATOR_TEXT_DOESNOT_EQUAL, self::OPERATOR_TEXT_GREATER, self::OPERATOR_TEXT_GREATER_EQUAL, self::OPERATOR_TEXT_LESS, self::OPERATOR_TEXT_LESS_EQUAL, self::OPERATOR_TEXT_CONTAINS, self::OPERATOR_TEXT_DOESNOT_CONTAIN, self::OPERATOR_TEXT_BEGINS_WITH, self::OPERATOR_TEXT_DOESNOT_BEGIN_WITH, self::OPERATOR_TEXT_ENDS_WITH, self::OPERATOR_TEXT_DOESNOT_END_WITH, self::OPERATOR_TEXT_MATCHES_REGEX, self::OPERATOR_TEXT_DOESNOT_MATCH_REGEX, self::OPERATOR_IN, self::OPERATOR_NOT_IN, self::OPERATOR_EMPTY, self::OPERATOR_NOT_EMPTY, ], ], 'lookup' => [ 'type' => 'custom-component', 'inputType' => 'lookup', 'component' => 'AtkLookup', 'operators' => self::ENUM_OPERATORS, 'componentProps' => [__CLASS__, 'getLookupProps'], ], 'enum' => [ 'type' => 'select', 'inputType' => 'select', 'operators' => self::ENUM_OPERATORS, 'choices' => [__CLASS__, 'getChoices'], ], 'numeric' => [ 'type' => 'text', 'inputType' => 'number', 'operators' => [ self::OPERATOR_SIGN_EQUALS, self::OPERATOR_SIGN_DOESNOT_EQUAL, self::OPERATOR_SIGN_GREATER, self::OPERATOR_SIGN_GREATER_EQUAL, self::OPERATOR_SIGN_LESS, self::OPERATOR_SIGN_LESS_EQUAL, self::OPERATOR_EMPTY, self::OPERATOR_NOT_EMPTY, ], ], 'boolean' => [ 'type' => 'radio', 'operators' => [], 'choices' => [['label' => 'Yes', 'value' => '1'], ['label' => 'No', 'value' => '0']], ], 'date' => [ 'type' => 'custom-component', 'component' => 'AtkDatePicker', 'inputType' => 'date', 'operators' => self::DATE_OPERATORS, 'componentProps' => [__CLASS__, 'getDatePickerProps'], ], 'datetime' => [ 'type' => 'custom-component', 'component' => 'AtkDatePicker', 'inputType' => 'datetime', 'operators' => self::DATE_OPERATORS, 'componentProps' => [__CLASS__, 'getDatePickerProps'], ], 'time' => [ 'type' => 'custom-component', 'component' => 'AtkDatePicker', 'inputType' => 'time', 'operators' => self::DATE_OPERATORS, 'componentProps' => [__CLASS__, 'getDatePickerProps'], ], 'integer' => 'numeric', 'float' => 'numeric', 'atk4_money' => 'numeric', 'checkbox' => 'boolean', ] Definition of rule types. Definition of rule types.	#

Properties inherited from Atk4\Ui\Form\Control
`$form, $entityField, $controlClass, $layoutWrap, $width, $caption, $hint, $disabled, $readOnly`

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $ui, $class, $style, $attr, $template, $defaultTemplate, $content, $element, $executorFactory, $stickyArgs`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

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

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

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

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

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Class Atk4\Ui\Form\Control\ScopeBuilder

Overrides

Overrides

Overrides