### Agent Operations: Start and Install (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Methods for managing agents, including starting an agent and performing installation steps. `installNextStep()` is part of the installation process.

```PHP
Agent::start()
Agent::install()
Agent::installNextStep()
```

--------------------------------

### Start Docker Containers

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

This command starts the Docker containers defined in the docker-compose.yml file, launching the Bitrix environment. Ensure Docker and Docker Compose are installed and the env-docker repository has been cloned.

```shell
cd ./env-docker
docker compose up -d
```

--------------------------------

### Clean Installation - Remove Index File

Source: https://docs.1c-bitrix.ru/pages/get-started/install-solution

To perform a clean installation without a solution, close the installation wizard and remove the 'index.php' file from the website's root directory. This action is specific to the 1C-Bitrix: Site Management installer.

```shell
rm index.php
```

--------------------------------

### Configure 1C-Bitrix with .settings.php (PHP)

Source: https://docs.1c-bitrix.ru/pages/get-started/install-distr

This PHP code snippet demonstrates how to configure 1C-Bitrix using the .settings.php file for a quick installation. It covers settings for character encoding, caching, cookies, error handling, and database connections.

```PHP
<?php
return array (
    // настройки кодировки сайта
    'utf_mode' => array (
        'value' => true, // кодировка сайта, true для UTF-8
        'readonly' => true,
    ),
    // настройки кеширования
    'cache_flags' => array (
        'value' => array (
            'config_options' => 3600, // время кэширования настроек сайта в секундах
            'site_domain' => 3600, // время кэширования настроек домена
        ),
        'readonly' => false,
    ),
    // Параметры cookies
    'cookies' => array (
        'value' => array (
            'secure' => false, // использовать защищенное соединение HTTPS
            'http_only' => true, // разрешать доступ только через HTTP
        ),
        'readonly' => false,
    ),
    // настройки обработки ошибок
    'exception_handling' => array 
        'value' => array (
            'debug' => false, // режим отладки
            'handled_errors_types' => 4437, // типы обрабатываемых ошибок
            'exception_errors_types' => 4437, // типы исключений
            'ignore_silence' => false, // игнорировать @-оператор
            'assertion_throws_exception' => true, // преобразовывать assert в исключения
            'assertion_error_type' => 256, // тип ошибки для assert
            'log' => array ( // настройки логирования
                'settings' => array (
                    'file' => '/var/log/php/exceptions.log', // путь к лог-файлу
                    'log_size' => 1000000, // максимальный размер лога
                ),
            ),
        ),
        'readonly' => false,
    ),
    // Настройки подключения к базе данных
    'connections' => array (
        'value' => array (
            'default' => array (
                'className' => '\\Bitrix\\Main\\DB\\MysqliConnection', // драйвер БД
                'host' => 'localhost', // адрес сервера БД
                'database' => 'sitemanager0', // имя БД
                'login' => 'root', // пользователь БД
                'password' => '', // пароль пользователя
                'options' => 2, // дополнительные опции
            ),
        ),
        'readonly' => true,
    )
);

```

--------------------------------

### Install ImBot Support24 Session Command

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Installs a session command for the Support24 bot in the ImBot module. This is part of the setup or update process for the bot's functionality.

```PHP
\Bitrix\Imbot\Update\Agent::installSupport24SessionCommand()
```

--------------------------------

### PHP Namespace Example - Bitrix

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-perfmon

Demonstrates the usage of namespaces in PHP within the Bitrix framework. This example typically involves defining and using namespaces for organizing code and avoiding naming conflicts. It requires the Bitrix environment to be set up.

```php
<?php

namespace Bitrix\MyModule;

class MyClass {
    public function sayHello() {
        echo 'Hello from MyModule!';
    }
}

?>

```

--------------------------------

### Download and Prepare bitrixsetup.php Script (bitrix user)

Source: https://docs.1c-bitrix.ru/pages/get-started/install-distr

This snippet demonstrates downloading the `bitrixsetup.php` script using `wget` when logged in as the `bitrix` user. This is a simpler process as ownership does not need to be changed. Navigate to the web root directory before executing.

```shell
cd /home/bitrix/www/ # переходим в корневую папку сайта
wget https://www.1c-bitrix.ru/download/scripts/bitrixsetup.php # скачиваем скрипт
```

--------------------------------

### Download 1C-Bitrix Distribution Archive

Source: https://docs.1c-bitrix.ru/pages/get-started/install-distr

This command downloads the 1C-Bitrix distribution archive (`business_encode.tar.gz`) to the specified web root directory using `wget`. After downloading, the archive needs to be extracted.

```shell
cd /home/bitrix/www/ # переходим в папку сайта
wget https://www.1c-bitrix.ru/download/business_encode.tar.gz # скачиваем дистрибутив по ссылке
```

--------------------------------

### Bitrix CRM Automation Demo Wizard Install/Uninstall

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Provides methods for installing and uninstalling a simple CRM setup within the Bitrix CRM automation demo wizard.

```PHP
Wizard::installSimpleCRM()
```

```PHP
Wizard::unInstallSimpleCRM()
```

--------------------------------

### Download and Prepare bitrixsetup.php Script (root user)

Source: https://docs.1c-bitrix.ru/pages/get-started/install-distr

This snippet shows how to download the `bitrixsetup.php` script using `wget` and change its ownership to the `bitrix` user. This is necessary for the web server to access the script. Ensure you are in the correct web root directory.

```shell
cd /home/bitrix/www/ # переходим в корневую папку сайта
wget https://www.1c-bitrix.ru/download/scripts/bitrixsetup.php # скачиваем скрипт
chown bitrix:bitrix bitrixsetup.php # меняем владельца файла на пользователя bitrix
```

--------------------------------

### Session Command Installation - agent.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Installs a support session command for agents. This function is relevant for background tasks or agent-specific functionalities that require session management.

```php
Agent::installSupport24SessionCommand();
```

--------------------------------

### SQL Namespace Example - Bitrix

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-perfmon

Illustrates the concept of namespaces or schema usage in SQL within the context of Bitrix. This example might show how to reference tables or functions within a specific database schema. It assumes a SQL database connected to Bitrix.

```sql
-- Example of referencing a table within a specific schema
SELECT * FROM `b_user`;

-- If Bitrix uses specific schemas, it might look like this:
-- SELECT * FROM `bitrix_schema`.`users`;

```

--------------------------------

### Download bitrixsetup.php Script

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

This snippet downloads the bitrixsetup.php script into the website's 'www' directory within the PHP container. It requires access to the Docker container's shell and the 'wget' utility. The script is used for the initial setup of Bitrix.

```shell
# войдите в sh-консоль контейнера php под пользователем bitrix
docker compose exec —user=bitrix php sh 

# перейдите в папку сайта
cd /opt/www/ 

# скачайте скрипт для установки продукта
wget https://www.1c-bitrix.ru/download/scripts/bitrixsetup.php 

```

--------------------------------

### Clone env-docker Repository

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

This snippet clones the official env-docker repository from GitHub to set up a containerized environment for Bitrix. It requires Git to be installed on the local machine.

```shell
cd my-project # перейдите в папку проекта
git clone https://github.com/bitrix-tools/env-docker.git # склонируйте репозиторий
```

--------------------------------

### Wizard CRM Installation and Uninstallation

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

The Wizard class contains methods for installing and uninstalling simple CRM functionalities. These methods are part of the setup and teardown process for CRM features.

```php
<?php

class Wizard
{
    /**
     * Installs the simple CRM.
     */
    public static function installSimpleCRM()
    {
        // ... implementation ...
    }

    /**
     * Uninstalls the simple CRM.
     */
    public static function unInstallSimpleCRM()
    {
        // ... implementation ...
    }
}

```

--------------------------------

### Template Replication: Start and Stop (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Methods for controlling the replication process within a template. These methods are part of the Template class functionality.

```PHP
Template::startReplication()
Template::stopReplication()
```

--------------------------------

### Extract Tarball Archive

Source: https://docs.1c-bitrix.ru/pages/get-started/install-distr

This command extracts a `.tar.gz` archive, which is commonly used for distributing software like 1C-Bitrix. The `tar` command with the `-xf` flags is used to extract the files from the archive into the current directory.

```shell
tar -xf business_encode.tar.gz
```

--------------------------------

### Utility Methods for Data Management and Configuration (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This section covers utility methods for managing data, configurations, and application-specific logic. It includes methods for initializing pagination, getting unique fields, and checking access manifests, with notes on replacements or specific use cases.

```php
Entity::getUField()

```

```php
Entity::hasUField()

```

```php
Application
use \Bitrix\Rest\APAuth\PasswordTable
```

--------------------------------

### Bitrix Controller with Validation and Rendering

Source: https://docs.1c-bitrix.ru/index

This PHP code defines a Bitrix controller class that handles GET requests. It utilizes attribute-based validation (#[NotEmpty]) for input parameters and demonstrates rendering views or components based on the result of a service call. It includes error handling for cases where an entity is not found.

```php
namespace Demo\Module\Controller;

use Bitrix\Main\Engine\Controller;
use Bitrix\Main\Validation\Rule\NotEmpty;

class Post extends Controller
    {
    public function getAction(
        #[NotEmpty]
        string $code,
        PostService $service,
    )
    {
        $entity = $service->getByCode($code);
        if (!$entity)
        {
        return $this->renderComponent('demo:error', params: [
            'message' => Loc::getMessage('POST_NOT_FOUND'),
        ]);
        }

        return $this->renderView('posts/view', [
        'entity' => $entity,
        ]);
    }
}
```

--------------------------------

### Define BX_PULL_SKIP_INIT Constant in PHP

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-bizproc

This snippet defines the public constant BX_PULL_SKIP_INIT as true. This constant is likely used to control the initialization process of a pull mechanism, potentially for skipping certain setup steps in the disk module. It is defined within the publicpullconfigurator.php file.

```php
public const BX_PULL_SKIP_INIT = true;
```

--------------------------------

### Query Builder Compatibility and Options (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

References `Compatible` and `QueryBuilderOptions` classes within the `SecurityQueryBuilder` namespace. `Compatible` likely deals with query building compatibility, while `QueryBuilderOptions` provides methods for getting limits and checking union distinct usage.

```php
namespace Bitrix\Crm\Security\QueryBuilder\Compatible;

class Compatible
{
    // ... methods and properties ...
}

namespace Bitrix\Crm\Security\QueryBuilder\QueryBuilderOptions;

class QueryBuilderOptions
{
    public function getLimitByIds(array $ids)
    {
        // ... returns limits by IDs ...
    }

    public function needUseDistinctUnion(): bool
    {
        // ... returns true if distinct union is needed ...
        return false;
    }
}
```

--------------------------------

### Show Stepper for Landing Updates

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Displays a stepper interface for managing updates within the Landing module. This provides a guided, step-by-step update process for users.

```PHP
\Bitrix\Landing\Update\Stepper::show()
```

--------------------------------

### Get Plan Details in 1C-Bitrix AI Module

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Fetches general plan information from the 1C-Bitrix AI Limiter component. This method is used to retrieve available plan configurations.

```php
<?php

// Assuming the existence of the Plan class and its get method
// $planDetails = \Bitrix\AI\Limiter\Plan::get();

// Example usage (conceptual):
class Plan {
    public static function get() {
        // Implementation to fetch all plan details
        return []; // Placeholder
    }
}
```

--------------------------------

### Bitrix Catalog SearchHandlers Class Overview

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-catalog

The SearchHandlers class in the Bitrix Catalog module provides various useful methods for product search operations. It is part of the core catalog functionality for handling search-related tasks. No specific dependencies or input/output examples are provided in this documentation snippet.

```php
Class Search Provides various useful methods for product search.
```
Loading…
```

×
**On this page**
  * Table Of Contents
  *     * Classes


## Search results
__


__
  *[Access]: \Bitrix\Catalog\Access
  *[Compatible]: \Bitrix\Catalog\Compatible
  *[Component]: \Bitrix\Catalog\Component
  *[Config]: \Bitrix\Catalog\Config
  *[Controller]: \Bitrix\Catalog\Controller
  *[Discount]: \Bitrix\Catalog\Discount
  *[Document]: \Bitrix\Catalog\Document
  *[Ebay]: \Bitrix\Catalog\Ebay
  *[EventDispatcher]: \Bitrix\Catalog\EventDispatcher
  *[Filter]: \Bitrix\Catalog\Filter
  *[Grid]: \Bitrix\Catalog\Grid
  *[Helpers]: \Bitrix\Catalog\Helpers
  *[Integration]: \Bitrix\Catalog\Integration
  *[Model]: \Bitrix\Catalog\Model
  *[Product]: \Bitrix\Catalog\Product
  *[Restriction]: \Bitrix\Catalog\Restriction
  *[RestView]: \Bitrix\Catalog\RestView
  *[Store]: \Bitrix\Catalog\Store
  *[UI]: \Bitrix\Catalog\UI
  *[Update]: \Bitrix\Catalog\Update
  *[Url]: \Bitrix\Catalog\Url
  *[UserField]: \Bitrix\Catalog\UserField
  *[v2]: \Bitrix\Catalog\v2
  *[EbayXMLer]: \Bitrix\Catalog\EbayXMLer
  *[ExportOffer]: \Bitrix\Catalog\ExportOffer
  *[ExportOfferCreator]: \Bitrix\Catalog\ExportOfferCreator
  *[ExportOfferSKU]: \Bitrix\Catalog\ExportOfferSKU
  *[SearchHandlers]: \Bitrix\Catalog\SearchHandlers
```

--------------------------------

### Get User Preset Configuration

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves a user-specific preset configuration from the IM module. This allows for personalized settings and preferences.

```PHP
\Bitrix\Im\Configuration\Configuration::getUserPreset()
```

--------------------------------

### Integration Module Check (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Checks if a specific integration module is installed within the system. This is a utility method for integration purposes.

```PHP
Integration::checkModuleInstalled()
```

--------------------------------

### Get Iblock Parameters for Landing Component

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves iblock parameters for a component used in the Landing module. This is essential for configuring components that display iblock information.

```PHP
\Bitrix\Landing\Node\Component::getIblockParams()
```

--------------------------------

### Storage Safe URL Methods and Alternative

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Methods in the Storage class for getting safe URLs: getB2eMySafeUrl() and getProfileSafeUrl(). Both are noted to 'use url generator', indicating a preferred method for URL creation.

```PHP
Storage::getB2eMySafeUrl()
// use url generator

Storage::getProfileSafeUrl()
// use url generator
```

--------------------------------

### Collection Management: Get All, Add Errors, Check Errors (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Methods for managing collections of items, including retrieving all items, adding foreign errors, and checking for errors. `getAll()` is noted as non-architecture-friendly. `checkHasErrors()` suggests using `.isEmpty()`.

```PHP
Collection::getAll()
Collection::addForeignErrors()
Collection::checkHasErrors()
Collection::getFatals()
Collection::getWarnings()
Collection::TYPE_FATAL
Collection::TYPE_WARNING
```

--------------------------------

### Get Trial Hint for Address Type

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves a trial hint message for the address type functionality. This is likely used for user guidance or feature explanation.

```PHP
\Bitrix\Fileman\UserField\Types\AddressType::getTrialHint()
```

--------------------------------

### Скачивание скрипта установки 1С-Битрикс в Docker

Source: https://docs.1c-bitrix.ru/index

Команды для входа в контейнер PHP и скачивания скрипта bitrixsetup.php с официального сайта. Используется `docker compose exec` и `wget`.

```bash
docker compose exec —user=bitrix php sh
cd /opt/www/
wget https://www.1c-bitrix.ru/download/scripts/bitrixsetup.php
```

--------------------------------

### Get Detail Page Show Properties for Iblock

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves properties to be shown on the detail page for iblock elements. This function is part of configuring how iblock data is displayed.

```PHP
\Bitrix\Iblock\Model\PropertyFeature::getDetailPageShowProperties()
```

--------------------------------

### Get License Plan in 1C-Bitrix AI Module

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves plan details based on a license key within the 1C-Bitrix AI Limiter component. This function is crucial for managing AI service limitations per license.

```php
<?php

// Assuming the existence of the Plan class and its getByLicense method
// $licenseKey = 'YOUR_LICENSE_KEY';
// $plan = \Bitrix\AI\Limiter\Plan::getByLicense($licenseKey);

// Example usage (conceptual):
class Plan {
    public static function getByLicense($licenseKey) {
        // Implementation to fetch plan details based on license key
        return null; // Placeholder
    }
}
```

--------------------------------

### Task Management: Find and Get Tasks (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves a list of tasks, with access rights checked internally. The `find()` method is available since tasks version 21.200.0.

```PHP
Task::find()
Task::getList()
```

--------------------------------

### Скачивание и запуск скрипта установки BitrixEnv

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

Команда для скачивания скрипта установки BitrixEnv (`bitrix-env-9.sh`) с помощью wget, предоставления ему прав на выполнение и последующего запуска. Скрипт используется для настройки окружения на выделенном сервере.

```bash
wget http://repo.bitrix24.tech/dnf/bitrix-env-9.sh && chmod +x bitrix-env-9.sh && ./bitrix-env-9.sh

```

--------------------------------

### Get Intranet Menu REST Placement Map

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves the REST placement map for the intranet menu. This constant defines available locations for REST integrations within the menu system.

```PHP
\Bitrix\Intranet\Binding\Menu::REST_PLACEMENT_MAP
```

--------------------------------

### Запуск меню управления окружением

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

Команда для запуска интерактивного меню управления окружением BitrixEnv и BitrixVM. Пользователь может выбирать пункты меню для настройки или управления окружением.

```bash
/root/menu.sh

```

--------------------------------

### Get Iblock URL for Landing Component

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Gets the iblock URL for a component within the Landing module. This function helps in linking landing page elements to iblock data.

```PHP
\Bitrix\Landing\Node\Component::getIblockURL()
```

--------------------------------

### Перезагрузка сервера

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

Команда для перезагрузки сервера. Используется после применения настроек, требующих перезагрузки, например, при отключении SELinux.

```bash
reboot

```

--------------------------------

### Disk File Controller: Get Metadata for UF Action

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This static method, `getMetaDataForCreatedFileInUfAction`, is used within the Disk module's file controller to retrieve metadata for a file created via a UF (User Field) action. It belongs to the `BitrixDiskControllerFile` class.

```PHP
<?php

use Bitrix\Disk\Controller\File;

// Get metadata for a file created in UF action
// $fileId = 123;
// $metaData = File::getMetaDataForCreatedFileInUfAction($fileId);

```

--------------------------------

### Обновление и установка пакетов в CentOS Stream 9

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

Команды для очистки кэша DNF, обновления пакетов системы и установки утилиты wget. Эти команды необходимы для подготовки сервера к установке BitrixEnv.

```bash
dnf clean all && dnf update

```

```bash
dnf install wget

```

--------------------------------

### MailInvitationManager Functionality Change

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

The MailInvitationManager has been updated, and its mailing functionality now relies on calendar/lib/core/queue/agent/sendingemailnotificationagent.php. This change was implemented starting from June 2023.

```php
<?php

// From 06.2023 Mailing functionality now uses calendar/lib/core/queue/agent/sendingemailnotificationagent.php
class MailInvitationManager
{
    // ... methods ...
}

```

--------------------------------

### Get Top Department ID

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves the ID of the top-level department in the IM module. This is fundamental for organizational structure representation.

```PHP
\Bitrix\Im\Configuration\Department::getTopDepartmentId()
```

--------------------------------

### Тихая установка BitrixEnv с параметрами

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

Пример команды для выполнения тихой установки BitrixEnv с указанием различных параметров: создание пула, установка Push-сервера, задание имени хоста, выбор версии Percona Server и установка пароля для root MySQL. Параметр `-s` включает тихий режим без запросов.

```bash
./bitrix-env-9.sh -s -p -H server1 -P -m 8.4 -M 'BX123bx@#MYSQL'

```

--------------------------------

### Запуск контейнеров Docker для 1С-Битрикс

Source: https://docs.1c-bitrix.ru/index

Команда для запуска Docker-контейнеров в фоновом режиме. Требует предварительной настройки параметров в файлах .env_sql и .env_push.

```bash
docker compose up -d
```

--------------------------------

### Download bitrix_server_test.php Script

Source: https://docs.1c-bitrix.ru/pages/get-started/install-env

This snippet downloads the bitrix_server_test.php script to the website's root directory. This script is used to verify the server configuration for 1C-Bitrix. It requires shell access to the server and the 'wget' utility.

```shell
cd /home/bitrix/www/ # переходим в корневую папку сайта
wget https://dev.1c-bitrix.ru/download/scripts/bitrix_server_test.php # скачиваем скрипт

```

--------------------------------

### Клонирование репозитория Docker-образа 1С-Битрикс

Source: https://docs.1c-bitrix.ru/index

Команда для склонирования официального репозитория Docker-образа 1С-Битрикс. Используется стандартная команда Git.

```bash
cd my-project
git clone https://github.com/bitrix-tools/env-docker.git
```

--------------------------------

### Get User Phone Device Information

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves phone device information for a user within the IM module. This is useful for presence and communication management.

```PHP
\Bitrix\Im\V2\Entity\User\User::getPhoneDevice()
```

--------------------------------

### Helper Methods for Engine and Cache - Helper.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Contains helper methods for enabling/disabling features and cleaning cache. `Helper::setEnabled()` suggests using `Engine::install` and `Engine::uninstall`, while `Helper::cleanAll()` recommends using `BitrixMainCompositePage::getInstance(); $page->deleteAll();` for comprehensive cache clearing.

```php
Helper::setEnabled();
Helper::cleanAll();
```

--------------------------------

### Управление группами пользователей 1С-Битрикс (PHP)

Source: https://docs.1c-bitrix.ru/index

Примеры кода для работы с группами пользователей в 1С-Битрикс, включая получение списка групп, добавление и удаление пользователей из групп. Используются статические методы класса CUser.

```php
// Получить список групп пользователя
$groups = CUser::GetUserGroup(234);

// Добавить пользователя в группы
CUser::AppendUserGroup(234, [
    // идентификатор группы
    3,
    // срок участия пользователя в группе
    [
      'GROUP_ID' => 3,
      'DATE_ACTIVE_FROM' => '01.01.2025',
      'DATE_ACTIVE_TO' => '01.12.2025',
    ],
]);

// Удалить пользователя из группы
CUser::RemoveUserGroup(234, [
    // идентификаторы групп
    3,
    4,
]);
```

--------------------------------

### Access Control: Get Available Operations (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves a list of available operations for access control. This functionality has been available since tasks version 20.6.0.

```PHP
Access::getAvailableOperations()
```

--------------------------------

### Контроллер прав доступа 1С-Битрикс (PHP)

Source: https://docs.1c-bitrix.ru/index

Пример реализации контроллера прав доступа на основе ABAC в 1С-Битрикс. Включает создание класса контроллера и внедрение логики проверки прав в методы контроллера.

```php
use Bitrix\Main\Access\AccessibleItem;
use Bitrix\Main\Access\BaseAccessController;
use Bitrix\Main\Access\User\AccessibleUser;

final class PostAccessController extends BaseAccessController
{
    protected function loadItem(int $itemId = null): ?AccessibleItem
    {
        return $itemId ? MyPost::loadById($itemId) : null;
    }

    protected function loadUser(int $userId): AccessibleUser
    {
        return MyUser::loadById($userId);
    }
}

use Bitrix\Main\Engine\CurrentUser;

final class MyController
{
    public function getAction(int $id, CurrentUser $user, PostAccessController $access)
    {
        if ($access->can($user->getId(), 'view', $id))
        {
            // есть доступ
        }
    }
    
    public function listAction(PostAccessController $access)
    {
        $query = MyPost::query();
        
        $filter = $access->getEntityFilter(
            'view',
            $query->getEntity()->getObjectClassName()
        );
        if ($filter)
        {
            $query->addFilter($filter);
        }
        
        $rows = $query->fetchCollection();
    }
}
```

--------------------------------

### URL and REST API Related Utilities (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This section documents methods and constants related to URL manipulation and REST API interactions. It includes methods for getting service URLs, placement URLs, and checks for private IP addresses, with notes on deprecation or intended usage.

```php
UrlPreview::isIpAddressPrivate()
Will be removed.
```

```php
Transport::SERVICE_URL
use Transport()->getServiceUrl()
```

```php
Url::getApplicationPlacementUrl()
use \Bitrix\Rest\Url\DevOps->getPlacementUrl()
```

--------------------------------

### HTML Structure for Bitrix API Documentation

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-biconnector

This is the basic HTML structure for the Bitrix API documentation page. It includes meta tags, links to stylesheets (including PrismJS for code highlighting), and script includes for search functionality and templates.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
            <title>Bitrix API</title>
    
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <base href="./">
    <link rel="icon" href="images/favicon.ico"/>
    <link rel="stylesheet" href="css/normalize.css">
    <link rel="stylesheet" href="css/base.css">
            <link rel="preconnect" href="https://fonts.gstatic.com">
        <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
        <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
        <link rel="stylesheet" href="css/template.css">
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
                <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
        <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
        <script src="js/template.js"></script>
        <script src="js/search.js"></script>
        <script defer src="js/searchIndex.js"></script>
    </head>
<body id="top">
    <header class="phpdocumentor-header phpdocumentor-section">
    <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Bitrix API</a></h1>
    <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
    <label class="phpdocumentor-header__menu-icon" for="menu-button">
        <i class="fas fa-bars"></i>
    </label>
    <section data-search-form class="phpdocumentor-search">
    <label>
        <span class="visually-hidden">Search for</span>
        <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
            <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
            <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
        </svg>
        <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
    </label>
</section>

    <nav class="phpdocumentor-topnav">
    <ul class="phpdocumentor-topnav__menu">
        </ul>
</nav>
</header>

    <main class="phpdocumentor">
        <div class="phpdocumentor-section">
            <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
    Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
                    <section class="phpdocumentor-sidebar__category -namespaces">
            <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
                                    <h4 class="phpdocumentor-sidebar__root-namespace">
    <a href="namespaces/bitrix.html" class="">Bitrix</a>
</h4>
    <ul class="phpdocumentor-list">
                    <li>
                <a href="namespaces/bitrix-advertising.html" class="">Advertising</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-ai.html" class="">AI</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-biconnector.html" class="">BiConnector</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-bizproc.html" class="">Bizproc</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-bizprocmobile.html" class="">BizprocMobile</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-blog.html" class="">Blog</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-booking.html" class="">Booking</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-calendar.html" class="">Calendar</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-calendarmobile.html" class="">CalendarMobile</a>
                
            </li>
                    <li>
                <a href="namespaces/bitrix-call.html" class="">Call</a>
                
            </li>
                    <li>

```

--------------------------------

### Manage Discount Modules and Entity Types in 1C-Bitrix

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This snippet covers retrieving discount modules and accessing entity type constants within 1C-Bitrix's internal order discount and rules tables. It shows how to get associated discount modules and references constants like `ENTITY_TYPE_BASKET`, which are crucial for categorizing and managing discounts applied to different parts of an order.

```PHP
namespace Bitrix\Sale\Internals;

// Get discount modules for a specific discount
$discountModules = OrderDiscountTable::getDiscountModules($discountId);

// Access entity type constant for basket
$basketEntityTypeOrderDiscount = OrderDiscountDataTable::ENTITY_TYPE_BASKET;
$basketEntityTypeOrderRules = OrderRulesTable::ENTITY_TYPE_BASKET;
```

--------------------------------

### Get Original Form Domain for Landing Subtype

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves the original domain of a form used in the Landing module's subtype. This is useful for form migration or domain management.

```PHP
\Bitrix\Landing\Subtype\Form::getOriginalFormDomain()
```

--------------------------------

### Управление пользователями 1С-Битрикс (PHP)

Source: https://docs.1c-bitrix.ru/index

Примеры кода для выполнения основных операций с пользователями в 1С-Битрикс, таких как проверка прав, регистрация, блокировка и обновление пароля. Требует наличия объекта CUser.

```php
/**
* @var CUser $USER
*/

// Проверить права на выполнение действий
if ($USER->CanDoOperation('edit_file'))
{
    // доступ есть
}

// Зарегистрировать пользователя
$USER->SimpleRegister('user@example.com');

// Заблокировать пользователя
$USER->Update(234, [
    'BLOCKED' => 'Y',
]);

// Потребовать сменить пароль при следующей авторизации
$USER->Update(234, [
    'PASSWORD_EXPIRED' => 'Y',
]);
```

--------------------------------

### Bitrix Sale Delivery Services Table Code by ID

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Replaces Table::getCodeById() with Services\Manager::getCodeById(). This function is used to get the code of a delivery service based on its ID.

```php
use Bitrix\Sale\Delivery\Services; 

// ...
Services\Manager::getCodeById($serviceId);

```

--------------------------------

### Bitrix Sale Delivery Services Table ID by Code

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Replaces Table::getIdByCode() with Services\Manager::getIdByCode(). This function is used to get the ID of a delivery service based on its code.

```php
use Bitrix\Sale\Delivery\Services; 

// ...
Services\Manager::getIdByCode($serviceCode);

```

--------------------------------

### Get Event Type in 1C-Bitrix Calendar Event

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves the event type from a calendar event using the Event class in the 1C-Bitrix Calendar module. This allows for dynamic checking of event categories.

```php
<?php

// Assuming the existence of the Event class and its getEventType method
// $event = new \Bitrix\Calendar\Core\Event\Event();
// $eventType = $event->getEventType();

// Example usage (conceptual):
class Event {
    public function getEventType() {
        // Implementation to return the event type
        return null; // Placeholder
    }
}
```

--------------------------------

### Get Cached Tree in 1C-Bitrix Prompt Manager

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Retrieves a cached tree structure from the 1C-Bitrix Prompt Manager. This is used for efficient access to prompt-related data, potentially for AI or content generation.

```php
<?php

// Assuming the existence of the Manager class and its getCachedTree method
// $tree = \Bitrix\AI\Prompt\Manager::getCachedTree();

// Example usage (conceptual):
class Manager {
    public static function getCachedTree() {
        // Implementation to retrieve cached tree data
        return null; // Placeholder
    }
}
```

--------------------------------

### Deprecated Methods for Pagination and File Size (PHP)

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This section highlights deprecated methods. `initPagination` is replaced by `createPagination` for initializing pagination, and `getFileSize` in `FileEntry` is superseded by `getSize()`.

```php
DeprecatedMethods::initPagination()
use `createPagination` method. Init pagination. If you use pagination, you need to call this method before getting the ORM parameters (`getOrmParams` method).
```

```php
FileEntry::getFileSize()
Use getSize() instead
```

--------------------------------

### Handle ImBot Support24 Welcome Message

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Processes the welcome message for the Support24 bot in the ImBot module. Similar to Partner24, this handles initial user interactions with the support bot.

```PHP
\Bitrix\ImBot\Bot\Support24::onWelcomeMessage()
```

--------------------------------

### Bitrix Rest Auth Client Data Retrieval

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Replaces Auth::get() with the recommended \Bitrix\Rest\Application::getAuthProvider()->get(). This function is used to retrieve authentication-related data within the Bitrix REST API.

```php
use Bitrix\Rest\Application;

// ...
Application::getAuthProvider()->get();
```

--------------------------------

### Welcome Message Processing - partner24.php and support24.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Handles the processing of welcome messages for specific modules ('Partner24' and 'Support24'). These methods are part of the notification or onboarding system, ensuring users receive initial greetings or instructions.

```php
Partner24::onWelcomeMessage();
Support24::onWelcomeMessage();
```

--------------------------------

### Get Event Collection by IDs in 1C-Bitrix Calendar Mapper

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Fetches a collection of calendar events based on their IDs using the Event mapper in the 1C-Bitrix Calendar module. Useful for batch operations or retrieving multiple events at once.

```php
<?php

// Assuming the existence of the Event mapper class and its getCollectionByIds method
// $eventIds = [1, 2, 3];
// $events = \Bitrix\Calendar\Core\Mappers\Event::getCollectionByIds($eventIds);

// Example usage (conceptual):
class Event {
    public static function getCollectionByIds(array $ids) {
        // Implementation to fetch events by IDs
        return []; // Placeholder
    }
}
```

--------------------------------

### Log Tmp Initialization Methods

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

A set of private initialization methods within the Log class for temporary user and group data: __InitUserTmp(), __InitUsersTmp(), __InitGroupTmp(), and __InitGroupsTmp().

```PHP
Log::__InitUserTmp()

Log::__InitUsersTmp()

Log::__InitGroupTmp()

Log::__InitGroupsTmp()
```

--------------------------------

### Dynamic Data Management - Engine.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

Manages dynamic data within the engine, including getting instances, setting/getting prevention of auto-updates, and handling dynamic IDs. These methods are critical for managing dynamic content and rendering on pages.

```php
Engine::getInstance();
Engine::setPreventAutoUpdate();
Engine::getPreventAutoUpdate();
Engine::getDynamicIDs();
Engine::getCurrentDynamicId();
Engine::addDynamicData();
Engine::startDynamicWithID();
Engine::finishDynamicWithID();
```

--------------------------------

### Deprecated Plan Methods in Plan.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

This snippet from Plan.php shows deprecated methods `Plan::getByLicense()` and `Plan::get()`. Developers are advised to use `Plan::createByB24()` instead for license-independent plan creation.

```php
class Plan
{
    /**
     * @deprecated
     */
    public static function getByLicense(string $planId, string $licenseKey): ?self
    {
        // Use Plan::createByB24() instead.
        return null;
    }

    /**
     * @deprecated
     */
    public static function get(string $planId): ?self
    {
        // Use Plan::createByB24() instead.
        return null;
    }

    public static function createByB24(string $planId): ?self
    {
        // Implementation
        return null;
    }
}
```

--------------------------------

### Bitrix API: Get Shipment Collection (PHP)

Source: https://docs.1c-bitrix.ru/api/classes/IShipmentOrder

Retrieves the shipment collection for an order. This method is part of the IShipmentOrder interface in the Bitrix Framework's sale module. It returns a mixed type, typically representing shipment data.

```php
public getShipmentCollection() : mixed
```

--------------------------------

### Menu REST Placement Map - menu.php

Source: https://docs.1c-bitrix.ru/api/reports/deprecated

References `Menu::REST_PLACEMENT_MAP`, noting it should be used as a method instead. This suggests a change in how placement information is accessed or managed within the menu system, moving from a constant to a functional approach.

```php
Menu::REST_PLACEMENT_MAP
```

--------------------------------

### Define BX_PULL_SKIP_INIT Constant (PHP)

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-bizprocmobile

This snippet defines the public constant BX_PULL_SKIP_INIT and sets its value to true. It is found in the disk module and likely used to control initialization behavior for pull configurations, potentially skipping it under certain conditions.

```PHP
<?php

define('BX_PULL_SKIP_INIT', true);
?>
```

--------------------------------

### Constants

Source: https://docs.1c-bitrix.ru/api/namespaces/bitrix-voximplant

This section lists and describes the constants available in the 1c-bitrix_ru project.

```APIDOC
## Constants

### PUBLIC_AJAX_MODE

- **Type**: boolean
- **Description**: Indicates if the AJAX mode is public.
- **Value**: true

### REST_MARKETPLACE_URL

- **Type**: string
- **Description**: URL for the REST marketplace.
- **Value**: ""

### REST_MP_CATEGORIES_CACHE_TTL

- **Type**: integer
- **Description**: Cache time-to-live for REST marketplace categories in seconds.
- **Value**: 86400

### SEO_BITRIX_API_URL

- **Type**: string
- **Description**: API URL for Bitrix SEO.
- **Value**: BITRIX_CLOUD_ADV_URL . "/rest/"

### USE_HTML_STATIC_CACHE

- **Type**: boolean
- **Description**: Flag to enable or disable static HTML caching.
- **Value**: true

### YANDEX_DIRECT_API_URL

- **Type**: string
- **Description**: API URL for Yandex Direct (v4 JSON).
- **Value**: "https://api.direct.yandex.ru/v4/json/"

### YANDEX_DIRECT_LIVE_API_URL

- **Type**: string
- **Description**: API URL for Yandex Direct Live (v4 JSON).
- **Value**: "https://api.direct.yandex.ru/live/v4/json/"

### BITRIX_CLOUD_ADV_URL

- **Type**: string
- **Description**: Base URL for Bitrix Cloud Advanced services.
- **Value**: "https://cloud-adv.bitrix.info"
```