Версия: 5.x
Класс Control
Граф наследования:Control:
AbstractHtml ElementInterface

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

Класс управления фильтром. Класс умеет заполнять формы контейнера данными, получать итоговый SQL запрос для применения фильтров, возвращать визуальные частицы установленных фильтров.

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

 __construct (array $options=array())
 
 setExcludeGetParams (array $keys)
 
 getExcludeGetParams ()
 
 setFilterVar ($var)
 
 getFilterVar ()
 
 setAutoFill ($autofill)
 
 setToAllItems ($options)
 
 setCaption ($text)
 
 getCaption ()
 
 setAddClass ($class= '')
 
 getAddClass ()
 
 getUpdateContainer ()
 
 setUpdateContainer ($container_selector="")
 
 setAddParam (array $params)
 
 getAddParam ($key=null)
 
 getItemByKey ($key)
 
 getCleanFilterUrl ()
 
 getElementsStatus ()
 
 setContainer (Container $container)
 
 getContainer ()
 
 getContainerView ()
 
 fill ($vars=null)
 
 saveGetParams ()
 
 getAllContainers ()
 
 getKeyVal ($with_prefilters=true)
 
 getParts ()
 
 getSqlWhere ()
 
 getView ()
 
 setBeforeSqlWhere ($callback)
 
 getPartsHtml ()
 
- Открытые члены унаследованные от AbstractHtml
 __construct (array $options=array())
 
 setOptions (array $options)
 
 setOption ($key, $value)
 
 getOption ($key, $default=null)
 

Поля данных

 $uniq
 
 $auto_fill = true
 
 $filter_var = 'f'
 
- Поля данных унаследованные от AbstractHtml
 $options = array()
 
 $option_prefixes = array('set', 'add')
 

Защищенные статические члены

static getNextInc ()
 

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

 $tpl = 'system/admin/html_elements/filter/control.tpl'
 
 $parts_tpl = 'system/admin/html_elements/filter/parts.tpl'
 
 $container
 
 $caption = ''
 
 $attr_class = ''
 
 $update_container = ''
 
 $exclude_get_params = array('p')
 
 $before_sql_where_callback
 
 $add_param = array()
 
- Защищенные данные унаследованные от AbstractHtml
 $url
 

Статические защищенные данные

static $inc = 0
 

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

__construct ( array  $options = array())

Методы

fill (   $vars = null)

Заполняет формы текущего фильтра значениями, если они присутствуют в GET параметрах

Аргументы
array$varsЗначения фильтров, который необходимо применить
Возвращает
Control
getAddClass ( )

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

Возвращает
string
getAddParam (   $key = null)

Возвращает произвольные дополнительные параметры

Аргументы
string$key
Возвращает
mixed
getAllContainers ( )

Возвращает основной контейнер и вложенные в него в виде массива.

Возвращает
[]
getCaption ( )

Возвращает подпись для поиска

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

Возвращает URL текущей страницы со сброшенными фильтрами

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

Возвращает контейнер, которым управляет текущий экземпляр класса

Возвращает
Container
getContainerView ( )

Возвращает HTML код контейнера

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

Возвращает - какие элементы были закрыты. берет информацию из cookie

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

Возвращаем массив ключей GET параметров, которые не должны присутствовать в форме фильтра в виде hidden полей

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

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

Возвращает
string
getItemByKey (   $key)

Возвращает объект элемента формы по имени формы

Аргументы
string$key
Возвращает
Type | null
getKeyVal (   $with_prefilters = true)

Возвращает установленные фильтры в виде ассоциативного массива

Возвращает
array
static getNextInc ( )
staticprotected

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

Возвращает
integer
getParts ( )

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

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

Возвращает HTML с установленными в настоящее время фильтрами

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

Возвращает готовую SQL строку для подстановки в условие where sql запроса

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

Возвращает контейнер который надо обновить (Например .updateForm или #updateForm)

getView ( )

Возвращает HTML код формы с фильтрами

Возвращает
string

Замещает ElementInterface.

saveGetParams ( )

Сохраняет текущие GET параметры. Они будут добавлены к URL при применении фильтра

Возвращает
Control
setAddClass (   $class = '')

Добавляет дополнительный класс

Аргументы
string$class
setAddParam ( array  $params)

Добавляет произвольные дополнительные параметры

Аргументы
array$params
Возвращает
Control
setAutoFill (   $autofill)
setBeforeSqlWhere (   $callback)

Устанавливает обработчик, который будет выполняться перед выполнением метода getSqlWhere

Аргументы
callback$callback- callback для вызова
Возвращает
Control
setCaption (   $text)

Устанавливает название поиска

Аргументы
string$text
Возвращает
Control
setContainer ( Container  $container)

Устанавливает контейнер, над которым устанавливается управление

Аргументы
Container$container
Возвращает
Control
setExcludeGetParams ( array  $keys)

Устанавливает массив ключей GET переменных, которые не должны присутствовать в форме фильтра в виде hidden полей

Аргументы
array$keysмассив ключей GET переменных
Возвращает
Control
setFilterVar (   $var)

Устанавливает GET переменную, в которой будут находиться сведения о примененных фильтрах

Аргументы
string$var
Возвращает
Control
setToAllItems (   $options)

Устанавливает опции для всех форм контейнеров

Возвращает
Control
setUpdateContainer (   $container_selector = "")

Устанавливает контейнер который надо обновить (Например .updateForm или #updateForm)

Аргументы
string$container_selector- селектор контейнера

Поля

$add_param = array()
protected
$attr_class = ''
protected
$auto_fill = true
$before_sql_where_callback
protected
$caption = ''
protected
$container
protected
$exclude_get_params = array('p')
protected
$filter_var = 'f'
$inc = 0
staticprotected
$parts_tpl = 'system/admin/html_elements/filter/parts.tpl'
protected
$tpl = 'system/admin/html_elements/filter/control.tpl'
protected
$uniq
$update_container = ''
protected