citfact/uservars

User vars module

Пользовательские переменные

Необходимы в случае, если требуется добавить несколько простых настроек для сайта с возможностью редактирования из административной части, например для возможности изменения клиентом. Для удобства есть возможность группировки переменных., _(*1)

Библиотека находятся в пространстве имен Citfact\UserVars, _(*2)

Установка

Создайте или обновите composer.json файл и запустите php composer.phar install ``` json { "require": { "citfact/uservars": "dev-master" } }, _(*3)

Пример использования
==================
Для быстрого доступа к переменным и группам, служат классы ``Citfact\UserVars\Vars`` и ``Citfact\UserVars\VarsGroup``

``` php
  use Citfact\UserVars;

  $varsGroup = new UserVars\VarsGroup();

  // Предопределены два метода findBy* и findOneBy*
  $varsGroup->findById(1);
  $varsGroup->findByCode('TEST');

  $vars = new UserVars\Vars();
  $vars->findById(1);
  $vars->findByCode('TEST');
  $vars->findByGroup(1);

  // Получаем все переменные по символьному коду
  $varsResult = $vars->findByCode('FIND_CODE');
  while ($var = $varsResult->fetch()) {
    print_r($var);
  }

  // Получаем одну переменную из группы
  $var = $vars->findOneByGroup(1)->fetch();

Для более гибкой выборки переменных или групп, работайте на прямую через модели:, _(*4)

• Citfact\UserVars\Model\VarsTable
• Citfact\UserVars\Model\VarsGroupTable

``` php use Bitrix\Main\Entity; use Citfact\UserVars\Model;, <sub>(*5)</sub>

$queryBuilder = new Entity\Query(Model\VarsGroupTable::getEntity()); $queryBuilder ->setSelect(array('ID', 'NAME', 'CODE')) ->setOrder(array('ID', 'asc')) ->setFilter(array('CODE' => 'TEST_CODE')) ->setLimit(1);, <sub>(*6)</sub>

$result = $queryBuilder->exec()->fetch(); ```, <sub>(*7)</sub>

Удаление и обновление, также выполняется через модель, <sub>(*8)</sub>

``` php use Citfact\UserVars\Model;, <sub>(*9)</sub>

// Удаляем переменную с ID = 1 Model\VarsTable::delete(1);, <sub>(*10)</sub>

// Обновляем наименование у группы Model\VarsGroupTable::update(1, array('NAME' => 'New name'));, <sub>(*11)</sub>