Bitrix Framework

Bitrix Framework has several specific core settings that do not have an edit interface. Such design choice is due to occurrences when settings update or error in them can easily lead to rendering the whole system inoperable (due to database connection setting, caching settings and etc.).

Settings in a Core D7 are entered in the file /bitrix/.settings.php. Please be advised, that in the old core/kernel similar settings were made in the file \bitrix\php_interface\dbconn.php. The file .settings.php differs significantly from the former dbconn.php in terms of structure.

Parameters can be edited via the Configuration class (Bitrix\Main\Config\Configuration).

In addition, these settings can be specified in the file .settings_extra.php. Basic settings file contains invariable settings, with available API. File .settings_extra.php can contain arbitrary code that changes settings dynamically. Accordingly, it doesn't have API functions.

Below are parameters that can be modified:

Parameters that may be changed are described below:

Cache Section

Responsible for caching settings and permits to set the caching method and its parameters.

  'cache' => array (
    'value' => array (
      'type' => 'files',
    ),
    'readonly' => false,
  ),

In the version 18.5.200 the record format was updated simultaneously with the option to use Redis in caching. Presently, both formats are operational, however vendor strongly recommends to use new record format.

'cache' => array(        'value' => array(
          'type' => array(
              'class_name' => '\\Bitrix\\Main\\Data\\CacheEngineRedis',
              'extension' => 'redis'
          ),
          'redis' => array(
              'host' => '127.0.0.1',
              'port' => '6379',
          ),
          'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
      ),

  ),

  'cache' => array(
      'value' => array(
          'type' => array(
              'class_name' => '\\Bitrix\\Main\\Data\\CacheEngineMemcache',
              'extension' => 'memcache'
          ),
          'memcache' => array(
              'host' => '127.0.0.1',
              'port' => '11211',
          ),
          'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
      ),
  ),

  'cache' => array(
      'value' => array(
          'type' => array(
              'class_name' => '\\Bitrix\\Main\\Data\\CacheEngineApc',
              'extension' => 'apc'
          ),
          'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
      ),
  ),

  'cache' => array(
      'value' => array(
          'type' => array('class_name' => '\\Bitrix\\Main\\Data\\CacheEngineFiles',),
          'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
      ),
  ),

  'cache' => array(
      'value' => array(
          'type' => array(
              'class_name' => '\\Bitrix\\Main\\Data\\CacheEngineXCache',
              'extension' => 'xcache'
          ),
          'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
      ),
  ),

'cache_flags'=>   array(
      'value'=> array(
         "b_group_max_ttl" => 200,
         "b_group_min_ttl" => 100,
      )
   ),

<?php
return array (
  'cache' => array(
     'value' => array (
		'type' => 'memcache',
		'memcache' => array(
			'host' => 'unix:///tmp/memcached.sock',
			'port' => '0'
		),
		'sid' => $_SERVER["DOCUMENT_ROOT"]."#01"
     ),
  ),
);
?>

Section exception_handling

Responsible for exception handling.

  'exception_handling' => array (
    'value' => array (
      'debug' => false,
      'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE,
      'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING & ~E_DEPRECATED,
      'ignore_silence' => false,
      'assertion_throws_exception' => true,
      'assertion_error_type' => 256,
      'log' => array (
        'settings' => array (
          'file' => 'bitrix/modules/error.log',
          'log_size' => 1000000,
        ),
      ),
    ),
    'readonly' => false,
  ),

'log' => array (
   'settings' => array (
      'file' => 'bitrix/modules/error.log',
      'log_size' => 1000000,
   ),
),

'log' => array(
   'class_name' => 'MyLog', // custom log class, must extends ExceptionHandlerLog; 
                            // can be omited, in this case default Diag\FileExceptionHandlerLog will be used
   'extension' => 'MyLogExt', // php extension, is used only with 'class_name'
   'required_file' => 'modules/mylog.module/mylog.php' // included file, is used only with 'class_name'
   'settings' => array( // any settings for 'class_name'
      ),
),

Error type must be passed in handled_errors_types, exception_errors_types, assertion_error_type. Error type is a numerical code. For example, parameter exception_errors_types. And what does such record means: E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING?

First, let's refer to levels of PHP error interpreter. There are specific values and determined constants matching them. In our case, this record means that E_ALL (constant value 2047), is bit-wise and not E_NOTICE, and not E_WARNING and not E_STRICT and not E_USER_WARNING and not E_USER_NOTICE and not E_COMPILE_WARNING. That is E_ALL with exception of previosuly specified constants that define one or the other PHP interpreter error level.

Connections section

Database and other data source connection parameters. The class name and connection parameters are specified.

'connections' => array (
        'value' => array (
            'default' => array (
                'className' => '\\Bitrix\\Main\\DB\\MysqlConnection',
                'host' => 'localhost:31006',
                'database' => 'admin_bus',
                'login' => 'admin_bus',
                'password' => 'admin_bus',
                'options' => 2,
                'handlersocket' => array (
                    'read' => 'handlersocket',
                ),
            ),
            'handlersocket' => array (
                'className' => '\\Bitrix\\Main\\Data\\HsphpReadConnection',
                'host' => 'localhost',
                'port' => '9998',
            ),
        ),
        'readonly' => true,
    ),

'className' => '\\Bitrix\\Main\\DB\\MysqliConnection'. 

Root section

General settings are located in the root section.

Pull section

This section is specifically required only for hosting partners (for deployment automation). For the rest, its recommended to use the setup via administrative control panel interface.

'pull' => Array(
       'value' =>  array(
           'path_to_listener' => "http://#DOMAIN#/bitrix/sub/";,
           'path_to_listener_secure' => "https://#DOMAIN#/bitrix/sub/";,
           'path_to_modern_listener' => "http://#DOMAIN#/bitrix/sub/";,
           'path_to_modern_listener_secure' => "https://#DOMAIN#/bitrix/sub/";,
           'path_to_mobile_listener' => "http://#DOMAIN#:8893/bitrix/sub/";,
           'path_to_mobile_listener_secure' => "https://#DOMAIN#:8894/bitrix/sub/";,
           'path_to_websocket' => "ws://#DOMAIN#/bitrix/subws/",
           'path_to_websocket_secure' => "wss://#DOMAIN#/bitrix/subws/",
           'path_to_publish' => 'http://127.0.0.1:8895/bitrix/pub/',
           'nginx_version' => '3',
           'nginx_command_per_hit' => '100',
           'nginx' => 'Y',
           'nginx_headers' => 'N',
           'push' => 'Y',
           'websocket' => 'Y',
           'signature_key' => '1111111111',
           'signature_algo' => 'sha1',
           'guest' => 'N',
       ),
   ),

  'http_client_options' =>
   array (
     'value' =>
        array (
         'redirect' => true,//execute redirects, if required
         'redirectMax' => 10,//but not more than 10
         'version' => '1.1'//work via the http 1.1 protocol 
        ),
     'readonly' => false,
   ),

use Bitrix\Main\Config\Configuration;
print_r(Configuration::getValue("http_client_options"));