Bdf\Prime\Query\Pagination\AbstractPaginator

Complexity

Total Complexity

55

Size/Duplication

Total Lines	421
Duplicated Lines	0 %

Test Coverage

Coverage

46.77%

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	contains()	0	7	2
A	query()	0	3	1
A	collection()	0	3	1
A	isEmpty()	0	7	2
A	put()	0	9	2
A	buildSize()	0	10	3
A	offsetUnset()	0	3	1
A	pushAll()	0	9	2
A	keys()	0	7	2
A	all()	0	7	2
A	get()	0	7	2
A	groupBy()	0	9	2
A	indexOf()	0	7	2
A	page()	0	3	1
A	order()	0	9	3
A	count()	0	3	1
A	sort()	0	9	2
A	has()	0	7	2
A	map()	0	9	2
A	pageMaxRows()	0	3	1
A	offsetGet()	0	3	1
A	clear()	0	9	2
A	filter()	0	9	2
A	offsetExists()	0	3	1
A	loadCollection()	0	7	2
A	offset()	0	3	1
A	size()	0	7	2
A	offsetSet()	0	3	1
A	limit()	0	3	1
A	remove()	0	9	2
A	merge()	0	9	2
A	push()	0	9	2

<?php

namespace Bdf\Prime\Query\Pagination;

use Bdf\Prime\Collection\CollectionInterface;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\PrimeSerializable;
use Bdf\Prime\Query\QueryInterface;

/**
 * Abstract paginator
 * 
 * Provide method for pagination

Doc comment long description must end with a full stop

 * 
 * @author  Seb

@author tag is not allowed in class comment

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 1 space but found 2

 * @package Bdf\Prime\Query\Pagination

@package tag is not allowed in class comment

There must be a single blank line after a tag group

 * 
 * 
 * @todo retourner une nouvelle instance du paginator sur les methodes de collection ?

Comment refers to a TODO task

@todo tag is not allowed in class comment

 */
abstract class AbstractPaginator extends PrimeSerializable
{
    const DEFAULT_PAGE  = 1;
    const DEFAULT_LIMIT = 20;
    
    /**
     * Current query
     * 
     * @var QueryInterface
     */
    protected $query;
    
    /**
     * Current collection
     * 
     * @var array|CollectionInterface
     */
    protected $collection = [];
    
    /**
     * Total size of the collection
     * 
     * @var int 

Expected "integer" but found "int" for @var tag in member variable comment

Expected "int" but found "int " for @var tag in member variable comment

     */
    protected $size;
    
    /**
     * Current page
     * 
     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    protected $page;
    
    /**
     * Number of entities loaded in the collection
     * 
     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    protected $maxRows;
    
    
    /**
     * {@inheritdoc}
     */
    public function collection()

Expected 1 blank line before function; 2 found

    {
        return $this->collection;
    }
    
    /**
     * Get the query
     * 
     * @return QueryInterface
     */
    public function query()
    {
        return $this->query;
    }
    
    /**
     * Load entities
     *
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    protected function loadCollection()
    {
        if ($this->maxRows > -1) {
            $this->query->limitPage($this->page, $this->maxRows);

The method limitPage() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

        }
        
        $this->collection = $this->query->all();
    }
    
    /**

Parameter $attribute should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function order($attribute = null)
    {
        $orders = $this->query->getOrders();

The method getOrders() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

        
        if ($attribute === null) {
            return $orders;
        }
        
        return isset($orders[$attribute]) ? $orders[$attribute] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function limit()
    {
        return $this->query->getLimit();

The method getLimit() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

    }

    /**
     * {@inheritdoc}
     */
    public function offset()
    {
        return $this->query->getOffset();

The method getOffset() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

    }

    /**
     * {@inheritdoc}
     */
    public function page()
    {
        return $this->query->getPage();

The method getPage() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

    }

    /**
     * {@inheritdoc}
     */
    public function pageMaxRows()
    {
        return $this->query->getLimit();
    }
    
    /**
     * {@inheritdoc}
     */
    public function size()
    {
        if ($this->size === null) {
            $this->buildSize();
        }
        
        return $this->size;
    }
    
    /**
     * Find size of the collection
     */
    protected function buildSize()
    {
        $currentSize = $this->count();
            
        if (!$this->query->isLimitQuery()) {

The method isLimitQuery() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

            $this->size = $currentSize;
        } elseif ($currentSize + $this->query->getOffset() < $this->query->getLimit()) {

Usage of ELSEIF not allowed; use ELSE IF instead

Operation must be bracketed

            $this->size = $currentSize + $this->query->getOffset();

Operation must be bracketed

        } else {
            $this->size = $this->query->paginationCount();

The method paginationCount() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

        }
    }
    
    /**
     * SPL - Countable
     *
     * {@inheritdoc}
     */
    public function count()
    {
        return count($this->collection);
    }
    
    //--------- collection interface

No space found before comment text; expected "// --------- collection interface" but found "//--------- collection interface"

    
    /**

Parameter $items should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function pushAll(array $items)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection->pushAll($items);
        
        return $this;
    }
    
    /**

Parameter $item should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function push($item)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection->push($item);
        
        return $this;
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

Parameter $item should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function put($key, $item)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection->put($key, $item);
        
        return $this;
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

     * SPL - ArrayAccess
     *
     * {@inheritdoc}
     */
    public function offsetSet($key, $value)
    {
        $this->collection[$key] = $value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function all()
    {
        if (!($this->collection instanceof CollectionInterface)) {
            return $this->collection;
        }
        
        return $this->collection->all();
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

Parameter $default should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function get($key, $default = null)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->get($key, $default);
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

     * SPL - ArrayAccess
     *
     * {@inheritdoc}
     */
    public function offsetGet($key)
    {
        return $this->collection[$key];
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function has($key)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->has($key);
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

     * SPL - ArrayAccess
     *
     * {@inheritdoc}
     */
    public function offsetExists($key)
    {
        return isset($this->collection[$key]);
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function remove($key)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection->remove($key);
        
        return $this;
    }
    
    /**

Parameter $key should have a doc-comment as per coding-style.

     * SPL - ArrayAccess
     *
     * {@inheritdoc}
     */
    public function offsetUnset($key)
    {
        unset($this->collection[$key]);
    }
    
    /**
     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function clear()
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection->clear();
        
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function keys()
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->keys();
    }
    
    /**
     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function isEmpty()
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->isEmpty();
    }
    
    /**

Parameter $callback should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function map($callback)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection = $this->collection->map($callback);
        
        return $this;
    }
    
    /**

Parameter $callback should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function filter($callback = null)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection = $this->collection->filter($callback);
        
        return $this;
    }
    
    /**

Parameter $groupBy should have a doc-comment as per coding-style.

Parameter $mode should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function groupBy($groupBy, $mode = PaginatorInterface::GROUPBY)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection = $this->collection->groupBy($groupBy, $mode);
        
        return $this;
    }
    
    /**

Parameter $element should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function contains($element)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->contains($element);
    }
    
    /**

Parameter $value should have a doc-comment as per coding-style.

Parameter $strict should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function indexOf($value, $strict = false)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        return $this->collection->indexOf($value, $strict);
    }
    
    /**

Parameter $items should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function merge($items)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection = $this->collection->merge($items);
        
        return $this;
    }
    
    /**

Parameter $callback should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function sort(callable $callback = null)
    {
        if (!($this->collection instanceof CollectionInterface)) {
            throw new \LogicException('Collection is not an instance of CollectionInterface. Could not call method ' . __METHOD__);
        }
        
        $this->collection = $this->collection->sort($callback);
        
        return $this;
    }
}