CrossKnowledge\DataTableBundle\DataTable\Table\AbstractTable

Complexity

Total Complexity

26

Size/Duplication

Total Lines	287
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Test Coverage

Coverage

64.52%

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	2
A	setOptions()	0	4	1
A	getOptions()	0	4	1
A	buildFilterForm()	0	4	1
A	getAjaxAdditionalParameters()	0	4	1
A	getOutputRows()	0	10	2
A	getClientSideColumns()	0	10	2
A	handleRequest()	0	4	1
A	getCurrentRequest()	0	4	1
A	getFilterForm()	0	11	2
	buildColumns()	0	1	?
	getDataIterator()	0	1	?
	getUnfilteredCount()	0	1	?
	getFilteredCount()	0	1	?
A	setDefaultOptions()	0	13	1
A	configureOptions()	0	1	1
A	buildView()	0	19	4
A	setFormatter()	0	4	1
A	getTableId()	0	4	1
A	getColumns()	0	7	2
A	initColumnsDefinitions()	0	9	1
A	setTableId()	0	4	1

<?php
namespace CrossKnowledge\DataTableBundle\DataTable\Table;

use CrossKnowledge\DataTableBundle\DataTable\ColumnBuilder;
use CrossKnowledge\DataTableBundle\DataTable\Formatter\FormatterInterface;
use CrossKnowledge\DataTableBundle\DataTable\Table\Layout\Bootstrap;
use CrossKnowledge\DataTableBundle\DataTable\Table\Layout\DataTableLayoutInterface;
use CrossKnowledge\DataTableBundle\Table\Element\Column;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Form\FormFactory;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Routing\Router;
use CrossKnowledge\DataTableBundle\DataTable\Request\PaginateRequest;
use Symfony\Component\Security\Core\Authorization\AuthorizationChecker;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

abstract class AbstractTable
{
    const VIEW_CONTEXT   = 'view';
    
    /**
     * @var Router
     */
    protected $router;
    /**
     * @var PaginateRequest
     */
    protected $currentRequest;
    /**
     * @var FormFactory
     */
    protected $formFactory;
    /**
     * @var Form
     */
    protected $filterForm;
    /**
     * @var AuthorizationChecker
     */
    protected $authorizationChecker;

    /**
     * @var Column[]
     */
    protected $columns = array();
    protected $columnsInitialized = array();

    /**
     * @var OptionsResolver
     */
    protected $optionsResolver;

    /**
     * @var array Key value array of options
     */
    protected $options = [];

    /**
     * @var DataTableLayoutInterface
     */
    protected $layout;
    /**
     * @param FormFactory $formFactory
     * @param Router $router
     */
    public function __construct(
        FormFactory $formFactory,
        AuthorizationCheckerInterface $checker,
        Router $router,
        FormatterInterface $formatter,
        DataTableLayoutInterface $layout = null
    ) {
        $this->formFactory = $formFactory;
        $this->router = $router;
        $this->formatter = $formatter;

The property formatter does not exist. Did you maybe forget to declare it?

        $this->authorizationChecker = $checker;

$checker is of type object<Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface>, but the property $authorizationChecker was declared to be of type object<Symfony\Component\Security\Core\Authorization\AuthorizationChecker>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        $this->layout = null === $layout ? new Bootstrap() : $layout;
        $this->optionsResolver = new OptionsResolver();
        //$this->initColumnsDefinitions();
        $this->setDefaultOptions($this->optionsResolver);
        $this->configureOptions($this->optionsResolver);
        $this->options = $this->optionsResolver->resolve();
    }
    /**
     *
     * Example implementation

    public function buildColumns(ColumnBuilder $builder)
    {
        $builder->add('Learner.FirstName', new Column('First name title', ['width' => '20%']))
                ->add('Learner.Name', new Column('Last name'));
    }
     *
     * @return array key must be the column field name,
     *               value must be an array of options for https://datatables.net/reference/option/columns
     */
    abstract public function buildColumns(ColumnBuilder $builder, $context = self::VIEW_CONTEXT);
    /**
     * Must return a \Traversable a traversable element that must contain for each element an ArrayAccess such as
     *      key(colname) => value(db value)
     *
     * The filter should be used there.
     *
     * Example of the expected return
    return [
        'first_name' => 'John',
        'last_name' => 'Doe'
    ];
     * Example:
    return new \PropelCollection();
     *
     * @return \Traversable
     */
    abstract public function getDataIterator();
    /**
     * @return int the total number of rows regardless of filters
     */
    abstract public function getUnfilteredCount();
    /**
     * @return int|false if there is no such count
     */
    abstract public function getFilteredCount();

    private final function setDefaultOptions(OptionsResolver $resolver)

As per PSR2, final should precede the visibility keyword.

    {
        $resolver->setDefaults([
            'layout' => $this->layout,
            'client_side_filtering' => false,
            'filter_reload_table_on_change' => false,
            'template' => 'CrossKnowledgeDataTableBundle::default_table.html.twig',
            'data_table_custom_options' => [],
            'has_filter_form' => function() {

Expected 1 space after FUNCTION keyword; 0 found

                return $this->getFilterForm()->count()>1;
            }
        ]);
    }
    /**
     * Configure the table options
     *
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver){}

The parameter $resolver is not used and could be removed.

    /**
     * @return array
     */
    public function setOptions(array $options)
    {
        $this->options = $this->optionsResolver->resolve(array_merge($this->options, $options));
    }
    /**
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }
    /**
     * Build the filter form
     *
     * @param FormBuilder $builder
     *
     * @return FormBuilder
     */
    public function buildFilterForm(FormBuilder $builder)
    {
        return $builder;
    }
    /**
     * @return string
     */
    public function getAjaxAdditionalParameters()
    {
        return [];
    }
    /**
     * @return string[] should return the content to insert in the rows key(colname) => value(string / html / any)
     */
    public function getOutputRows($context = self::VIEW_CONTEXT)
    {
        $t = [];
        foreach ($this->getDataIterator() as $item) {
            $formatted = $this->formatter->formatRow($item,  $this, $context);

Expected 1 space instead of 2 after comma in function call.

            $t[] = $formatted;
        }

        return $t;
    }
    
    /**
     * @see getColumns() same as getColumns but filtered for datatable JS API
     */
    public function getClientSideColumns($context = self::VIEW_CONTEXT)
    {
        $columns = $this->getColumns($context);
        $clientSideCols = [];
        foreach ($columns as $colid=>$column) {

Expected 1 space before "=>"; 0 found

Expected 1 space after "=>"; 0 found

            $clientSideCols[$colid] = $column->getClientSideDefinition();
        }

        return $clientSideCols;
    }
    /**
     * @param Request $request
     */
    public function handleRequest(Request $request)
    {
        $this->currentRequest = PaginateRequest::fromHttpRequest($request, $this);
    }
    /**
     * @return PaginateRequest
     */
    public function getCurrentRequest()
    {
        return $this->currentRequest;
    }
    /**
     * @return Form|\Symfony\Component\Form\Form
     */
    public function getFilterForm()
    {
        if (null===$this->filterForm) {
            $this->filterForm = $this->buildFilterForm(

It seems like $this->buildFilterForm($this->formFactory->createNamedBuilder($this->getTableId() . '_filter')->add('dofilter', 'button'))->getForm() of type object<Symfony\Component\Form\Form> is incompatible with the declared type object<CrossKnowledge\DataTableBundle\DataTable\Table\Form> of property $filterForm.

                $this->formFactory->createNamedBuilder($this->getTableId().'_filter')

$this->formFactory->createNamedBuilder($this->getTableId() . '_filter')->add('dofilter', 'button') of type object<Symfony\Component\Form\FormBuilderInterface> is not a sub-type of object<Symfony\Component\Form\FormBuilder>. It seems like you assume a concrete implementation of the interface Symfony\Component\Form\FormBuilderInterface to be always present.

                    ->add('dofilter', 'button')
            )->getForm();
        }

        return $this->filterForm;
    }    
    /**
     * @param bool $loadData
     * @return array key value of variables accessible for renderers.
     */
    public function buildView($loadData = true)
    {
        $viewParameters = [
            'columns' => $this->getClientSideColumns(),
            'data'   => [],
            'datatable' => $this,
            'unfilteredRowsCount' => false,
            'filteredRowsCount' => false,
        ];
        if (!$this->getOptions()['has_filter_form'] || $loadData) {
            $viewParameters['data'] = $this->getOutputRows();
            $viewParameters['unfilteredRowsCount'] = $this->getUnfilteredCount();
            $viewParameters['filteredRowsCount'] = $this->getFilteredCount();
        }
        else if ($this->getOptions()['has_filter_form']) {
            $viewParameters['filterForm'] = $this->getFilterForm()->createView();
        }
        return $viewParameters;
    }

    /**
     * Sets the formatter
     *
     * @param FormatterInterface $formatter
     *
     * @return void
     */
    public function setFormatter(FormatterInterface $formatter)
    {
        $this->formatter = $formatter;
    }
    /**
     * @return string a table idenfitier that will be used for ajax requests
     */
    public final function getTableId()

As per PSR2, final should precede the visibility keyword.

    {
        return $this->tableId;

The property tableId does not exist. Did you maybe forget to declare it?

    }
    /**
     * @return \CrossKnowledge\DataTableBundle\Table\Element\Column[]
     */
    public function getColumns($context = self::VIEW_CONTEXT)
    {
        if(!array_key_exists($context, $this->columns)) {

Expected 1 space after IF keyword; 0 found

            $this->initColumnsDefinitions($context);
        }
        return $this->columns[$context];
    }
    /**
     * Builds the columns definition
     */
    protected function initColumnsDefinitions($context = self::VIEW_CONTEXT)
    {
        $builder = new ColumnBuilder();

        $this->buildColumns($builder, $context);

        $this->columns[$context] = $builder->getColumns();
        $this->columnsInitialized[$context] =  true;
    }
    /**
     * Sets the table identifier
     *
     * @return null
     */
    public final function setTableId($id)

As per PSR2, final should precede the visibility keyword.

    {
        $this->tableId = $id;
    }
}