Download the PHP package nonagod/user-actions without Composer
On this page you can find all versions of the php package nonagod/user-actions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package user-actions
"Действия пользователя" (php
)
Реализация серверной части абстракции "user actions", на языке php
.
- Установка
- Использование
- Подключение
- Форматы
Установка
composer require nonagod/user-actions
Инициализация
composer require nonagor/user_actions
Использование
Примеры использования можно посмотреть в папке examples
.
Инициализация
Объект класса должен быть создан до вывода како-го либо контента и после определения всех нужных конструкций.
__constructor( $path )
:
string $path
- абсолютный путь до папки с обработчиками действий
Замечание: Директорию с обработчиками желательно выносить за пределы сайта или закрывать от доступа пользователей.
Обработчики
Замечание: Каждый обработчик обязательно должен вызывать соответствующий метод завершения.
Замечание:
Nonagod\UserActions\Manager
отлавливает\Nonagod\Exceptions\UserException
и самостоятельно вызываетfailed
. В таком случае, явный вызов в обработчике не требуется.
succeed( $answer_data = null )
:
Отправляет ответ об успешном завершение обработчика.
?mixed $answer_data
- произвольные данные, для дополнительной обработке на клиенте
failed( string $code, string $msg = null, $error_info = null )
:
Отправляет ответ об ошибке обработчика.
string $code
- код ошибки?string $msg
- краткое описание ошибки?mixed $error_info
- дополнительные данные для доп. обработки ошибки на клиенте
Запрос контента
Замечание:
defineStartOfContentPart
иdefineEndOfContentPart
парные методы.
defineStartOfContentPart( $name )
:
Опеределяет начало запрашиваемой части контента.
string $name
- кодовое обозначение части страницы
defineEndOfContentPart( $name )
:
Опеределяет конец запрашиваемой части контента.
string $name
- кодовое обозначение части страницы
Форматы
Запрос:
Успешный ответ:
Ответ с ошибкой:
Дополнительные утверждения
- Логирование, капча и прочее, делается в обработчиках, где это необходимо.
ToDo
- [ ] Сделать отлов прочих (помимо
UserExceptions
) ошибок, их логирование и отдачу пользователя обобщающей ошибки ("Что-то пошло не так") - [ ] Подумать, может можно сделать для обработчиков свой класс, чтобы убрать рутину из обработчиков. (+ управлять валидацией и откатом)
- [ ] Заменить очистку активных буферов в методе
defineStartOfContentPart