eXpansion\Framework\Core\Model\Gui\Grid\GridBuilder

Complexity

Total Complexity

21

Size/Duplication

Total Lines	296
Duplicated Lines	4.39 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	13	13	1
A	setDataCollection()	0	6	1
A	setManialink()	0	15	1
A	setManialinkFactory()	0	6	1
A	addTextColumn()	0	6	1
A	addActionColumn()	0	6	1
A	resetColumns()	0	5	1
A	goToFirstPage()	0	4	1
A	goToPreviousPage()	0	6	2
A	goToNextPage()	0	6	2
A	goToLastPage()	0	4	1
A	changePage()	0	5	1
C	build()	0	77	7

<?php

namespace eXpansion\Framework\Core\Model\Gui\Grid;
use eXpansion\Framework\Core\Model\Gui\Action;
use eXpansion\Framework\Core\Model\Gui\Factory\LineFactory;
use eXpansion\Framework\Core\Model\Gui\Factory\PagerFactory;
use eXpansion\Framework\Core\Model\Gui\Grid\Column\AbstractColumn;
use eXpansion\Framework\Core\Model\Gui\Grid\Column\ActionColumn;
use eXpansion\Framework\Core\Model\Gui\Grid\Column\TextColumn;
use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
use eXpansion\Framework\Core\Plugins\Gui\ActionFactory;
use eXpansion\Framework\Core\Plugins\Gui\ManialinkFactory;
use FML\Controls\Frame;


/**
 * Class GridBuilder
 *
 * @TODO Add possibility to add actions on elements.
 *
 * @package eXpansion\Framework\Core\Model\Gui\Grid;
 * @author  oliver de Cramer <oliverde8@gmail.com>
 */
class GridBuilder
{
    /** @var  ActionFactory */
    protected $actionFactory;

    /** @var LineFactory */
    protected $titleLineFactory;

    /** @var LineFactory */
    protected $lineFactory;

    /** @var PagerFactory */
    protected $pagerFactory;

    /** @var DataCollectionInterface */
    protected $dataCollection;

    /** @var ManialinkInterface */
    protected $manialink;

    /** @var ManialinkFactory */
    protected $manialinkFactory;

    /** @var AbstractColumn[] */
    protected $columns;

    /** @var  float */
    protected $totalWidthCoefficency = 0.;

    /** @var int */
    protected $currentPage = 1;

    /** @var string */
    protected $pageKey;

    /** @var string */
    protected $actionPreviousPage;
    /** @var string */
    protected $actionNextPage;
    /** @var string */
    protected $actionLastPage;
    /** @var string */
    protected $actionFirstPage;

    /** @var string[] */
    protected $temporaryActions = [];

    /**
     * GridBuilder constructor.
     *
     * @param ActionFactory $actionFactory
     * @param LineFactory   $lineFactory
     * @param LineFactory   $titleLineFactory
     * @param PagerFactory  $pagerFactory
     */
    public function __construct(

This method seems to be duplicated in your project.

        ActionFactory $actionFactory,
        LineFactory $lineFactory,
        LineFactory $titleLineFactory,
        PagerFactory $pagerFactory
    ) {
        $this->actionFactory = $actionFactory;
        $this->titleLineFactory = $titleLineFactory;
        $this->lineFactory = $lineFactory;
        $this->pagerFactory = $pagerFactory;

        $this->pageKey = spl_object_hash($this)."_key";
    }

    /**
     * Set the data collection.
     *
     * @param DataCollectionInterface $dataCollection
     *
     * @return $this
     */
    public function setDataCollection(DataCollectionInterface $dataCollection)
    {
        $this->dataCollection = $dataCollection;

        return $this;
    }

    /**
     * Set the manialink the content is generated for.
     *
     * @param ManialinkInterface $manialink
     *
     * @return $this
     */
    public function setManialink(ManialinkInterface $manialink)
    {
        $this->manialink = $manialink;

        $this->actionFirstPage = $this->actionFactory
            ->createManialinkAction($manialink, array($this, 'goToFirstPage'), []);
        $this->actionPreviousPage = $this->actionFactory
            ->createManialinkAction($manialink, array($this, 'goToPreviousPage'), []);
        $this->actionNextPage = $this->actionFactory
            ->createManialinkAction($manialink, array($this, 'goToNextPage'), []);
        $this->actionLastPage = $this->actionFactory
            ->createManialinkAction($manialink, array($this, 'goToLastPage'), []);

        return $this;
    }

    /**
     * Set the manialink factory responsible with the manialink.
     *
     * @param ManialinkFactory $manialinkFactory
     *
     * @return $this
     */
    public function setManialinkFactory($manialinkFactory)
    {
        $this->manialinkFactory = $manialinkFactory;

        return $this;
    }

    /**
     * @param      string $key
     * @param      string $name
     * @param      integer $widthCoefficiency
     * @param bool $sortable
     * @param bool $translatable
     *
     * @return $this
     */
    public function addTextColumn($key, $name, $widthCoefficiency, $sortable = false, $translatable = false)
    {
        $this->columns[] = new TextColumn($key, $name, $widthCoefficiency, $sortable, $translatable);

        return $this;
    }

    /**
     * Add an action into a column.
     *
     * @param string $key
     * @param string $name
     * @param integer $widthCoefficiency
     * @param $action
     * @param Label $renderer
     *
     * @return $this
     */
    public function addActionColumn($key, $name, $widthCoefficiency, $action, $renderer)
    {
        $this->columns[] = new ActionColumn($key, $name, $widthCoefficiency, $action, $renderer);

        return $this;
    }

    /**
     * Remove all columns.
     */
    public function resetColumns()
    {
        $this->columns = [];
        $this->totalWidthCoefficency = 0.;
    }

    /**
     * Build a grid.
     *
     * @param double $width
     * @param double $height
     *
     * @return Frame
     */
    public function build($width, $height)
    {
        foreach ($this->temporaryActions as $action) {
            $this->actionFactory->destroyAction($action);
        }

        $lineHeight = 5 + 0.5;

        $frame = new Frame();
        $frame->setPosition(0, 0);
        $frame->setSize($width, $height);

        $posY = 0.;
        // Generating headers.
        // TODO if sortable create actions...
        $data = [];
        foreach ($this->columns as $columnData) {
            $data[] = [
                'text' => $columnData->getName(),
                'width' => $columnData->getWidthCoeficiency(),
                'translatable' => true
            ];
        }

        $frame->addChild($this->titleLineFactory->create($frame->getWidth(), $data));
        $posY -= $lineHeight + 1;

        /*
         * Display the main content.
         */
        $this->dataCollection->setPageSize(floor(($frame->getHeight() + $posY - $lineHeight - 2) / $lineHeight));

        $lines = $this->dataCollection->getData($this->currentPage);
        foreach ($lines as $i => $lineData) {
            $data = [];
            foreach ($this->columns as $columnData) {
                if ($columnData instanceof TextColumn) {
                    $data[] = [
                        'text' => $this->dataCollection->getLineData($lineData, $columnData->getKey()),
                        'width' => $columnData->getWidthCoeficiency(),
                        'translatable' => $columnData->getTranslatable()
                    ];
                } elseif ($columnData instanceof ActionColumn) {
                    $action = $this->actionFactory
                        ->createManialinkAction($this->manialink, $columnData->getCallable(), $lineData);
                    $this->temporaryActions[] = $action;
                    $data[] = [
                        'renderer' => clone $columnData->getRenderer(),
                        'width' => $columnData->getWidthCoeficiency(),
                        'action' => $action,
                    ];
                }
            }
            $line = $this->lineFactory->create($frame->getWidth(), $data, $i);
            $line->setPosition(0, $posY);
            $frame->addChild($line);
            $posY -= $lineHeight;
        }

        /*
         * Handle the pager.
         */
        $posY = ($frame->getHeight() - 7) * -1;
        $pager = $this->pagerFactory->create(
            $frame->getWidth(),
            $this->currentPage,
            $this->dataCollection->getLastPageNumber(),
            $this->actionFirstPage,
            $this->actionPreviousPage,
            $this->actionNextPage,
            $this->actionLastPage
        );
        $pager->setPosition(0, $posY);
        $frame->addChild($pager);

        return $frame;
    }

    /**
     * Action callback to go to the first page.
     */
    public function goToFirstPage()
    {
        $this->changePage(1);
    }

    /**
     * Action callback to go to the previous page.
     */
    public function goToPreviousPage()
    {
        if ($this->currentPage - 1 >= 1) {
            $this->changePage($this->currentPage - 1);
        }
    }

    /**
     * Action callback to go to the next page.
     */
    public function goToNextPage()
    {
        if ($this->currentPage + 1 <= $this->dataCollection->getLastPageNumber()) {
            $this->changePage($this->currentPage + 1);
        }
    }

    /**
     * Action callback to go to the last page.
     */
    public function goToLastPage()
    {
        $this->changePage($this->dataCollection->getLastPageNumber());
    }

    /**
     * Handle page change & refresh user window.
     *
     * @param integer $page
     */
    protected function changePage($page)
    {
        $this->currentPage = $page;
        $this->manialinkFactory->update($this->manialink->getUserGroup());
    }
}