base.php

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

<?php
namespace Bitrix\Sender\Connector;
 
use Bitrix\Sender\Recipient;
 
abstract class Base
{
    protected $fieldPrefix;
    protected $fieldPrefixExtended;
    protected $fieldValues;
    protected $fieldFormName;
    protected $moduleId;

    protected $resultView;

    protected $dataTypeId = Recipient\Type::EMAIL;
 
    protected bool $checkAccessRights = true;
    public function setModuleId($moduleId)
    {
        $this->moduleId = $moduleId;
    }

    public function getModuleId()
    {
        return $this->moduleId;
    }

    public function getDataTypeId()
    {
        return $this->dataTypeId;
    }

    public function setDataTypeId($dataTypeId)
    {
        $this->dataTypeId = $dataTypeId;
    }

    public function setFieldFormName($fieldFormName)
    {
        $this->fieldFormName = $fieldFormName;
    }

    public function getFieldFormName()
    {
        return $this->fieldFormName;
    }

    public function setFieldPrefix($fieldPrefix)
    {
        $this->fieldPrefix = $fieldPrefix;
    }

    public function getFieldPrefix()
    {
        return $this->fieldPrefix;
    }

    public function setFieldPrefixExtended($fieldPrefixExtended)
    {
        $this->fieldPrefixExtended = $fieldPrefixExtended;
    }

    public function getFieldPrefixExtended()
    {
        return $this->fieldPrefixExtended;
    }

    public function setFieldValues(array $fieldValues = null)
    {
        $this->fieldValues = $fieldValues;
    }

    public function getFieldValues()
    {
        return is_array($this->fieldValues) ? $this->fieldValues : array();
    }

    public function hasFieldValues()
    {
        return count($this->getFieldValues()) > 0;
    }

    public function getFieldId($id)
    {
        $fieldPrefix = $this->getFieldPrefix();
        $fieldPrefixExtended = $this->getFieldPrefixExtended();
        if($fieldPrefix)
        {
            $moduleId = str_replace('.', '_', $this->getModuleId());
            return $fieldPrefix . '_' . $moduleId . '_' . $this->getCode() . '_%CONNECTOR_NUM%_' . $id;
        }
        elseif($fieldPrefixExtended)
        {
            return str_replace(array('][', '[', ']'), array('_', '', ''), $fieldPrefixExtended) .'_'. $id;
        }
        else
            return $id;
    }

    public function getFieldName($name)
    {
        $fieldPrefix = $this->getFieldPrefix();
        $fieldPrefixExtended = $this->getFieldPrefixExtended();
        if($fieldPrefix || $fieldPrefixExtended)
        {
            $arReturnName = array();
            if($fieldPrefix)
                $arReturnName[] = $fieldPrefix.'['.$this->getModuleId().']['.$this->getCode().'][%CONNECTOR_NUM%]';
            else
                $arReturnName[] = $fieldPrefixExtended;
 
            $arName = explode('[', $name);
            $arReturnName[] = '['.$arName[0].']';
            if(count($arName)>1)
            {
                unset($arName[0]);
                $arReturnName[] = '['.implode('[', $arName);
            }
 
            return implode('', $arReturnName);
        }
        else
            return $name;
    }

    public function getFieldValue($name, $defaultValue = null)
    {
        if($this->fieldValues && array_key_exists($name, $this->fieldValues))
            return $this->fieldValues[$name];
        else
            return $defaultValue;
    }

    public function getId()
    {
        return $this->getModuleId().'_'.$this->getCode();
    }

    public function getDataCount()
    {
        return $this->getResult()->getSelectedRowsCount();
    }

    protected function getDataCountByType()
    {
        return null;
    }

    final function getDataCounter()
    {
        $dataCounts = $this->getDataCountByType();
        if (is_object($dataCounts) && $dataCounts instanceof DataCounter)
        {
            return $dataCounts;
        }
        else if (!is_array($dataCounts))
        {
            $dataCounts = array($this->getDataTypeId() => $this->getDataCount());
        }
 
        return new DataCounter($dataCounts);
    }

    final function getResult()
    {
        $personalizeList = array();
        $personalizeListTmp = $this->getPersonalizeList();
        foreach($personalizeListTmp as $tag)
        {
            if(!empty($tag['ITEMS']))
            {
                foreach ($tag['ITEMS'] as $item)
                {
                    $personalizeList[$item['CODE']] = $item['CODE'];
                }
                continue;
            }
            if(strlen($tag['CODE']) > 0)
            {
                $personalizeList[] = $tag['CODE'];
            }
        }
 
        $result = new Result($this->getData());
        $result->setFilterFields($personalizeList);
        $result->setDataTypeId($this->getDataTypeId());
 
        return $result;
    }

    public function isResultViewable()
    {
        return false;
    }

    public function getResultView()
    {
        if (!$this->resultView)
        {
            $this->resultView = new ResultView($this);
            $this->onInitResultView();
        }
 
        return $this->resultView;
    }

    public function setResultView($resultView)
    {
        $this->resultView = $resultView;
    }
 
    protected function onInitResultView()
    {
 
    }

    public function requireConfigure()
    {
        return false;
    }

    public static function getPersonalizeList()
    {
        return array();
    }

    public abstract function getName();

    public abstract function getCode();

    public abstract function getData();
 
 
 
    public function buildData()
    {
        return null;
    }

    public abstract function getForm();

    public function getStatFields()
    {
        return [];
    }

    public function isCheckAccessRights(): bool
    {
        return $this->checkAccessRights;
    }

    public function setCheckAccessRights(bool $checkAccessRights): static
    {
        $this->checkAccessRights = $checkAccessRights;
 
        return $this;
    }
}