Download the PHP package pozitronik/yii2-users-options without Composer
On this page you can find all versions of the php package pozitronik/yii2-users-options. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pozitronik/yii2-users-options
More information about pozitronik/yii2-users-options
Files in pozitronik/yii2-users-options
Package yii2-users-options
Short Description Server-side personal user options
License GPL-3.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package yii2-users-options
yii2-users-options
Хранение настроек пользователя на сервере (a-la server-side cookies)
Установка
Предпочтительный вариант установки расширения через composer.
Выполните
или добавьте
В секцию require файла composer.json в вашем проекте.
Описание
Модель UsersOptions умеет хранить набор произвольных key-value параметров, привязанных к любому объекту (подразумевается, что таким объектом
выступает пользователь системы, но, при желании, модель может быть использована и для других объектов).
Данные хранятся в таблице со структурой user_id|option_name|option_value, и модель всего лишь предоставляет интерфейсы для удобного
доступа к хранилищу.
Типы данных хранимых значений ограничиваются только используемым методом сериализации. По умолчанию обеспечивается типобезопасное хранение
скалярных данных, массивов и объектов без реккурентных ссылок.
Использование
Расширению необходима таблица для хранения данных. Её можно создать, выполнив команду:
yii migrate --migrationPath=@vendor/pozitronik/yii2-users-options/migrations
В этом случае будет создана таблица users_options, и никакой дополнительной настройки более не потребуется.
При необходимости можно переопределить имя используемой таблицы. Для этого нужно подключить в конфигурационном файле вашего приложения
модуль UsersOptionsModule с именем usersoptions, и в его конфигурации указать имя используемой таблицы в параметре tableName.
Модель может использовать промежуточное кеширование (при наличии кеша в Yii), это регулируется параметром cacheEnabled
Пример конфигурации:
Публичные параметры класса:
null|int $user_id = null-- идентификатор пользователя. Если не установлен, используется идентификатор текущего пользователя.Connection|array|string $db = 'db'-- идентификатор имеющегося соединения с базой данных или конфигурация нового соединения.-
null|array $serializer = null-- методы, используемые для сериализации хранимых данных. Если параметр не установлен, то используются стандартные функцииserialize()/unserialize(). Для их переопределения следует задать параметр с помощью замыканий, например: bool $cacheEnabled = false-- включает использование промежуточного кеша. Если параметр не установлен напрямую, используется значение параметраcacheEnabledконфигурации модуля.string $tableName-- название таблицы, используемое модулем (read-only).
Публичные методы класса:
get(string $option):mixed- возвращает значение параметра$optionдля установленного пользователя.set(string $option, mixed $value):bool- присваивает параметру$optionзначение$value. Возвращает успех сохранения параметра.drop(string $option):bool- удаляет параметр$option(без проверки его существования). Возвращает успех удаления параметра.dropAll():bool- удаляет все параметры пользователя.list():array- возвращает массив всех сохранённых параметров пользователя в формате [$option=>$value].
а также статические методы
getStatic(int $user_id, string $option):mixedsetStatic(int $user_id, string $option, mixed $value):booldropStatic(int $user_id, string $option):booldropAllStatic(int $user_id):boollistStatic(int $user_id):array
Аналогичные вызовам get()/set()/drop()/dropAll()/list().
В случае, если модель пользователя расширяет класс ActiveRecord и имеет целочисленный идентификатор $id, то проще всего использовать
трейт pozitronik\users_options\traits\UsersOptionsTrait.php. В нём описано свойство $options, возвращающее объект UsersOptions. Просто
используйте трейт в модели пользователя, например так:
После этого обращаться к параметрам текущего пользователя станет возможно через вызовы
В иных случаях описывайте атрибут $options в модели самостоятельно, либо используйте статические
методы UsersOptions::getStatic()/UsersOptions::getStatic()
Для сохранения настроек с помощью AJAX, подключите в нужном view-файле ассет pozitronik\users_options\assets\UsersOptionsAsset.php и
используйте js-вызов set_option(key, value). Подразумевается, что он должен обратиться к экшену actionUserSetOption() реализованному в
контроллере pozitronik\users_options\controllers\AjaxController, либо контроллеру, содержащему реализацию такого метода (либо
наследующегося от контроллера расширения). Приведённую реализацию следует считать примером, т.к. конкретный подход может различаться в
каждом отдельном случае.
Лицензия
GNU GPL v3.0
