public
|
#
__construct( string $table, string $key )
Инициализация модели
Parameters
- $table
string
название используемой таблицы, можно с
преффиксом, например #__news- $key
string
Название поля первичного ключа таблицы,
|
public
string
|
#
get_class_name( )
Возвращает назание текущей модели
Возвращает назание текущей модели
Returns
string
|
public
string
|
#
get_model_name( )
Аналог метода get_class_name
Аналог метода get_class_name
Returns
string
|
public
array
|
#
get_fieldinfo( )
Заглушка получения информации о полях
Заглушка получения информации о полях
Returns
array
|
public
array
|
#
get_tableinfo( )
Заглушка получения информации о таблице
модели
Заглушка получения информации о таблице
модели
Returns
array
|
public
array
|
#
get_tabsinfo( )
Заглушка получения информации о вкладках
для оформления информации
Заглушка получения информации о вкладках
для оформления информации
Returns
array
|
protected
array
|
#
get_validate_rules( )
Заглушка получения правил валидации
полей модели
Заглушка получения правил валидации
полей модели
Returns
array
|
public
boolean|array
|
#
get_validation_error_messages( )
Получение массива ошибок валидации
модели
Получение массива ошибок валидации
модели
Returns
boolean|array
массив ошибок или
|
public
boolean
|
#
validate( )
Валидация полей модели
Returns
boolean
|
public static
stdClass
|
#
__set_state( array $values )
Магический метод восстановления объекта
Используется при прямом кэшировании
модели
Магический метод восстановления объекта
Используется при прямом кэшировании
модели
Parameters
- $values
array
- массив значений востановленного объекта Returns
stdClass
восстановленный объект модели
|
public
stdClass
|
#
to_cache( )
Подготовка модели к кэшированию
Подготовка модели к кэшированию
Returns
stdClass
подготовленный к кэшированию объект
|
public
string
|
#
get_key_field( )
Возвращает название ключевого поя
текущей модели
Возвращает название ключевого поя
текущей модели
Returns
string
|
public
array
|
#
get_public_properties( )
Получение массива публичных свойств -
полей текущей модели
Получение массива публичных свойств -
полей текущей модели
Returns
array
|
public
|
#
filter( array $ignoreList = null )
Очищает значения публоичных свойств
модели от HTML тэгов Пример $this->filter(
array('desc','extra') );
Очищает значения публоичных свойств
модели от HTML тэгов Пример $this->filter(
array('desc','extra') );
Parameters
- $ignoreList
array
массив названий полей модели, которые НЕ
требуется очистить от HTML кода
|
public
string
|
#
get_errors( )
Получение текста ошибки при работе с
текущей моделью
Получение текста ошибки при работе с
текущей моделью
Returns
string
|
public
string
|
#
get( string $_property )
Получение значения поля
Parameters
- $_property
string
название поля Returns
string
значение поля
|
public
|
#
set( string $_property, string $_value )
Установка значения конкретного поля
модели
Установка значения конкретного поля
модели
Parameters
- $_property
string
название модели- $_value
string
значение поля для установки
|
public
|
#
reset( string $value = null )
Сброс значения полей активной модели
Сброс значения полей активной модели
Parameters
- $value
string
значение, устанавливаемое во все поля
активной модели
|
public
boolean
|
#
bind( array $array, string $ignore = '' )
Заполнение значения полей модели
значениями ассоциативного массива
Заполнение значения полей модели
значениями ассоциативного массива
Parameters
- $array
array
двумерный массив "название
поля"=>"значение поля"- $ignore
string
название аттрибута для игнорирования Returns
boolean
результат заполнения
|
public
boolean
|
#
load( integer $oid )
Загрузка данных в модель непосредственно
из БД по значению ключевого поля В случае
успешного выполнения заполняет поля модели
значениями из БД выбранными по ключевому
полю
Загрузка данных в модель непосредственно
из БД по значению ключевого поля В случае
успешного выполнения заполняет поля модели
значениями из БД выбранными по ключевому
полю
Parameters
- $oid
integer
значение уникального ключевого поля, по
которому необходимо делать выборку в БД Returns
boolean
результат заполнения свойств модели
|
public
boolean
|
#
load_by_field( string $field, string $value )
Загрузка данных в модель непосредственно
из БД по значению произвольного поля В
случае успешного выполнения заполняет поля
модели значениями первого результата из БД
выбранными по указанному
Загрузка данных в модель непосредственно
из БД по значению произвольного поля В
случае успешного выполнения заполняет поля
модели значениями первого результата из БД
выбранными по указанному
Parameters
- $field
string
название произвольного поля модели- $value
string
значение произвольного поля модели Returns
boolean
результат заполнения свойств модели
|
public
boolean
|
#
store( boolean $update_nulls = false, boolean $forced_Insert = false )
Сохранение свойств модели в БД Производит
непосредственно запись в БД значений
заполненных полей модели. При этом сами
свойства должны быть указаны ранее, методом
bind, либо set, либо прямого присвоения
$news->title='Новость 1'
Сохранение свойств модели в БД Производит
непосредственно запись в БД значений
заполненных полей модели. При этом сами
свойства должны быть указаны ранее, методом
bind, либо set, либо прямого присвоения
$news->title='Новость 1'
Parameters
- $update_nulls
boolean
флаг обновления неопределённых свойств- $forced_Insert
boolean
флаг принудительной вставки. Необходимо в
случаях, когда значение ключевого поля уже
задано, но всё-равно необходимо создать
новую запись (например, в компоненте
категорий: category_id известно, но в таблице
categories_details нужно создать запись с
этим ключом ) Returns
boolean
результат сохранения модели
|
public
boolean
|
#
update( )
Прямое обновление значения полей объекта
модели
Прямое обновление значения полей объекта
модели
Returns
boolean
результат выполнения обновления
|
public
boolean
|
#
check( )
Переопределяемая функция проверки
правильности заполнения полей модели
Переопределяемая функция проверки
правильности заполнения полей модели
Returns
boolean
результат проверки
|
protected
boolean
|
#
before_update( )
Метод, выполняемый до обновления значений
модели
Метод, выполняемый до обновления значений
модели
Returns
boolean
|
protected
boolean
|
#
after_update( )
Метод, выполняемый после обновления
значений модели
Метод, выполняемый после обновления
значений модели
Returns
boolean
|
protected
boolean
|
#
before_insert( )
Метод выполняемый до добавления значений
модели
Метод выполняемый до добавления значений
модели
Returns
boolean
|
protected
boolean
|
#
after_insert( )
Метод выполняемый после вставки значений
модели
Метод выполняемый после вставки значений
модели
Returns
boolean
|
protected
boolean
|
#
before_store( )
Метод выполняемый до сохранения значений
модели ( вставка / обновление )
Метод выполняемый до сохранения значений
модели ( вставка / обновление )
Returns
boolean
|
protected
boolean
|
#
after_store( )
Метод выполняемый после полного
сохранения данных модели ( вставка /
обновление )
Метод выполняемый после полного
сохранения данных модели ( вставка /
обновление )
Returns
boolean
|
protected
boolean
|
#
before_delete( )
Метод выполняемый до удаления конкретной
записи модели
Метод выполняемый до удаления конкретной
записи модели
Returns
boolean
|
protected
boolean
|
#
after_delete( )
Метод выполняемый после удаления
конкретной записи модели
Метод выполняемый после удаления
конкретной записи модели
Returns
boolean
|
public
boolean
|
#
delete( mixed $oid )
Удаление записи в БД по значению
ключевого поля Производит
непосредственное удаление записи из БД
Удаление записи в БД по значению
ключевого поля Производит
непосредственное удаление записи из БД
Parameters
- $oid
mixed
значение ключевого поля Returns
boolean
результат удаления
|
public
boolean
|
#
delete_array( array $oid = array(), string|boolean $key = false, string|boolean $table = false )
Удаление неограниченного числа записей в
БД через указание массива значений
ключевого, либо произвольного поля
Производит непосредственное удаление
записей из БД принимая массив значений вида
array(1,15,16,22)
Удаление неограниченного числа записей в
БД через указание массива значений
ключевого, либо произвольного поля
Производит непосредственное удаление
записей из БД принимая массив значений вида
array(1,15,16,22)
Parameters
- $oid
array
массив значений ключевого- $key
string|boolean
название ключевого поля, по умолчанию -
название ключевого поля текущей модели- $table
string|boolean
название таблицы, в которой необходимо
произвести удаление, по умолчанию - таблица
текущей модели Returns
boolean
результат удаления записей
|
public
boolean
|
#
delete_list( array $params = array() )
Удаление элементов в БД через указание
произвольных условий
Удаление элементов в БД через указание
произвольных условий
Parameters
- $params
array
массив параметров для формирования
условий удаления Returns
boolean
результат удаления
|
public
boolean
|
#
copy_array( array $oid = array(), string|boolean $key = false, string|boolean $table = false )
Копирование неограниченного числа
записей в БД через указание массива
значений ключевого, либо произвольного
поля
Копирование неограниченного числа
записей в БД через указание массива
значений ключевого, либо произвольного
поля
Parameters
- $oid
array
массив значений ключевого- $key
string|boolean
название ключевого поля, по умолчанию -
название ключевого поля текущей модели- $table
string|boolean
название таблицы, в которой необходимо
произвести копирование, по умолчанию -
таблица текущей модели Returns
boolean
результат копирования записей
|
public
boolean
|
#
save( array $source, string $ignore = '' )
Сохранение свойств модели в БД
Сохранение свойств модели в БД
Parameters
- $source
array
массив свойств название поля=>значение
поля для заполнения свойств модели ( см.
self::bind )- $ignore
string
название аттрибута для игнорирования Returns
boolean
результат сохранения
|
public
boolean
|
#
set_state_group( array $cid = null, integer $state = 1 )
Parameters
- $cid
array- $state
integer Returns
boolean
|
public
boolean
|
#
change_state( string $field_name )
Булево изменение содержимого указанного
столбца. Используется для смены статуса
элемента Меняет значение указанного поля
на противопложное
Булево изменение содержимого указанного
столбца. Используется для смены статуса
элемента Меняет значение указанного поля
на противопложное
Parameters
- $field_name
string
название свойства модели для изменения на
противоположное Returns
boolean
результат смены значения поля
|
public
integer
|
#
count( string $where = '' )
Возвращает число записей в таблице БД
активной модели
Возвращает число записей в таблице БД
активной модели
Parameters
- $where
string
дополнительное условие для подсчета числа
записей, например "WHERE state=1" Returns
integer
число записей
|
public
integer
|
#
sum( string $field, string $where = '' )
Возвращает сумму по определенному полю
Возвращает сумму по определенному полю
Parameters
- $field
string
поле, по которому считаем- $where
string
дополнительное условие Returns
integer
число записей
|
public
array
|
#
get_list( array $params = array() )
Возвращает массив результатов выборки
Возвращает массив результатов выборки
Parameters
- $params
array
массив параметров для уточнее области
выборки результата <pre> select - список поле
для выборки, по умолчанию * (все поля) where -
условие WHERE для выборки join - данные о
объединённой выборке с использованием
сторонних таблиц group - название поля для
группировки результата, пример - " user_id " order -
название поля и направление сортировки
результата, пример - " id DESC ", либо "id DESC, title ASC"
offset - смещение для выборки результата, по
умолчанию - 0 limit - лимит выборки для
результата, по молчанию - 0, т.е. ВСЕ записи key
- название ключевого поля, для
использования в качестве ключа
ассоциативного массива результатов. По
умолчанию использует ключевое поле модели.
key=>FALSE если необходимо сделать простой
массив ( 0=>array(),1=>array() ) <pre> Returns
array
ассоциативный или обычный массив
результатов
|
public
array
|
#
get_list_cache( array $params = array(), integer $cache_time = 86400 )
Версия метода get_list с кэшированием
Версия метода get_list с кэшированием
Parameters
- $params
array
Те же параметры, что и для get_list- $cache_time
integer
Время жизни кэша Returns
array
Закэшированное значение
|
public
array
|
#
get_selector( array $key_val = array(), array $params = array() )
Возвращает ассоциативный двумерный
массив возможных значений модели
Возвращает ассоциативный двумерный
массив возможных значений модели
Parameters
- $key_val
array
- массив array( 'key'=>'название поля -
ключа','value'=>'название поля - значения' ). По
умолчанияю key=>id, value=>title- $params
array
массив параметров для уточнее области
выборки результата <pre> select - список поле
для выборки, по умолчанию key,value (поля
указанные в $key_val) where - условие WHERE для
выборки order - название поля и направление
сортировки результата, пример - " id DESC ", либо
"id DESC, title ASC" offset - смещение для выборки
результата, по умолчанию - 0 limit - лимит
выборки для результата, по молчанию - 0, т.е.
ВСЕ записи table - название таблицы, из которой
необходимо сделать выборку. По умолчанию -
таблица текущей модели <pre> Returns
array
- ассоциативный массив результата
|
public
|
|
public
|
#
save_one_to_many( $name_table_keys, $key_name, $value_name, $key_value, array $values )
|
public
|
#
get_one_to_many_selectors( $name, $table_values, $table_keys, $key_parent, $key_children, array $selected_ids = array(), array $params = array() )
|
public
boolean
|
#
find( array $params = array('select' => '*') )
Загрузка значение текущей модели через
указание произвольных свойств модели
Загрузка значение текущей модели через
указание произвольных свойств модели
Parameters
- $params
array
массив параметров для условий выборки Returns
boolean
результат поиска и загрузки значений в
свойства текущей модели
|
public
boolean
|
#
find_cache( array $params = array('select' => '*'), integer $cache_time = 86400 )
Кэширующая обертка над фунцией find
Кэширующая обертка над фунцией find
Parameters
- $params
array
Параметры к методу find- $cache_time
integer
Время кэширования Returns
boolean
Найденный объект
Todo
проверить обоснованность использования
$find_result
|
public
array
|
#
find_all( array $params = array() )
Поиск записей, удовлетворяющих указаным
свойствам объекта
Поиск записей, удовлетворяющих указаным
свойствам объекта
Parameters
- $params
array
массив параметров для уточнения области
поиска записей <pre> select - список поле для
выборки, по умолчанию * (все поля) where -
условие WHERE для выборки order - название поля и
направление сортировки результата, пример -
" id DESC ", либо "id DESC, title ASC" offset - смещение для
выборки результата, по умолчанию - 0 limit -
лимит выборки для результата, по молчанию -
0, т.е. ВСЕ записи key - название ключевого
поля, для использования в качестве ключа
ассоциативного массива результатов. По
умолчанию использует ключевое поле модели.
key=>FALSE если необходимо сделать простой
массив ( 0=>array(),1=>array() ) <pre> Returns
array
ассоциативный массив результата поиска
|
public
integer
|
#
get_max_by_field( string $name )
Возвращает максимальное значение по
заданному полю
Возвращает максимальное значение по
заданному полю
Parameters
Returns
integer
максимальное значение
|
public
boolean
|
#
insert_array( array $array_values )
Вставка массива значений в таблицу
текущего объекта
Вставка массива значений в таблицу
текущего объекта
Parameters
Returns
boolean
результат вставки массива
Example
$values = array( 0 => array( 'counter' => 111, 'name' => 'первая
запись', ), 1 => array( 'name' => ' вторая запись ',
'counter' => 2222 ), 2 => array( 'name' => ' третья
запись', 'counter' => 123456 ), );
|
public
|
|