samsoncms\api\renderable\FieldsTable

Complexity

Total Complexity

11

Size/Duplication

Total Lines	123
Duplicated Lines	4.07 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	7
Bugs	3	Features	3

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	indexView()	0	5	1
A	rowView()	0	5	1
A	renderRow()	0	4	1
A	renderIndex()	0	6	1
A	render()	5	21	4
A	__toString()	0	4	1
A	toView()	0	4	1

<?php
/**
 * Created by Vitaly Iegorov <egorov@samsonos.com>.
 * on 10.02.16 at 18:15
 */
namespace samsoncms\api\renderable;

use samsoncms\api\field\Row;
use samsonframework\core\RenderInterface;
use samsonframework\core\ViewInterface;
use samsonframework\orm\QueryInterface;

/**
 * Renderable fields table.
 * Class should be used to simplify additional field tables rendering.
 * If your additional fields table has special logic just extend this class
 * and change any ot its method.
 *
 * @see \samsoncms\api\FieldsTable This class is just a wrapper with rendering
 *
 * @package samsoncms\api\renderable
 */
class FieldsTable extends \samsoncms\api\field\Table implements RenderInterface
{
    /** Name of the rows variable in index view */
    const ROWS_VIEW_VARIABLE = 'rows';

    /** Name of the row prefix for variable in row view */
    const ROW_VIEW_VARIABLE = 'row';

    /** @var string|callable Block view file or callback */
    protected $indexView = 'index';

    /** @var string|callable Row view file or callback */
    protected $rowView = 'row';

    /** @var ViewInterface */
    protected $renderer;

    /**
     * GeneralInfo constructor.
     *
     * @param QueryInterface $query
     * @param ViewInterface $renderer
     * @param int[] $navigationID Collection of entity navigation identifiers
     * @param int $entityID Entity identifier
     * @param string|null $locale Table localization
     */
    public function __construct(QueryInterface $query, ViewInterface $renderer, $navigationID, $entityID, $locale = null)
    {
        // Store renderer
        $this->renderer = $renderer;

        parent::__construct($query, $navigationID, $entityID, $locale);
    }

    /**
     * Set index view path.
     * @param string|callable $indexView Index view path or callback
     * @return $this Chaining
     */
    public function indexView($indexView)
    {
        $this->indexView = $indexView;
        return $this;
    }
    /**
     * Set row view path.
     * @param string|callable $rowView Row view path or callback
     * @return $this Chaining
     */
    public function rowView($rowView)
    {
        $this->rowView = $rowView;
        return $this;
    }

    /**
     * Render table row.
     *
     * @param Row $row Collection of column values.
     *
     * @return string Rendered HTML
     */
    public function renderRow(Row $row)
    {
        return $this->renderer->view($this->rowView)->set($row, self::ROW_VIEW_VARIABLE)->output();

$this->rowView is of type callable, but the function expects a string.

$row is of type object<samsoncms\api\field\Row>, but the function expects a string.

    }

    /**
     * Render table row.
     *
     * @param string $items Collection of rendered rows.
     *
     * @return string Rendered HTML
     */
    public function renderIndex($items)
    {
        return $this->renderer->view($this->indexView)

$this->indexView is of type callable, but the function expects a string.

            ->set($items, self::ROWS_VIEW_VARIABLE)
            ->output();
    }

    /** @return string Rendered HTML for fields table */
    public function render()
    {
        $html = '';
        foreach ($this->collection as $row) {
            // Call external handler
            if (is_callable($this->rowView)) {

This code seems to be duplicated across your project.

                $html .= call_user_func($this->rowView, $row, $this->renderer, $this->query, $this->collection);
            } else { // Call default renderer
                $html .= $this->renderRow($row);
            }
        }

        // Call external handler
        if (is_callable($this->indexView)) {
            $html = call_user_func($this->indexView, $html, $this->renderer, $this->query, $this->collection);
        } else { // Call default renderer
            $html = $this->renderIndex($html);
        }

        return $html;
    }

    /** @return string Rendered fields table */
    public function __toString()
    {
        return $this->render();
    }

    /**
     * Prepare fields table for rendering in the view.
     *
     * @param string|null $prefix Prefix to be added to view variables
     * @param array $restricted Collection of fields to be restricted
     *
     * @return array Collection of view variables for rendering
     */
    public function toView($prefix = null, array $restricted = array())
    {
        return array_diff_key(array($prefix.'html' => $this->render()), $restricted);
    }
}