Bluz\Crud\AbstractCrud

Complexity

Total Complexity

15

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

96.97%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
	getPrimaryKey()	0	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
A	readOne()	0	4	1
A	getFields()	0	4	1
A	setFields()	0	4	1
A	filterData()	0	7	2
A	filterRow()	0	13	3

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

declare(strict_types=1);

namespace Bluz\Crud;

use Bluz\Common\Instance;
use Bluz\Db\RowInterface;
use Bluz\Http\Exception\NotImplementedException;

/**
 * Crud
 *
 * @package  Bluz\Crud
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Crud
 */
abstract class AbstractCrud implements CrudInterface
{
    use Instance;

    /**
     * @var array Fields for action
     * @todo should be different for Create, Read and Update
     */
    protected $fields = [];

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

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function readOne($primary)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function readSet($offset = 0, $limit = self::DEFAULT_LIMIT, $params = [])
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function createOne($data)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function createSet($data)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function updateOne($primary, $data)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function updateSet($data)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function deleteOne($primary)
    {
        throw new NotImplementedException;
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotImplementedException
     */
    public function deleteSet($data)
    {
        throw new NotImplementedException;
    }

    /**
     * @return array
     */
    public function getFields() : array
    {
        return $this->fields;
    }

    /**
     * @param array $fields
     */
    public function setFields(array $fields) : void
    {
        $this->fields = $fields;
    }

    /**
     * Filter input Fields
     *
     * @param array $data Request
     *
     * @return array
     */
    protected function filterData($data) : array
    {
        if (empty($this->getFields())) {
            return $data;
        }
        return array_intersect_key($data, array_flip($this->getFields()));
    }

    /**
     * Filter output Row
     *
     * @param RowInterface $row from database
     *
     * @return RowInterface
     */
    protected function filterRow(RowInterface $row) : RowInterface
    {
        if (empty($this->getFields())) {
            return $row;
        }
        $fields = array_keys($row->toArray());
        $toDelete = array_diff($fields, $this->getFields());

        foreach ($toDelete as $field) {
            unset($row->$field);
        }
        return $row;
    }
}