widget.php

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

<?php
 
namespace Bitrix\Report\VisualConstructor\Entity;
 
use Bitrix\Main\Entity\Query;
use Bitrix\Report\VisualConstructor\Category;
use Bitrix\Report\VisualConstructor\Config\Common;
use Bitrix\Report\VisualConstructor\Handler\BaseReport;
use Bitrix\Report\VisualConstructor\Handler\BaseWidget;
use Bitrix\Report\VisualConstructor\Internal\WidgetConfigurationTable;
use Bitrix\Report\VisualConstructor\Internal\WidgetTable;
use Bitrix\Report\VisualConstructor\RuntimeProvider\WidgetProvider;

class Widget extends ConfigurableModel
{
    protected $gId;
    protected $weight;
    protected $boardId;
    protected $rowId;
    protected $widgetClass;
    protected $widgetHandler;
    protected $viewKey;
    protected $ownerId = 0;
    protected $categoryKey = '';
    protected $isPattern = false;
    protected $parentWidgetId = 0;

    protected $reports = array();

    protected $row;

    protected $parentWidget;

    protected $childWidgets = array();

    public function __construct()
    {
        parent::__construct();
        $this->weight = 0;
    }

    public static function getTableClassName()
    {
        return WidgetTable::getClassName();
    }

    public static function getMapAttributes()
    {
        $attributes = parent::getMapAttributes();
        $attributes['GID'] = 'gId';
        $attributes['BOARD_ID'] = 'boardId';
        $attributes['DASHBOARD_ROW_ID'] = 'rowId';
        $attributes['PARENT_WIDGET_ID'] = 'parentWidgetId';
        $attributes['WIDGET_CLASS'] = 'widgetClass';
        $attributes['CATEGORY_KEY'] = 'categoryKey';
        $attributes['VIEW_KEY'] = 'viewKey';
        $attributes['WEIGHT'] = 'weight';
        $attributes['OWNER_ID'] = 'ownerId';
        $attributes['IS_PATTERN'] = 'isPattern';
        return $attributes;
    }

    public static function getMapReferenceAttributes()
    {
        return array(
            'row' => array(
                'type' => Common::MANY_TO_ONE,
                'targetEntity' => DashboardRow::getClassName(),
                'inversedBy' => 'widgets',
                'join' => array(
                    'field' => array('rowId', 'id')
                )
            ),
            'configurations' => array(
                'type' => Common::MANY_TO_MANY,
                'targetEntity' => Configuration::getClassName(),
                'join' => array(
                    'tableClassName' => WidgetConfigurationTable::getClassName(),
                    'column' => array('WIDGET' => array('id', 'WIDGET_ID')),
                    'inverseColumn' => array('CONFIGURATION_SETTING' => array('id', 'CONFIGURATION_ID'))
                ),
            ),
            'reports' => array(
                'type' => Common::ONE_TO_MANY,
                'targetEntity' => Report::getClassName(),
                'mappedBy' => 'widget'
            ),
            'parentWidget' => array(
                'type' => Common::MANY_TO_ONE,
                'targetEntity' => Widget::getClassName(),
                'inversedBy' => 'childWidgets',
                'join' => array(
                    'field' => array('parentWidgetId', 'id')
                ),
                'options' => array(
                    'deleteSkip' => true
                )
            ),
            'childWidgets' => array(
                'type' => Common::ONE_TO_MANY,
                'targetEntity' => Widget::getClassName(),
                'mappedBy' => 'parentWidget',
                'options' => array(
                    'deleteSkip' => true
                )
            ),
        );
    }
 

    public function delete()
    {
        if ($this->isPattern())
        {
            $this->rowId = 0;
            $this->save();
            return true;
        }
        else
        {
            return parent::delete();
        }
    }

    public function deletePatternWidget()
    {
        return parent::delete();
    }

    public function addReportHandler(BaseReport $reportHandler)
    {
        $report = $reportHandler->getReport();
        $this->addReports($report);
        if ($this->getId())
        {
            $report->setWidget($this);
            $reportHandler->fillReport($report);
        }
 
    }

    public function getWidgetHandler($isRuntime = false)
    {
        if (!$this->widgetHandler)
        {
            $widgetProvider = new WidgetProvider();
            $widgetProvider->addFilter('widgetClassName', $this->widgetClass);
            $widgetHandlerFromEvent = $widgetProvider->execute()->getFirstResult();
            if ($widgetHandlerFromEvent)
            {
                $this->widgetHandler = new $widgetHandlerFromEvent;
                if (!$isRuntime)
                {
                    $this->loadAttribute('configurations');
                }
                $this->widgetHandler->fillWidget($this);
            }
        }
 
        return $this->widgetHandler;
    }
 
 

    public function setWidgetHandler(BaseWidget $widgetHandler)
    {
        $this->setWidgetClass($widgetHandler::getClassName());
        $this->widgetHandler = $widgetHandler;
    }

    public function getReports()
    {
        return $this->reports;
    }

    public function getReportsGidKeyed()
    {
        $reports = $this->getReports();
        $result = array();
        foreach ($reports as $report)
        {
            $result[$report->getGId()] = $report;
        }
        return $result;
    }

    public function getReportByGId($reportGId)
    {
        foreach ($this->getReports() as $report)
        {
            echo $report->getGId() . PHP_EOL;
            if($report->getGId() === $reportGId)
            {
                return $report;
            }
        }
        return null;
    }

    public function getBoardId()
    {
        return $this->boardId;
    }

    public function setBoardId($boardId)
    {
        $this->boardId = $boardId;
    }

    public function getViewKey()
    {
        return $this->viewKey;
    }

    public function setViewKey($viewKey)
    {
        $this->viewKey = $viewKey;
    }

    public function getFilterId()
    {
        return 'report_board_' . $this->getBoardId() . '_filter';
    }

    public function getCopyForCurrentUser()
    {
        global $USER;
        //TODO create normal copy function for models
        $coreWidget = clone $this;
        $copyWidget = new Widget();
        $copyWidget->setBoardId($coreWidget->getBoardId());
        $copyWidget->setWidgetClass($coreWidget->getWidgetClass());
        $copyWidget->setViewKey($coreWidget->getViewKey());
        $copyWidget->setGId($coreWidget->getGId());
        $copyWidget->setWeight($coreWidget->getWeight());
        $copyWidget->setOwnerId($USER->getID());
        if ($coreWidget->getId())
        {
            $copyWidget->setParentWidgetId($coreWidget->getId());
        }
        else
        {
            $copyWidget->setParentWidgetId($coreWidget->getId());
        }
 
        $reports = $coreWidget->getReports();
        if (is_array($reports))
        {
            foreach ($reports as $report)
            {
                //HACK: must rewrite
                $report->loadAttribute('configurations');
                $reportCopy = $report->getCopy();
                $reportCopy->setWidget($copyWidget);
                $reportCopy->setWidgetId(null);
                $copyWidget->addReports($reportCopy);
            }
        }
 
 
        $configurations = $coreWidget->getConfigurations();
        if ($configurations)
        {
            foreach ($configurations as $configuration)
            {
                $configuration->setId(null);
                $copyWidget->addConfigurations($configuration);
            }
        }
 
 
        return $copyWidget;
    }

    public static function getWidgetsByBoard($boardId)
    {
        $widgets = static::getModelList(array(
            'select' => array('*'),
            'filter' => array('=BOARD_ID' => $boardId),
            'with' => array('reports.configurations', 'reports.widget', 'configurations'),
            'order' => array('WEIGHT'),
        ));
        return $widgets;
    }

    public static function getCurrentUserPatternedWidgets()
    {
        global $USER;
        $userId = $USER->getId();
        $filter = Query::filter()
            ->where('IS_PATTERN', '1')
            ->where(Query::filter()
                ->where(Query::filter()
                    ->where('OWNER_ID', $userId)
                )
                ->logic('or')
                ->where(Query::filter()
                    ->where('OWNER_ID', 0)
                    ->whereNot('CATEGORY_KEY', '')
                )
            );
        $widgets = static::getModelList(array(
            'select' => array('*'),
            'filter' => $filter,
            'order' => array('CREATED_DATE' => 'DESC'),
        ));
        return $widgets ? $widgets : array();
    }

    public static function getWidgetConfigurations($widgetId)
    {
        $widget = static::getWidgetById($widgetId);
        $configurations = $widget->getConfigurations();
        return $configurations;
    }

    public static function getWidgetById($widgetId)
    {
        static $widgets;
        if (!isset($widgets[$widgetId]))
        {
            $widgets[$widgetId] = static::load(array('ID' => $widgetId), array('row', 'reports.configurations', 'configurations'));
        }
        return $widgets[$widgetId];
    }

    public static function getCurrentUserWidgetByGId($widgetGId)
    {
        global $USER;
        if ($USER)
        {
            //TODO
            $filter = Query::filter();
            $filter->where('GID', $widgetGId);
            $filter->logic('and');
            $filter->where('ROW.DASHBOARD.USER_ID', $USER->getId());
 
            $widget = static::load(
                $filter,
                array('row', 'reports.configurations', 'configurations')
            );
            if (!$widget)
            {
                $filter = Query::filter();
                $filter->where('GID', $widgetGId);
                $filter->logic('and');
                $filter->where('ROW.DASHBOARD.USER_ID', 0);
                $widget = static::load(
                    $filter,
                    array('row', 'reports.configurations', 'configurations')
                );
            }
 
            return $widget;
        }
        return null;
    }

    public static function buildPseudoWidget($params)
    {
        if (mb_strpos($params['widgetGId'], 'pseudo_') === 0)
        {
            $widget = new self();
            $widget->setViewKey($params['viewKey']);
            $widget->setGId($params['widgetGId']);
            $widget->setWidgetClass(BaseWidget::getClassName());
            return $widget;
        }
 
        $widget = self::getCurrentUserWidgetByGId($params['widgetGId']);
        if ($widget)
        {
            $widget->setViewKey($params['viewKey']);
        }
        return $widget;
    }

    public static function getWidgetByGId($widgetGId)
    {
        return static::load(
            array(
                'GID' => $widgetGId
            ),
            array('row', 'reports.configurations', 'configurations')
        );
    }

    public static function getWidgetByIdWithReports($widgetId)
    {
        $widget = static::load(
            array('ID' => $widgetId),
            array('row', 'reports', 'reports.configurations', 'configurations')
        );
        return $widget;
    }

    public static function removeCurrentUserWidgetByGId($widgetGId)
    {
        global $USER;
        if ($USER)
        {
            $widget = static::load(
                array(
                    'GID' => $widgetGId,
                    'ROW.DASHBOARD.USER_ID' => $USER->getId()
                )
            );
            $widget->delete();
            return $widgetGId;
        }
        return null;
 
    }

    public function getWeight()
    {
        return $this->weight;
    }

    public function setWeight($weight)
    {
        $this->weight = $weight;
    }

    public function getWidgetClass()
    {
        return $this->widgetClass;
    }

    public function setWidgetClass($widgetClass)
    {
        $this->widgetClass = $widgetClass;
    }

    public function getRow()
    {
        return $this->row;
    }

    public function setRow(DashboardRow $row)
    {
        $this->row = $row;
    }

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

    public function setIsPattern($isPattern)
    {
        $this->isPattern = $isPattern;
    }

    public function getParentWidget()
    {
        return $this->parentWidget;
    }

    public function setParentWidget($parentWidget)
    {
        $this->parentWidget = $parentWidget;
    }

    public function getChildWidgets()
    {
        return $this->childWidgets;
    }

    public function getParentWidgetId()
    {
        return $this->parentWidgetId;
    }

    public function setParentWidgetId($parentWidgetId)
    {
        $this->parentWidgetId = $parentWidgetId;
    }

    public function getGId()
    {
        return $this->gId;
    }

    public function setGId($gId)
    {
        $this->gId = $gId;
    }

    public function getCategoryKey()
    {
        return $this->categoryKey;
    }

    public function setCategoryKey($categoryKey)
    {
        $this->categoryKey = $categoryKey;
    }

    public function getRowId()
    {
        return $this->rowId;
    }

    public function setRowId($rowId)
    {
        $this->rowId = $rowId;
    }

    public function getOwnerId()
    {
        return $this->ownerId;
    }

    public function setOwnerId($ownerId)
    {
        $this->ownerId = $ownerId;
    }
 
 
}