Http\Rest\DataTableAPI

Complexity

Total Complexity

42

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setup()	0	11	2
A	getDataTable()	0	4	1
A	canRead()	0	6	1
A	canCreate()	0	5	1
A	canUpdate()	0	5	1
A	canDelete()	0	5	1
A	getFilterForPrimaryKey()	0	4	1
A	manipulateParameters()	0	4	1
A	validateCreate()	0	4	1
A	validateUpdate()	0	4	1
A	postDeleteAction()	0	4	1
B	readEntries()	0	30	6
A	createEntry()	0	19	4
A	readEntry()	0	21	4
B	updateEntry()	0	39	9
B	deleteEntry()	0	28	6

<?php
namespace Http\Rest;

use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

require 'vendor/autoload.php';

class DataTableAPI extends RestAPI
{
    protected $dataSetName;
    protected $dataTableName;
    protected $primaryKeyName;

    /**
     * Create the DataTableAPI for the given DataTable info
     *
     * @param string $datSetName The name of the DataSet used in the Settings

There is no parameter named $datSetName. Did you maybe mean $dataSetName?

     * @param string $dataTableName The name of the table in the DataSet
     * @param string|false $primaryKeyName The table primary key. Must be specified for update/delete capable tables
     */
    public function __construct($dataSetName, $dataTableName, $primaryKeyName = false)
    {
        $this->dataSetName    = $dataSetName;
        $this->dataTableName  = $dataTableName;
        $this->primaryKeyName = $primaryKeyName;
    }

    public function setup($app)
    {
        $app->get('[/]', array($this, 'readEntries'));
        $app->post('[/]', array($this, 'createEntry'));
        if($this->primaryKeyName !== false)
        {
            $app->get('/{name}[/]', array($this, 'readEntry'));
            $app->patch('/{name}[/]', array($this, 'updateEntry'));
            $app->delete('/{name}[/]', array($this, 'deleteEntry'));
        }
    }

    protected function getDataTable()
    {
        return \DataSetFactory::getDataTableByNames($this->dataSetName, $this->dataTableName);
    }

    protected function canRead($request)
    {
        $this->validateLoggedIn($request);
        //validateLoggedIn is fatal if not logged in...
        return true;
    }

    protected function canCreate($request)

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

    {
        //Must be overriden in a child class to allow create
        return false;
    }

    protected function canUpdate($request, $entity)

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

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

    {
        //Must be overriden in a child class to allow update
        return false;
    }

    protected function canDelete($request, $entity)

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

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

    {
        //Must be overriden in a child class to allow update
        return false;
    }

    protected function getFilterForPrimaryKey($value)
    {
        return new \Data\Filter($this->primaryKeyName." eq '$value'");
    }

    protected function manipulateParameters($request, &$odata)

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

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

    {
        return false;
    }

    protected function validateCreate(&$obj, $request)

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

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

    {
        return true;
    }

    protected function validateUpdate(&$newObj, $request, $oldObj)

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

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

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

    {
        return true;
    }

    protected function postDeleteAction($entry)

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

    {
        return true;
    }

    public function readEntries($request, $response, $args)

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

    {
        if($this->canRead($request) === false)
        {
            return $response->withStatus(401);
        }
        $dataTable = $this->getDataTable();
        $odata = $request->getAttribute('odata', new \ODataParams(array()));
        $params = $this->manipulateParameters($request, $odata);
        $areas = $dataTable->read($odata->filter, $odata->select, $odata->top,
                                  $odata->skip, $odata->orderby, $params);
        if($areas === false)
        {
            $areas = array();
        }
        if(method_exists($this, 'processEntry'))
        {
            $count = count($areas);
            for($i = 0; $i < $count; $i++)
            {
                $areas[$i] = $this->processEntry($areas[$i], $request);

The method processEntry() does not seem to exist on object<Http\Rest\DataTableAPI>.

            }
        }
        $areas = array_values(array_filter($areas));
        if($odata->count)
        {
            $areas = array('@odata.count'=>count($areas), 'value'=>$areas);
        }
        return $response->withJson($areas);
    }

    public function createEntry($request, $response, $args)

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

    {
        if($this->canCreate($request) === false)
        {
            return $response->withStatus(401);
        }
        $dataTable = $this->getDataTable();
        $obj = $request->getParsedBody();
        if($obj == NULL)
        {
            $obj = json_decode($request->getBody()->getContents(), true);
        }
        if($this->validateCreate($obj, $request) === false)
        {
            return $response->withStatus(400);
        }
        $ret = $dataTable->create($obj);
        return $response->withJson($ret);
    }

    public function readEntry($request, $response, $args)
    {
        if($this->canRead($request) === false)
        {
            return $response->withStatus(401);
        }
        $dataTable = $this->getDataTable();
        $odata = $request->getAttribute('odata', new \ODataParams(array()));
        $filter = $this->getFilterForPrimaryKey($args['name']);
        $areas = $dataTable->read($filter, $odata->select, $odata->top,
                                  $odata->skip, $odata->orderby);
        if(empty($areas))
        {
            return $response->withStatus(404);
        }
        if(method_exists($this, 'processEntry'))
        {
            $areas[0] = $this->processEntry($areas[0], $request);

The method processEntry() does not seem to exist on object<Http\Rest\DataTableAPI>.

        }
        return $response->withJson($areas[0]);
    }

    public function updateEntry($request, $response, $args)
    {
        if($this->canRead($request) === false)
        {
            return $response->withStatus(401);
        }
        $filter = $this->getFilterForPrimaryKey($args['name']);
        $dataTable = $this->getDataTable();
        $entry = $dataTable->read($filter);
        if(empty($entry))
        {
            return $response->withStatus(404);
        }
        if(count($entry) === 1 && isset($entry[0]))
        {
            $entry = $entry[0];
        }
        if($this->canUpdate($request, $entry) === false)
        {
            return $response->withStatus(401);
        }
        $obj = $request->getParsedBody();
        if($obj === null)
        {
            $request->getBody()->rewind();
            $obj = $request->getBody()->getContents();
            $tmp = json_decode($obj, true);
            if($tmp !== null)
            {
                $obj = $tmp;
            }
        }
        if($this->validateUpdate($obj, $request, $entry) === false)
        {
            return $response->withStatus(400);
        }
        $ret = $dataTable->update($filter, $obj);
        return $response->withJson($ret);
    }

    public function deleteEntry($request, $response, $args)
    {
        if($this->canRead($request) === false)
        {
            return $response->withStatus(401);
        }
        $filter = $this->getFilterForPrimaryKey($args['name']);
        $dataTable = $this->getDataTable();
        $entry = $dataTable->read($filter);
        if(empty($entry))
        {
            return $response->withStatus(404);
        }
        $count = count($entry);
        for($i = 0; $i < $count; $i++)
        {
            if($this->canDelete($request, $entry[$i]) === false)
            {
                return $response->withStatus(401);
            }
        }
        $ret = $dataTable->delete($filter);
        if($ret)
        {
            $ret = $this->postDeleteAction($entry);
        }
        return $response->withJson($ret);
    }
}