Версия: 6.x
burger close
Класс AbstractType
Граф наследования:AbstractType:
AbstractHtml ElementInterface BarcodeFilter BarcodeListFilter BarcodeNotListFilter CostFilter PropertyFilter SkuFilter CustomFields Links Date DateRange Datetime MultipleSelect Product Select Text User Product TransactionEntity UserFIO UserPhone Message

Подробное описание

Базовый абстрактный класс элементов(полей) фильтра.

Открытые члены

 __construct ($key, $title, $options=[])
 
 setEmptyNull ($empty_null)
 
 setSearchType ($search_type)
 
 setFieldPrefix ($prefix)
 
 setTitleAttr (array $attr)
 
 setAttr (array $attr)
 
 setTrim ($bool)
 
 getTrim ()
 
 setValue ($value)
 
 isPrefilter ()
 
 getPrefilters ()
 
 getKey ()
 
 getTitle ()
 
 setTitle ($title)
 
 getValue ()
 
 getTextValue ()
 
 getTitleAttrString ()
 
 getAttrString ()
 
 setShowType ()
 
 addPrefilter (AbstractType $item)
 
 _setPrefilterFlag ()
 
 getSqlKey ()
 
 getName ()
 
 getNonEmptyValue ()
 
 getKeyVal ()
 
 setModificateQueryCallback ($callback)
 
 modificateQuery (\RS\Orm\Request $q)
 
 getWhere ()
 
 getParts ($current_filter_values, $exclude_keys=[])
 
 getView ()
 
- Открытые члены унаследованные от AbstractHtml
 __construct (array $options=[])
 
 setOptions (array $options)
 
 setOption ($key, $value)
 
 getOption ($key, $default=null)
 

Поля данных

 $wrap_var
 
 $emptynull = true
 
 $type_array_sql = [1 => '<'
 
- Поля данных унаследованные от AbstractHtml
 $options = []
 
 $option_prefixes = ['set', 'add']
 

Защищенные члены

 where_like ($likepattern)
 
 where_eq ($compare= '=')
 
 where_noteq ()
 
 escape ($str)
 

Защищенные данные

 $modificate_query_callback
 
- Защищенные данные унаследованные от AbstractHtml
 $url
 

Конструктор(ы)

__construct (   $key,
  $title,
  $options = [] 
)

Методы

_setPrefilterFlag ( )

Устанавливает флаг, о необходимости выводить еще один фильтр перед основным

addPrefilter ( AbstractType  $item)

Устанавливает тип фильтра, предшествующего основному

Аргументы
mixed$list
escape (   $str)
protected

Экранирует строку

Аргументы
$str
Возвращает
string
getAttrString ( )

Возвращает аттрибуты для формы фильтра

Возвращает
string
getKey ( )

Возвращает ключ фильтра. (ключ сответствует колонке в БД)

Возвращает
string
getKeyVal ( )

Возвращает ключ-значение, поля в виде ассоциативного массива, если есть значение, иначе пустой массив

Возвращает
array
getName ( )

Возвращает имя переменной формы

Возвращает
string
getNonEmptyValue ( )

Возвращает null, если филтр не установлен, иначе значение фильтра

getParts (   $current_filter_values,
  $exclude_keys = [] 
)

Возвращает массив с данными, об установленых фильтрах для визуального отображения частиц

Аргументы
array$current_filter_values- значения установленных фильтров
array$exclude_keysмассив ключей, которые необходимо исключить из ссылки на сброс параметра
Возвращает
array of array ['title' => string, 'value' => string, 'href_clean']
getPrefilters ( )

Возвращает список дополнительных фильтров для данного фильтра

Возвращает
array
getSqlKey ( )

Возвращает имя SQL-поля фильтра

Возвращает
string
getTextValue ( )

Возвращает значение фильтра, которое подготовлено для чтения пользователем

Возвращает
string
getTitle ( )

Возвращает название фильтра

Возвращает
string
getTitleAttrString ( )

Возвращает аттрибуты для элемента, содержащего название фильтра

Возвращает
string
getTrim ( )

Возвращает, будет ли обрезать пробелы по краям строки данная форма

Возвращает
bool
getValue ( )

Возвращает значение фильтра

Возвращает
mixed
getView ( )

Возвращает HTML представление фильтра

Возвращает
string

Замещает ElementInterface.

getWhere ( )

Возвращает условия для строки Where

Возвращает
string
isPrefilter ( )

Возвращает true, если данный фильтр является дополнительным к другому фильтру

Возвращает
bool
modificateQuery ( \RS\Orm\Request  $q)

Модифицирует запрос для реализации фильтра. Можно использовать, когда для фильтрации нужно подключать дополнительные таблицы

Аргументы
\RS\Orm\Request$q
Возвращает
false|mixed|
setAttr ( array  $attr)

Устанавливает аттрибуты для dom-элмента формы.

Аргументы
array$attr- Массив, где ключ - это аттрибут, значение - значение аттрибута
Возвращает
AbstractType
setEmptyNull (   $empty_null)

Устанавливает считать ли пустую строку - неустановленным значением фильтра

Аргументы
bool$empty_nulltrue или false
Возвращает
$this
setFieldPrefix (   $prefix)

Устанавливает Псевдоним таблицы, который будет добавлен перед колонкой в SQL запросе.

Аргументы
string$prefix- Псевдоним таблицы.
Возвращает
AbstractType
setModificateQueryCallback (   $callback)

Устанавливает функцию, которая будет вызываться для модификации запроса к БД В функцию будут переданы аргументы: $this, $q

Аргументы
callable$callback
Возвращает
void
setSearchType (   $search_type)

Устанавливает тип сравнения значения фильтра с базой данных

Аргументы
string'eq' | 'like' | 'like' $search_type - Если задано eq, то будет точное сравнение (=), если задано like - значит будет осуществлен поиск частичного совпадения
Возвращает
AbstractType
setShowType ( )

Добавляет к выводу дополнительную форму с выбором типа проверки < = > (больше, меньше или равно)

setTitle (   $title)

Устанавливает название фильтра

Аргументы
$title
setTitleAttr ( array  $attr)

Устанавливает аттрибуты к dom-элементу, содержащему название фильтра

Аргументы
array$attr- Массив, где ключ - это аттрибут, значение - значение аттрибута
Возвращает
AbstractType
setTrim (   $bool)

Устанавливает, нужно ли обрезать пробелы по краям поисковой фразы

Аргументы
mixed$bool
Возвращает
AbstractType
setValue (   $value)

Устанавливает значение фильтра

Аргументы
mixed$value
Возвращает
AbstractType
where_eq (   $compare = '=')
protected

Сравнивает используя равенство или если включен showtypes, использует > (больше) или < (меньше)

Аргументы
string$compareметод сравнения
where_like (   $likepattern)
protected

Сравнивает строку используя инструкцию LIKE 'NEEDLE'

Аргументы
string$likepatternтип маски LIKE
where_noteq ( )
protected

Сравнивает используя равенство или если включен showtypes, использует > (больше) или < (меньше)

Поля

$emptynull = true
$modificate_query_callback
protected
$type_array_sql = [1 => '<'
$wrap_var