Разрботка расширений для CMS Joomla
Шрифт:
Создание/редактирование записи таблицы
Как правило, для создания или редактирования записи таблицы во фронтенде или бэкенде создается HTML-форма. Значения, введенные в нее пользователем, можно получить с помощью класса JRequest в виде массива. Полученный массив необходимо связать с объектом JTable. Связываниезаключается в том, что каждому полю класса присваивается значение элемента массива, ключ которого совпадает с названием этого поля. Для этого используется метод
bool bind(mixed $src, mixed $ignore=array)
где:
$src -
Например:
if (!$row->bind(JRequest::get('post'))) return JError::raiseWarning(500, $row->getError);
Обычно ошибка связывания возникает, если поля класса не соответствуют ключам массива, - например, когда в HTML-форме в название элемента input вкралась опечатка.
Для сохранения записи используется метод bool store(bool $updateNulls=false)
Если параметр $updateNulls равен false, то те поля объекта JTable, которые имеют значение null, будут игнорироваться при связывании.
Пример использования метода store:
if (!$row->store) JError::raiseError(500, $row->getError);
Метод store на основе хранящихся в $row значений генерирует запрос UPDATE или INSERT, в зависимости от значения id. Если запись создается впервые, то она не имеет значения id и будет сконструирован запрос INSERT, в противном случае - UPDATE. Это позволяет использовать данный метод как для создания новых записей, так и для обновления существующих.
Получение записи из таблицы
Для получения записи используется метод
bool load(mixed $keys = NULL, bool $reset = true)
где
$keys - первичный ключ записи, которую необходимо получить, или массив полей для поиска соответствий; $reset - задает, будут ли перед получением новой записи заново присвоены полям значения по умолчанию.
Например:
$row->load($id);
Удаление записи
Для удаления записи используется метод
bool delete(mixed $id=null)
где $id - первичный ключ записи, которую требуется удалить. Если он не задан, то используется значение соответствующего поля объекта.
Пример:
$row->delete($id);
Управление полями ordering, checked_out/checked_out_time, published и hits
Существуют методы класса JTable для управления часто используемыми полями ordering, checked_out/checked_out_time, published и hits.
ordering
Поле ordering позволяет пользователю упорядочить список объектов по своему желанию. Чтобы пересчитать значения в поле ordering, используется метод void reorder([string $where = ''])
При этом записи сортируются по значению ordering, а затем в это поле записываются натуральные числа, начиная с 1. Параметр $where позволяет задать условие ограничения выборки, к которой будет применена эта операция.
Пример использования метода:
$table->reorder;
Изменить
void move(int $dirn, [string $where = ''])
где $dirn - величина, которая будет прибавлена к текущему значению ordering (отрицательное значение приведет к смещению записи вверх, а положительное - вниз).
Например, поднимем запись на одну строку вверх:
$table->load($id); $table->move(-1);
checked_out/checked_out_time
Поля checked_out и checked_out_time используются для блокировки записей во избежание редактирования их несколькими пользователями одновременно. checked_out хранит id пользователя, работающего с записью в данный момент, а checked_out_time - время начала редактирования. Прежде чем заблокировать запись, необходимо проверить, не заблокирована ли она уже другим пользователем, с помощью метода
bool isCheckedOut(int $with=0, int $against=null)
где:
$with - id пользователя, с которым нужно сравнить значение поля checked_out. Если запись заблокирована как раз этим пользователем, то функция вернет false, как и в том случае, если она не заблокирована вообще. В обоих этих случаях текущий пользователь имеет право работать с ней; $against - id пользователя, использующийся, если функция вызвана как статическая.
Для блокировки записей используется метод
bool checkOut(int $userId, mixed $pk=null)
где:
$userId - id пользователя, блокирующего запись; $pk - первичный ключ записи, которую необходимо заблокировать. Если он не задан, используется значения соответствующего поля класса.
При этом в поле checked_out_time будет записано текущее время.
Для разблокировки записей используется метод bool checkIn(mixed $pk=null)
Рассмотрим пример использования этих методов:
$table->load($id); $user =& JFactory::getUser; if ($table->isCheckedOut($user->get('id'))) die('Запись уже заблокирована другим пользователем'); echo 'Запись не заблокирована'; if (!$table->checkout($user->get('id'))) die('Не удалось заблокировать запись с id текущего пользователя'); echo 'Заблокировали запись'; // работа с записью... if (!$table->checkin($user->get('id'))) die('Не удалось разблокировать запись'); echo 'Разблокировали запись';
published
Значение поля published показывает, опубликована ли запись. Чтобы изменить значение этого поля для одной или нескольких записей, используется метод
bool publish(mixed $pks=null, int $state=1, int $userId=0)
где:
$pks - массив ключей записей, к которым необходимо применить операцию; $state - новое значение поля published (0 или 1); $userId - используется только когда в таблице существует также поле checked_out. При наличии в таблице этого поля метод publish может быть применен только к тем записям, для которых checked_out равно 0 или заданному $userId.