base.php

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

<?php
namespace Bitrix\Report\VisualConstructor\Handler;
 
 
use Bitrix\Report\VisualConstructor\Entity\Configuration;
use Bitrix\Report\VisualConstructor\Fields\Base as BaseFormElement;
use Bitrix\Report\VisualConstructor\Fields\Valuable\BaseValuable;
use Bitrix\Report\VisualConstructor\Helper\Util;
use Bitrix\Report\VisualConstructor\View;

abstract class Base
{
    protected $configurations = array();
    protected $view;

    protected $formElementsList = array();

    public static function getClassName()
    {
        return get_called_class();
    }

    public function getCollectedFormElements()
    {
        $this->collectFormElements();
        return $this->getFormElements();
    }

    public function getFormElementFromCollected($key)
    {
        static $collectedFormElements;
        if (!$collectedFormElements)
        {
            $collectedFormElements = $this->getCollectedFormElements();
        }
        return $this->getFormElement($key);
    }

    abstract protected function collectFormElements();
 

    private function addToConfiguration(BaseValuable $element)
    {
        $configuration = $this->getConfiguration($element->getKey());
 
        if (!$configuration)
        {
            $newConfiguration = new Configuration();
            $newConfiguration->setGId(Util::generateUserUniqueId());
            $newConfiguration->setFieldClassName($element::getClassName());
            $newConfiguration->setKey($element->getKey());
            $newConfiguration->setValue($element->getValue());
            $newConfiguration->setWeight($element->getWeight());
            $this->configurations[] = $newConfiguration;
        }
    }

    public function addFormElement(BaseFormElement $element)
    {
        if ($element->getKey())
        {
            $this->formElementsList[$element->getKey()] = $element;
        }
        else
        {
            $this->formElementsList[] = $element;
        }
 
        if ($element instanceof BaseValuable)
        {
            $this->addToConfiguration($element);
        }
 
    }

    public function addFormElementBefore(BaseFormElement $newElement, BaseFormElement $targetElement)
    {
        $newFormElementsList = array();
        foreach ($this->formElementsList as $key => $element)
        {
 
            //add new element
            if ($element === $targetElement)
            {
                if ($newElement->getKey())
                {
                    $newFormElementsList[$newElement->getKey()] = $newElement;
                }
                else
                {
                    $newFormElementsList[] = $newElement;
                }
 
                if ($newElement instanceof BaseValuable)
                {
                    $this->addToConfiguration($newElement);
                }
            }
 
            //rewrite old elements to new collection
            if ($element->getKey())
            {
                $newFormElementsList[$key] = $element;
            }
            else
            {
                $newFormElementsList[] = $element;
            }
        }
        $this->formElementsList = $newFormElementsList;
    }

    public function addFormElementAfter(BaseFormElement $newElement, BaseFormElement $targetElement)
    {
        $newFormElementsList = [];
        foreach ($this->formElementsList as $key => $element)
        {
            //rewrite old elements to new collection
            if ($element->getKey())
            {
                $newFormElementsList[$key] = $element;
            }
            else
            {
                $newFormElementsList[] = $element;
            }
 
            //add new element
            if ($element === $targetElement)
            {
                if ($newElement->getKey())
                {
                    $newFormElementsList[$newElement->getKey()] = $newElement;
                }
                else
                {
                    $newFormElementsList[] = $newElement;
                }
 
                if ($newElement instanceof BaseValuable)
                {
                    $this->addToConfiguration($newElement);
 
                }
            }
        }
        $this->formElementsList = $newFormElementsList;
    }

    public function addFormElementToStart(BaseFormElement $newElement)
    {
        $firstFormElement = reset($this->formElementsList);
        if ($firstFormElement)
        {
            $this->addFormElementBefore($newElement, $firstFormElement);
        }
    }

    public function addFormElementToEnd(BaseFormElement $newElement)
    {
        $this->addFormElement($newElement);
    }

    public function setFormElements($formElementList)
    {
        $this->formElementsList = [];
        $this->configurations = [];
        foreach ($formElementList as $element)
        {
            $this->addFormElement($element);
        }
    }

    public function updateFormElementValue($formElement, $value)
    {
        if (is_string($formElement))
        {
            $formElement = $this->getFormElement($formElement);
        }
 
        if (!$formElement || !($formElement instanceof BaseValuable))
        {
            return false;
        }
 
        $formElement->setValue($value);
        $configuration = $this->getConfiguration($formElement->getKey());
        if ($configuration)
        {
            $configuration->setValue($formElement->getValue());
        }
        else
        {
            $this->addToConfiguration($formElement);
        }
        return true;
    }

    public function getFormElements()
    {
        return $this->formElementsList;
    }

    public function getFormElement($fieldKey)
    {
        $formElements = $this->getFormElements();
        if (isset($formElements[$fieldKey]))
        {
            return $formElements[$fieldKey];
        }
        else
        {
            return null;
        }
    }

    public function getFormElementValue($fieldKey)
    {
        $formElements = $this->getFormElements();
        if (isset($formElements[$fieldKey]))
        {
            return $formElements[$fieldKey]->getValue();
        }
 
        return null;
    }

    public function getFormElementByDataAttribute($attributeKey, $value)
    {
        $reportHandlerFormElements = $this->getFormElements();
        if ($reportHandlerFormElements)
        {
            foreach ($reportHandlerFormElements as $element)
            {
                if ($element->getDataAttribute($attributeKey) === $value)
                {
                    return $element;
                }
            }
        }
        return null;
    }

    public function removeFormElement(BaseFormElement $element)
    {
        if ($element instanceof BaseValuable)
        {
            if (!empty($this->formElementsList[$element->getKey()]))
            {
                $configuration = $this->getConfiguration($element->getKey());
                foreach ($this->configurations as $i => $configurationFromList)
                {
                    if ($configurationFromList === $configuration)
                    {
                        unset($this->configurations[$i]);
                    }
                }
            }
        }
 
        foreach ($this->formElementsList  as $i => $elementFromList)
        {
            if ($element === $elementFromList)
            {
                unset($this->formElementsList[$i]);
                return true;
            }
        }
        return false;
    }

    public function setConfigurations($configurations)
    {
        $this->configurations = $configurations;
    }

    public function getConfigurations()
    {
        return $this->configurations;
    }

    public function getConfigurationsGidKeyed()
    {
        $reports = $this->getConfigurations();
        $result = array();
        foreach ($reports as $configuration)
        {
            $result[$configuration->getGId()] = $configuration;
        }
        return $result;
}
 

    public function getConfiguration($key)
    {
        $configurations = $this->getConfigurations();
        if (!empty($configurations))
        {
            foreach ($configurations as $configuration)
            {
                if ($configuration->getKey() == $key)
                    return $configuration;
            }
        }
 
        return null;
    }

    protected function getNameForFormElement(BaseValuable $element)
    {
        $name = '';
 
        $configuration = $this->getConfiguration($element->getKey());
        $id = '[new]';
        if ($configuration && $configuration->getId())
        {
            $id = '[old][' . $configuration->getGId() . ']';
        }
 
        $name .= '[configurations]' . $id . '[' . $element->getKey() . ']';
        return $name;
    }

    public function getView()
    {
        return $this->view;
    }

    public function setView(View $view)
    {
        $this->view = $view;
    }
}