base.php

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

<?php
namespace Bitrix\Sender\Trigger;
 
use \Bitrix\Sender\Connector;
 
abstract class Base
{
    protected $fieldPrefix;
    protected $fieldValues;
    protected $fieldFormName;
    protected $moduleId;
    protected $siteId;
 
    protected $fields;
    protected $params;
    protected $isRunForOldData = false;
    protected $recipient;
 

    public function setModuleId($moduleId)
    {
        $this->moduleId = $moduleId;
    }

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

    public function setSiteId($siteId)
    {
        $this->siteId = $siteId;
    }

    public function getSiteId()
    {
        return $this->siteId;
    }

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

    public function requireConfigure()
    {
        return false;
    }

    public static function isClosed()
    {
        return false;
    }

    public static function canBeTarget()
    {
        return true;
    }

    public static function canRunForOldData()
    {
        return false;
    }

    public function setRunForOldData($isRunForOldData)
    {
        if(!static::canRunForOldData())
        {
            $this->isRunForOldData = false;
        }
 
        $this->isRunForOldData = (bool) $isRunForOldData;
    }

    public function isRunForOldData()
    {
        if(!$this->canRunForOldData())
        {
            return false;
        }
 
        return $this->isRunForOldData;
    }

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

    public function getFields()
    {
        if(is_array($this->fields))
            return $this->fields;
        else
            return array();
    }

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

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

    public function getParams()
    {
        if(is_array($this->params))
            return $this->params;
        else
            return array();
    }

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

    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 getFieldId($id)
    {
        $fieldPrefix = $this->getFieldPrefix();
        if($fieldPrefix)
        {
            return $fieldPrefix . '_' . $id;
        }
        else
            return $id;
    }

    public function getFieldName($name)
    {
        $fieldPrefix = $this->getFieldPrefix();
        if($fieldPrefix)
        {
            $returnName = array();
            $returnName[] = $fieldPrefix;
            $nameParsed = explode('[', $name);
            $returnName[] = '['.$nameParsed[0].']';
            if(count($nameParsed) > 1)
            {
                unset($nameParsed[0]);
                $returnName[] = '['.implode('[', $nameParsed);
            }
 
            return implode('', $returnName);
        }
        else
            return $name;
    }

    public function getFullEventType()
    {
        return $this->getEventModuleId() .'/'. $this->getEventType();
    }
 

    public function getMailEventToPrevent()
    {
        return array(
            'EVENT_NAME' => '',
            'FILTER' => array()
        );
    }

    public function filter()
    {
        return true;
    }

    public function getForm()
    {
        return '';
    }

    public function getRecipientResult()
    {
        $result = new Connector\Result($this->getRecipient());
 
        // set fields that will be added in each item of result set
        $personalizeList = array();
        $personalizeListTmp = $this->getPersonalizeList();
        foreach($personalizeListTmp as $tag)
        {
            if($tag['CODE'] <> '')
            {
                $personalizeList[] = $tag['CODE'];
            }
        }
        $result->setFilterFields($personalizeList);
 
        // set same fields for all items in each item of result set
        $result->setAdditionalFields($this->getPersonalizeFields());
 
        return $result;
    }

    public function getPersonalizeFields()
    {
        return array();
    }

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

    public abstract function getName();

    public abstract function getCode();

    public abstract function getEventModuleId();

    public abstract function getEventType();

    public abstract function getRecipient();
}