settingscontainer.php

См. документацию.

<?
namespace Bitrix\Sale\Helpers\Order\Builder;
 
use Bitrix\Main\ArgumentOutOfRangeException;
use Bitrix\Main\SystemException;
 
class SettingsContainer
{
    public const BUILDER_SCENARIO_SHIPMENT = 'shipment';
    public const BUILDER_SCENARIO_PAYMENT = 'payment';
    public const BUILDER_SCENARIO_RESERVATION = 'reservation';
 
    const DISALLOW_NEW_USER_CREATION = 0;
    const ALLOW_NEW_USER_CREATION = 1;
    const SET_ANONYMOUS_USER = 2;
 
    private $settings;
 
    protected function getDefaultSettings() : array
    {
        return [
            //Delete clients which is not in the parameters
            'deleteClientsIfNotExists' => false,
 
            //Allow creation new user if it doesn't exist yet.
            'createUserIfNeed' => self::ALLOW_NEW_USER_CREATION,
 
            // Search existing user on creating user
            'searchExistingUserOnCreating' => false,
 
            //Delete tradeBindings which is not in the parameters
            'deleteTradeBindingIfNotExists' => true,
            //Delete basketItems which is not in the parameters
            'deleteBasketItemsIfNotExists' => true,
            //Delete payment which is not in the parameters
            'deletePaymentIfNotExists' => false,
            //Delete shipment which is not in the parameters
            'deleteShipmentIfNotExists' => false,
            //Delete shipmentItem which is not in the parameters
            'deleteShipmentItemIfNotExists' => false,
            //Delete propertyValues which is not in the parameters
            'deletePropertyValuesIfNotExists' => false,
            //Do we need to create a new payment by default, if payments empty?
            'createDefaultPaymentIfNeed' => true,
            //Do we need to create a new shipment by default, if shipments empty?
            'createDefaultShipmentIfNeed' => true,
            //Do we have to clear reserves for a basket item that doesn't explicitly have any reserve data set in it's product data?
            'clearReservesIfEmpty' => false,
 
            //Do we need update the price of just added products.
            //Now it is used only after the buyerId was changed.
            'needUpdateNewProductPrice' => false,
            //Refresh all products data.
            //Now it is used only during order recalculation
            'isRefreshData' => false,
            //For performance purposes
            'cacheProductProviderData' => true,
            //Other errors will be ignored.
            //We need this mostly during order creation
            //empty means - all acceptable
            'acceptableErrorCodes' => [],
            //We need this if some of order properties upload files.
            'propsFiles' => [],
            //Fill shipments by FORM_DATA of basket builder
            'fillShipmentsByBasketBuilder' => false,
            //Builder scenario
            'builderScenario' => null,
        ];
    }
 
    public function __construct (array $settings)
    {
        $diff = array_diff(
            array_keys($settings),
            array_keys($this->getDefaultSettings())
        );
 
        if (!empty($diff))
        {
            throw new ArgumentOutOfRangeException('Unknown settings: "'.implode('",', $diff).'"');
        }
 
        $this->settings = array_merge($this->getDefaultSettings(), $settings);
    }
 
    public function getItemValue($name)
    {
        if (!isset($this->settings[$name]))
        {
            throw new SystemException('Unknown setting: "'.$name.'"');
        }
 
        return $this->settings[$name];
    }
}