PHP code example of fi1a / usersettings

1. Go to this page and download the library: Download fi1a/usersettings library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.
    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

fi1a / usersettings example snippets




public function up()
{
    $helper = $this->getHelperManager();

    $helper->UserSettings()->saveTab("TAB", array (
        'ACTIVE' => '1',
        'CODE' => 'TAB',
        'SORT' => '500',
        'LOCALIZATION' => [
            'ru' => [
                'L_NAME' => 'Вкладка',
                'L_TITLE' => 'Вкладка',
            ],
            'en' => [
                'L_NAME' => 'Tab',
                'L_TITLE' => 'Tab',
            ],
        ],
    ));
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Option;

Loader::

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Option;

Loader::, если значение не задано вернется false
Option::getInstance()->get('UF_CAPTCHA_SECRET', false);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Option;

Loader::вательским полям
Option::getInstance()->getAll();

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Option;

Loader::PTCHA_SECRET', 'foo');
if (!$result->isSuccess()) {
    // В случае ошибки
    echo implode('<br>', $result->getErrorMessages());

    return;
}

// Вернется значение "foo" установленное методом "set"
$option->get('UF_CAPTCHA_SECRET');

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Option;

Loader::

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Tab;

Loader::OPTIONS',
    'SORT' => 500,
    'LOCALIZATION' => [
        'ru' => [
            'L_NAME' => 'Настройки формы',
            'L_TITLE' => 'Важные настройки формы',
        ],
    ],
]);

$addResult = $tab->add();
if (!$addResult->isSuccess()) {
    echo implode('<br>', $addResult->getErrorMessages());
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::CTIVE' => 1,
    ],
    'order' => [
        'SORT' => 'ASC',
    ],
]);

foreach ($tabCollection as $tab) {
    // Do something
}
unset($tab);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::SORT' => 'ASC',
    ],
]);

foreach ($tabCollection as $tab) {
    // Do something
}
unset($tab);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::['ID'];
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::IVE'] = 0;

    $updateResult = $tab->update();

    if (!$updateResult->isSuccess()) {
        echo implode('<br>', $updateResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::ов метода обновит вкладку
    $tab['ACTIVE'] = 1;

    $updateResult = $tab->save();

    if (!$updateResult->isSuccess()) {
        echo implode('<br>', $updateResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader::ов метода добавит вкладку
    unset($tab['ID']);
    $tab['CODE'] = 'NEW_TAB_CODE';

    $addResult = $tab->save();

    if (!$addResult->isSuccess()) {
        echo implode('<br>', $addResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\TabMapper;

Loader:: (!$deleteResult->isSuccess()) {
    echo implode('<br>', $deleteResult->getErrorMessages());
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\Field;

Loader::'1',
    'UF' => [
        'FIELD_NAME' => 'UF_RECAPTCHA_SECRET',
        'USER_TYPE_ID' => 'string',
        'XML_ID' => '',
        'SORT' => '500',
        'MULTIPLE' => 'N',
        'MANDATORY' => 'N',
        'SETTINGS' => [
            'SIZE' => 60,
            'ROWS' => 1,
            'REGEXP' => '',
            'MIN_LENGTH' => 0,
            'MAX_LENGTH' => 0,
            'DEFAULT_VALUE' => '',
        ],
        'EDIT_FORM_LABEL' => ['en' => '', 'ru' => 'Приватный ключ reСaptcha v3',],
        'HELP_MESSAGE' => ['en' => '', 'ru' => 'Используется для reСaptcha v3',],
    ],
]);

$addResult = $field->add();

if (!$addResult->isSuccess()) {
    echo implode('<br>', $addResult->getErrorMessages());
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::'ACTIVE' => 1,
    ],
    'order' => [
        'ID' => 'DESC',
    ],
]);

foreach ($fieldCollection as $field) {
    // Do something
}
unset($field);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader:: 'ID' => 'DESC',
    ],
]);

foreach ($fieldCollection as $field) {
    // Do something
}
unset($field);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::$field['ID'];
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::ction as $field) {
    // Do something
}
unset($field);

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::ld) {
    echo $field['ID'];
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::d['ACTIVE'] = 0;

    $updateResult = $field->update();

    if (!$updateResult->isSuccess()) {
        echo implode('<br>', $updateResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::ызов метода обновит поле
    $field['ACTIVE'] = 1;

    $updateResult = $field->save();

    if (!$updateResult->isSuccess()) {
        echo implode('<br>', $updateResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::ызов метода добавит поле
    unset($field['ID']);
    unset($field['UF_ID']);
    unset($field['UF']['ID']);
    $field['UF']['FIELD_NAME'] = 'UF_NEW_FIELD';

    $addResult = $field->save();

    if (!$addResult->isSuccess()) {
        echo implode('<br>', $addResult->getErrorMessages());
    }
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;

Loader::

if (!$deleteResult->isSuccess()) {
    echo implode('<br>', $deleteResult->getErrorMessages());
}

use \Bitrix\Main\Loader;
use \Fi1a\UserSettings\FieldMapper;
use \Fi1a\UserSettings\Helpers\Enums;

Loader::

use \Bitrix\Main\Event;
use \Bitrix\Main\Loader;
use \Bitrix\Main\EventManager;
use \Bitrix\Main\EventResult;
use \Fi1a\UserSettings\Option;

Loader::lt(
            EventResult::SUCCESS,
            [
                'default' => 'new default value',
            ]
        );
    }
);

// Если поле имеет значение null или false, вместо 'foo' вернется значение 'new default value'
Option::getInstance()->get('UF_RECAPCHA_SECRET', 'foo');
create(array $input = []): TabInterface
create(array $input = []): FieldInterface