Содержание
Изменение записей
В данном разделе описаны методы класса cmsModel, позволяющие добавлять, изменять и удалять записи из базы данных.
Все примеры кода подразумевают, что действие происходит в контексте модели (т.е. внутри класса вашей модели, унаследованного от cmsModel).
Вы должны иметь представление о работе SQL-запросов для полного понимания описанных здесь методов.
Добавление записей
Список INSERT запросов к базе данных.
Простое добавление
insert($table_name, $data, $array_as_json = false, $ignore = false)
| $table_name | Название таблицы, без префикса |
| $data | Массив данных для вставки, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Обратите внимание, если в массиве данных есть названия ключей, которых нет в списке ячеек таблицы, то ошибки при вставке не будет, - эти данные будут проигнорированы. |
| $array_as_json | Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра true, массив будет преобразован в JSON. |
| $ignore | Если значение этого параметра true, будет выполнен запрос INSERT IGNORE вместо простого INSERT. |
Метод возвращает id вставленной строки.
Пример:
$id = $this->insert('users_statuses', ['content' => 'Мой статус', 'user_id' => 1]);
Добавление с обновлением
Метод выполняет запрос INSERT (INSERT ... ON DUPLICATE KEY UPDATE), но при совпадении PRIMARY или UNIQUE ключа выполняет UPDATE вместо INSERT.
insertOrUpdate( $table_name, $insert_data, $update_data = false, $array_as_json = false )
| $table_name | Название таблицы, без префикса |
| $insert_data | Массив данных для вставки, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Ключи массива не проверяются на наличие ячеек в таблице. |
| $update_data | Массив данных для обновления существующей записи при совпадении уникальных ключей. Если этот параметр равен false, то будет равен параметру $insert_data. |
| $array_as_json | Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра true, массив будет преобразован в JSON. |
Метод возвращает id вставленной строки при условии, что строка добавлена, а не обновлена.
Пример:
$id = $this->insertOrUpdate('tags', ['tag' => $tag]);
Если в ячейке tag значение $tag уже есть в таблице, то $id будет равен false. Ячейка tag имеет уникальный индекс.
Изменение записей
Обновление записи
update( $table_name, $id, $data, $skip_check_fields = false, $array_as_json = false )
| $table_name | Название таблицы, без префикса |
| $id | ID записи, которую нужно обновить |
| $data | Массив данных для обновления, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Обратите внимание, если в массиве данных есть названия ключей, которых нет в списке ячеек таблицы, то ошибки при вставке не будет, - эти данные будут проигнорированы. |
| $skip_check_fields | Если значение этого параметра true, то проверка существования ячеек таблицы по названию ключей не будет осуществляться. |
| $array_as_json | Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра true, массив будет преобразован в JSON. |
Метод возвращает true или false.
Пример:
$this->update('articles', $id, [ 'title' => 'Новое название', ]);
Метод устанавливает filterEqual('id', $id) и передаёт операцию в метод updateFiltered().
updateFiltered( $table_name, $data, $skip_check_fields = false, $array_as_json = false )
Обновляет все записи, соответствующие текущим фильтрам.
Пример:
$this-> filterEqual('is_pub', 0)-> updateFiltered('articles', ['is_pub' => 1]);
После формирования условий фильтры сбрасываются.
Замена подстроки
Заменяет подстроку в указанном поле у всех записей, подходящих под LIKE.
replaceFieldString($table_name, $search, $replace, $field)
| $table_name | Название таблицы, без префикса |
| $search | Что меняем |
| $replace | Чем заменяем |
| $field | Название поля, в котором ищем |
Пример:
$this->replaceFieldString( 'articles', 'старый текст', 'новый текст', 'content' );
increment/decrement
Увеличивает числовое поле непосредственно в SQL.
increment($table, $field, $step = 1)
| $table | Название таблицы, без префикса |
| $field | Название поля таблицы, в котором изменяем число |
| $step | Шаг изменения, может быть дробным. Отрицательное значение уменьшает поле. |
$this-> filterEqual('id', $id)-> increment('articles', 'views');
Уменьшает числовое поле. Реализован через increment() с отрицательным шагом.
decrement($table, $field, $step = 1)
| $table | Название таблицы, без префикса |
| $field | Название поля таблицы, в котором изменяем число |
| $step | Шаг уменьшения, может быть дробным. |
Максимальное/минимальное значение поля
Возвращает максимальное/минимальное значение поля с учётом текущих фильтров.
getMax($table, $field, $default = 0, $dir = 'MAX')
| $table | Название таблицы, без префикса |
| $field | Название поля таблицы, в котором ищем максимальное число |
| $default | Значение по умолчанию, если значений нет. |
| $dir | Направление: MAX или MIN. |
Возвращает минимальное значение поля с учётом текущих фильтров. Реализован через getMax() с направлением MIN.
getMin($table, $field, $default = 0)
Удаление записей
Удаляет запись, фильтруя по указанному полю.
delete($table_name, $id, $by_field = 'id')
| $table_name | Название таблицы, без префикса |
| $id | Значение поля по которому фильтруем |
| $by_field | Название поля, по которому фильтруем |
Пример:
$this->delete('articles', $id);
Можно изменить поле фильтрации:
$this->delete('articles', $slug, 'slug');
Метод устанавливает filterEqual($by_field, $id) и передаёт операцию в метод deleteFiltered().
deleteFiltered($table_name)
Удаляет все записи, соответствующие текущим фильтрам.
| $table_name | Название таблицы, без префикса |
Пример:
$this-> filterEqual('is_deleted', 1)-> deleteFiltered('articles');
