1. Документация
  2. Для разработчика сайта
  3. Функции и классы
  4. Встроенные классы

Класс Admin

Системные методы для работы в режиме авторизованного пользователя.

Admin::authenticate($factors=[], &$errors)

Метод для аутентификации пользователя через логин и пароль.

  • Возвращает массив данных о пользователе, если аутентификация прошла успешно.
  • $factors — массив входных данных. Ключи массива: 'login', 'password', 'save-password'. Последний ключ необязателен - он служит для сохранения логина и пароля.
  • $errors — массив с сообщениями об ошибках (ключи массива ассоциативные).

Admin::getBlockButton($blockId, $options=[])

  • Возвращает html-код кнопки редактирования блока (кнопки многозаписного редактирования).
  • $blockId — номер блока.
  • $options — массив с опциями (указаны значения по умолчанию): 
    $options = [
    'block-info'=>[], # Если не задан, будет вычислен с помощью метода Blox::getBlockInfo()
    'tdd'=>[], # Если не задан, будет вычислен с помощью функции метода Tdd:get()
    'pagehref-query'=>'', # Запрос, отвечающий за возврат на страницу. Если не задан, то будет применен: '&pagehref='.Blox::getPageHref(true).
    'return-href'=>false, # Если true, возвращает не html-код кнопки, а только ее URL
];

    Для булевых опций можно применять короткую форму записи. Подробности см. в описании метода Arr::formatOptions(), который и применен внутри описываемого метода.

Admin::deleteRec($tpl, $recId, $srcBlockId, $tbl=null, $xprefix=null)

Метод для удаления записей из штатных блоков. В отличие от метода Dat::delete(), данный метод удаляет не только саму запись, но все связанные данные, имеющиеся у спецданных (картинки, блоки и т.д),

  • Возвращает true в случае успешного выполнения.
  • $tpl — шаблон блока.
  • $recId — номер удаляемой записи.
  • $srcBlockId — номер исходного блока.
  • $tbl — имя таблицы штатных данных. Пример: '$shop/catalog/goods/photos'. Параметр необязателен.

  • $xprefix — префикс переменных дескриптора (строка). Если передается "x", то метод будет применяется к экстраданным.