base.php

<?php
namespace Bitrix\Sale\Delivery\Services;
 
use Bitrix\Main\Error;
use Bitrix\Main\Event;
use Bitrix\Sale\Result;
use Bitrix\Sale\Delivery;
use Bitrix\Sale\Shipment;
use Bitrix\Main\EventResult;
use Bitrix\Main\SystemException;
use Bitrix\Main\Localization\Loc;
use Bitrix\Sale\Delivery\Requests;
 
Loc::loadMessages(__FILE__);
 
/* Inputs for deliveries */
require_once __DIR__.'/../inputs.php';
 
abstract class Base
{
    protected $handlerCode = 'UNDEFINED';
 
    protected $id = 0;
    protected $name = "";
    protected $code = "";
    protected $vatId = 0;
    protected $sort = 100;
    protected $logotip = 0;
    protected $parentId = 0;
    protected $currency = "";
    protected $active = false;
    protected $description = "";
    protected $config = array();
    protected $restricted = false;
    protected $trackingClass = "";
    protected $deliveryRequestHandler = null;
 
    protected $extraServices = array();
    protected $trackingParams = array();
    protected $allowEditShipment = array();
 
    protected static $isProfile = false;
    protected static $canHasProfiles = false;
    protected static $isCalculatePriceImmediately = false;
    protected static $whetherAdminExtraServicesShow = false;
 
    const EVENT_ON_CALCULATE = "onSaleDeliveryServiceCalculate";
 
    public const TAG_PROFITABLE = 'profitable';
 
    protected $isClone = false;
 
    public function __construct(array $initParams)
    {
        $initParams = $this->prepareFieldsForUsing($initParams);
 
        if(isset($initParams["PARENT_ID"]))
            $this->parentId = $initParams["PARENT_ID"];
        else
            $this->parentId = 0;
 
        if(!isset($initParams["ACTIVE"]))
            $initParams["ACTIVE"] = "N";
 
        if(!isset($initParams["NAME"]))
            $initParams["NAME"] = "";
 
        if(!isset($initParams["CONFIG"]) || !is_array($initParams["CONFIG"]))
            $initParams["CONFIG"] = array();
 
        if(!is_array($initParams["CONFIG"]))
            throw new \Bitrix\Main\ArgumentTypeException("CONFIG", "array");
 
        $this->active = $initParams["ACTIVE"] == "Y";
        $this->name = $initParams["NAME"];
        $this->config = $initParams["CONFIG"];
 
        if(isset($initParams["ID"]) )
            $this->id = $initParams["ID"];
 
        if(isset($initParams["DESCRIPTION"]))
            $this->description = $initParams["DESCRIPTION"];
 
        if(isset($initParams["CODE"]))
            $this->code = $initParams["CODE"];
 
        if(isset($initParams["SORT"]))
            $this->sort = $initParams["SORT"];
 
        if(isset($initParams["LOGOTIP"]))
            $this->logotip = $initParams["LOGOTIP"];
 
        if(isset($initParams["CURRENCY"]))
            $this->currency = $initParams["CURRENCY"];
 
        if(isset($initParams["ALLOW_EDIT_SHIPMENT"]))
            $this->allowEditShipment = $initParams["ALLOW_EDIT_SHIPMENT"];
 
        if(isset($initParams["VAT_ID"]))
            $this->vatId = intval($initParams["VAT_ID"]);
 
        if(isset($initParams["RESTRICTED"]))
            $this->restricted = $initParams["RESTRICTED"];
 
        $this->trackingParams =
            isset($initParams["TRACKING_PARAMS"]) && is_array($initParams["TRACKING_PARAMS"])
                ? $initParams["TRACKING_PARAMS"]
                : []
        ;
 
        if(isset($initParams["EXTRA_SERVICES"]))
            $this->extraServices = new \Bitrix\Sale\Delivery\ExtraServices\Manager($initParams["EXTRA_SERVICES"], $this->currency);
        elseif($this->id > 0)
            $this->extraServices = new \Bitrix\Sale\Delivery\ExtraServices\Manager($this->id, $this->currency);
        else
            $this->extraServices = new \Bitrix\Sale\Delivery\ExtraServices\Manager(array(), $this->currency);
    }
 
    public function getHandlerCode(): string
    {
        return (string)$this->handlerCode;
    }
 
    public function getServiceCode(): string
    {
        if (
            static::isProfile()
            && ($parentService = $this->getParentService())
            && ($parentServiceHandlerCode = $parentService->getHandlerCode())
            && ($profileType = $this->getProfileType())
        )
        {
            return $parentServiceHandlerCode . '_' . $profileType;
        }
 
        return $this->getHandlerCode();
    }
 
    public function calculate(\Bitrix\Sale\Shipment $shipment = null, $extraServices = array()) // null for compability with old configurable services api
    {
        $result = new Delivery\CalculationResult();
 
        if ($shipment && !$shipment->getCollection())
        {
            $result->addError(new Error('\Bitrix\Sale\Delivery\Services\Base::calculate() can\'t calculate empty shipment!'));
            return $result;
        }
 
        if ($shipment)
        {
            $result = $this->calculateConcrete($shipment);
 
            if (empty($extraServices))
            {
                $extraServices = $shipment->getExtraServices();
            }
 
            $this->extraServices->setValues($extraServices);
            $this->extraServices->setOperationCurrency($shipment->getCurrency());
            $extraServicePrice = $this->extraServices->getTotalCostShipment($shipment);
 
            if ((float)$extraServicePrice > 0)
            {
                $result->setExtraServicesPrice($extraServicePrice);
            }
        }
 
        $eventParams = [
            'RESULT' => $result,
            'SHIPMENT' => $shipment,
            'DELIVERY_ID' => $this->id,
        ];
 
        $event = new Event('sale', self::EVENT_ON_CALCULATE, $eventParams);
        $event->send();
        $resultList = $event->getResults();
 
        if (is_array($resultList) && !empty($resultList))
        {
            foreach ($resultList as &$eventResult)
            {
                if ($eventResult->getType() != EventResult::SUCCESS)
                {
                    continue;
                }
 
                $params = $eventResult->getParameters();
 
                if (isset($params['RESULT']))
                {
                    $result = $params['RESULT'];
                }
            }
        }
 
        return $result;
    }
 
    public function getExtraServices()
    {
        return $this->extraServices;
    }
 
    public function getCurrency()
    {
        return $this->currency;
    }
 
    protected static function calculateShipmentPrice(\Bitrix\Sale\Shipment $shipment)
    {
        $result = 0;
 
        foreach($shipment->getShipmentItemCollection() as $shipmentItem)
        {
            $basketItem = $shipmentItem->getBasketItem();
 
            if(!$basketItem)
                continue;
 
            if($basketItem->isBundleChild())
                continue;
 
            $result += $basketItem->getPrice();
        }
 
        return $result;
    }
 
    public static function getClassTitle()
    {
        return "";
    }
 
    public static function getClassDescription()
    {
        return "";
    }
 
    public static function getDefaultVatRate(): ?float
    {
        return null;
    }
 
    protected function calculateConcrete(\Bitrix\Sale\Shipment $shipment)
    {
        return (new Delivery\CalculationResult())
            ->addError(
                new Error(
                    Loc::getMessage('SALE_DLVR_BASE_DELIVERY_PRICE_CALC_ERROR'),
                    'DELIVERY_CALCULATION'
            ));
    }
 
    public function prepareFieldsForSaving(array $fields)
    {
        $strError = "";
        $structure = $fields["CLASS_NAME"]::getConfigStructure();
 
        foreach($structure as $key1 => $rParams)
        {
            foreach($rParams["ITEMS"] as $key2 => $iParams)
            {
                if ($iParams["TYPE"] == "DELIVERY_SECTION")
                {
                    continue;
                }
 
                $value = $fields["CONFIG"][$key1][$key2] ?? null;
 
                $errors = \Bitrix\Sale\Internals\Input\Manager::getRequiredError($iParams, $value);
 
                if (empty($errors))
                {
                    $errors = \Bitrix\Sale\Internals\Input\Manager::getError($iParams, $value);
                }
 
                if (!empty($errors))
                {
                    $strError .= Loc::getMessage("SALE_DLVR_BASE_FIELD")." \"".$iParams["NAME"]."\": ".implode("<br>\n", $errors)."<br>\n";
                }
            }
        }
 
        if ($strError != "")
        {
            throw new SystemException($strError);
        }
 
        if(mb_strpos($fields['CLASS_NAME'], '\\') !== 0)
        {
            $fields['CLASS_NAME'] = '\\'.$fields['CLASS_NAME'];
        }
 
        return $fields;
    }
 
    protected function getConfigStructure()
    {
        return array();
    }
 
    protected function glueValuesToConfig(array $confStructure, $confValues = array())
    {
        if(!is_array($confValues))
            $confValues = array();
 
        if(isset($confStructure["ITEMS"]) && is_array($confStructure["ITEMS"]))
        {
            $confStructure["ITEMS"] = $this->glueValuesToConfig($confStructure["ITEMS"], $confValues);
        }
        else
        {
            foreach($confStructure as $itemKey => $itemParams)
            {
                if(isset($confStructure[$itemKey]["VALUE"]))
                    continue;
 
                if(isset($itemParams["ITEMS"]) && is_array($itemParams["ITEMS"]))
                    $confStructure[$itemKey]["ITEMS"] = $this->glueValuesToConfig($itemParams["ITEMS"], $confValues[$itemKey]);
                elseif(isset($confValues[$itemKey]))
                    $confStructure[$itemKey]["VALUE"] = $confValues[$itemKey];
                elseif(!isset($itemParams["VALUE"]) && isset($itemParams["DEFAULT"]))
                    $confStructure[$itemKey]["VALUE"] = $itemParams["DEFAULT"];
            }
        }
 
        return $confStructure;
    }
 
    public function getConfig()
    {
        $configStructure = $this->getConfigStructure();
 
        if(!is_array($configStructure))
            throw new SystemException ("Method getConfigStructure() must return an array!");
 
        foreach($configStructure as $key => $configSection)
            $configStructure[$key] = $this->glueValuesToConfig($configSection, isset($this->config[$key]) ? $this->config[$key] : array());
 
        return $configStructure;
    }
 
    public function getConfigValues()
    {
        return $this->config;
    }
 
    public static function getAdminFieldsList()
    {
        return Table::getMap();
    }
 
    public static function whetherAdminRestrictionsShow()
    {
        return true;
    }
 
    public static function canHasChildren()
    {
        return false;
    }
 
    public static function canHasProfiles()
    {
        return self::$canHasProfiles;
    }
 
    public static function getChildrenClassNames()
    {
        return array();
    }
 
    public function getId()
    {
        return $this->id;
    }
 
    public function getCode()
    {
        return $this->code;
    }
 
    public function getName()
    {
        return $this->name;
    }
 
    public function getDescription()
    {
        return $this->description;
    }
 
    public function getParentId()
    {
        return $this->parentId;
    }
 
    public function getSort()
    {
        return $this->sort;
    }
 
    public function getNameWithParent()
    {
        $result =  $this->name;
 
        if($parent = $this->getParentService())
            $result = $parent->getName()." (".$result.")";
 
        return $result;
    }
 
    public function getLogotip()
    {
        return $this->logotip;
    }
 
    public function getLogotipPath()
    {
        $logo = $this->getLogotip();
        return intval($logo) > 0 ? \CFile::GetPath($logo) : "";
    }
 
    public function getParentService()
    {
        $result = null;
 
        if(intval($this->parentId) > 0)
            $result =  Manager::getObjectById($this->parentId);
 
        return $result;
    }
 
    public function prepareFieldsForUsing(array $fields)
    {
        return $fields;
    }
 
    public function getEmbeddedExtraServicesList()
    {
        return array();
 
        /*
        exapmple for concrete handlers
        return array(
            "ZAPALECH" => array(
                "NAME" => "extra service name",
                "SORT" => 50,
                "RIGHTS" => "YYY",
                "ACTIVE" => "Y",
                "CLASS_NAME" => '\Bitrix\Sale\Delivery\ExtraServices\Checkbox',
                "DESCRIPTION" => "Extra service description",
                "PARAMS" => array("PRICE" => 2000)
            )
        );
        */
    }
 
    public static function whetherAdminExtraServicesShow()
    {
        return self::$whetherAdminExtraServicesShow;
    }
 
    public static function onBeforeAdd(array &$fields = array()): \Bitrix\Main\Result
    {
        return new \Bitrix\Main\Result();
    }
 
    public static function onAfterAdd($serviceId, array $fields = array())
    {
        return true;
    }
 
    public static function onBeforeUpdate($serviceId, array &$fields = array())
    {
        return true;
    }
 
    public static function onAfterUpdate($serviceId, array $fields = array())
    {
        return true;
    }
 
    public static function onAfterDelete($serviceId)
    {
        return true;
    }
 
    public function isCompatible(Shipment $shipment)
    {
        return true;
    }
 
    public function getCompatibleExtraServiceIds(Shipment $shipment): ?array
    {
        return null;
    }
 
    public function getProfilesList()
    {
        return array();
    }
 
    public static function isProfile()
    {
        return self::$isProfile;
    }
 
    protected function getProfileType(): string
    {
        return '';
    }
 
    public function getTrackingClass()
    {
        return $this->trackingClass;
    }
 
    public function setTrackingClass($class)
    {
        $this->trackingClass = $class;
    }
 
    public function getTrackingParams()
    {
        return $this->trackingParams;
    }
 
    public function isTrackingInherited()
    {
        return false;
    }
 
    public function isCalculatePriceImmediately()
    {
        return self::$isCalculatePriceImmediately;
    }
 
    public function isRestricted()
    {
        return $this->restricted;
    }
 
    public static function onGetBusinessValueConsumers()
    {
        return array();
    }
 
    public static function onGetBusinessValueGroups()
    {
        return array();
    }
 
    public static function isInstalled()
    {
        return true;
    }
 
    public static function install()
    {
        return true;
    }
 
    public static function unInstall()
    {
        return true;
    }
 
    public function isAllowEditShipment()
    {
        return $this->allowEditShipment != 'N';
    }
 
    public function getAdminMessage()
    {
        return array();
    }
 
    public function execAdminAction()
    {
        return new Result();
    }
 
    public function getAdditionalInfoShipmentEdit(Shipment $shipment)
    {
        return array();
    }
 
    public function processAdditionalInfoShipmentEdit(Shipment $shipment, array $requestData)
    {
        return $shipment;
    }
 
    public function getAdditionalInfoShipmentView(Shipment $shipment)
    {
        return array();
    }
 
    public function getAdditionalInfoShipmentPublic(Shipment $shipment)
    {
        return array();
    }
 
    public function createClone(\SplObjectStorage $cloneEntity)
    {
        if ($this->isClone() && $cloneEntity->contains($this))
        {
            return $cloneEntity[$this];
        }
 
        $deliveryServiceClone = clone $this;
        $deliveryServiceClone->isClone = true;
 
        if (!$cloneEntity->contains($this))
        {
            $cloneEntity[$this] = $deliveryServiceClone;
        }
 
        if ($extraServices = $this->getExtraServices())
        {
            if (!$cloneEntity->contains($extraServices))
            {
                $cloneEntity[$extraServices] = $extraServices->createClone($cloneEntity);
            }
 
            if ($cloneEntity->contains($extraServices))
            {
                $deliveryServiceClone->extraServices = $cloneEntity[$extraServices];
            }
        }
 
        return $deliveryServiceClone;
    }
 
    public function isClone()
    {
        return $this->isClone;
    }
 
    public static function getSupportedServicesList()
    {
        return array();
    }
 
    public function getAdminAdditionalTabs()
    {
        return array();
    }
 
    public function getVatId()
    {
        return $this->vatId;
    }
 
    public function setVatId($vatId)
    {
        $this->vatId = $vatId;
    }
 
    public function getDeliveryRequestHandler()
    {
        return $this->deliveryRequestHandler;
    }
 
    public function createProfileObject($fields)
    {
        return Manager::createObject($fields);
    }
 
    public static function isHandlerCompatible()
    {
        // Actually only configurable are fully compatible with all languages
        return in_array(
            \Bitrix\Sale\Delivery\Helper::getPortalZone(),
            ['', 'ru', 'kz', 'by', 'ua'],
            true
        );
    }
 
    public function getTags(): array
    {
        return [];
    }
}