Bluz\Crud\AbstractCrud

Complexity

Total Complexity

14

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

50%

Importance

Changes	2
Bugs	0	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	9	2
	getPrimaryKey()	0	1	?
A	readOne()	0	4	1
A	readSet()	0	4	1
A	createOne()	0	4	1
A	createSet()	0	4	1
A	updateOne()	0	4	1
A	updateSet()	0	4	1
A	deleteOne()	0	4	1
A	deleteSet()	0	4	1
B	getMethods()	0	28	4

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/framework
 */

/**
 * @namespace
 */
namespace Bluz\Crud;

use Bluz\Application\Exception\NotImplementedException;

/**
 * Crud
 *
 * @package  Bluz\Crud
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Crud
 */
abstract class AbstractCrud
{
    /**
     * Default limit for READ SET of elements
     */
    const DEFAULT_LIMIT = 10;

    /**
     * Get CRUD Instance
     *
     * @return static
     */
    public static function getInstance()
    {
        static $instance;
        if (null === $instance) {
            $instance = new static();
        }

        return $instance;
    }

    /**
     * Return primary key signature
     *
     * @return array
     */
    abstract public function getPrimaryKey();

    /**
     * Get item by primary key(s)
     *
     * @param  mixed $primary
     * @return mixed
     * @throws NotImplementedException
     */
    public function readOne($primary)
    {
        throw new NotImplementedException();
    }

    /**
     * Get collection of items
     *
     * @param  integer $offset
     * @param  integer $limit
     * @param  array $params
     * @param  null $total
     * @return mixed
     * @throws NotImplementedException
     */
    public function readSet($offset = 0, $limit = self::DEFAULT_LIMIT, $params = array(), &$total = null)

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

    {
        throw new NotImplementedException();
    }

    /**
     * Create new item
     *
     * @param  array $data
     * @return mixed
     * @throws NotImplementedException
     */
    public function createOne($data)
    {
        throw new NotImplementedException();
    }

    /**
     * Create items
     *
     * @param  array $data
     * @return mixed
     * @throws NotImplementedException
     */
    public function createSet($data)
    {
        throw new NotImplementedException();
    }

    /**
     * Update item
     *
     * @param  mixed $primary
     * @param  array $data
     * @return integer
     * @throws NotImplementedException
     */
    public function updateOne($primary, $data)
    {
        throw new NotImplementedException();
    }

    /**
     * Update items
     *
     * @param  array $data
     * @return integer
     * @throws NotImplementedException
     */
    public function updateSet($data)
    {
        throw new NotImplementedException();
    }

    /**
     * Delete item
     *
     * @param  mixed $primary
     * @return integer
     * @throws NotImplementedException
     */
    public function deleteOne($primary)
    {
        throw new NotImplementedException();
    }

    /**
     * Delete items
     *
     * @param  array $data
     * @return integer
     * @throws NotImplementedException
     */
    public function deleteSet($data)
    {
        throw new NotImplementedException();
    }

    /**
     * Get realized methods
     *
     * @return array
     */
    public function getMethods()
    {
        $reflection = new \ReflectionObject($this);
        $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);

        $available = array();
        $allow = [
            'readOne',
            'readSet',
            'createOne',
            'createSet',
            'updateOne',
            'updateSet',
            'deleteOne',
            'deleteSet',
        ];

        foreach ($methods as $method) {
            $className = $method->getDeclaringClass()->getName();
            $methodName = $method->getName();

            if (__CLASS__ != $className && in_array($methodName, $allow)) {
                $available[] = $methodName;
            }
        }

        return $available;
    }
}