BurningFlipside /
CommonCode
These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
| 1 | <?php |
||
| 2 | namespace Http\Rest; |
||
| 3 | |||
| 4 | use \Psr\Http\Message\ServerRequestInterface as Request; |
||
| 5 | use \Psr\Http\Message\ResponseInterface as Response; |
||
| 6 | |||
| 7 | require 'vendor/autoload.php'; |
||
| 8 | |||
| 9 | class DataTableAPI extends RestAPI |
||
| 10 | { |
||
| 11 | protected $dataSetName; |
||
| 12 | protected $dataTableName; |
||
| 13 | protected $primaryKeyName; |
||
| 14 | |||
| 15 | public function __construct($dataSetName, $dataTableName, $primaryKeyName = false) |
||
| 16 | { |
||
| 17 | $this->dataSetName = $dataSetName; |
||
| 18 | $this->dataTableName = $dataTableName; |
||
| 19 | $this->primaryKeyName = $primaryKeyName; |
||
| 20 | } |
||
| 21 | |||
| 22 | public function setup($app) |
||
| 23 | { |
||
| 24 | $app->get('[/]', array($this, 'readEntries')); |
||
| 25 | $app->post('[/]', array($this, 'createEntry')); |
||
| 26 | if($this->primaryKeyName !== false) |
||
| 27 | { |
||
| 28 | $app->get('/{name}[/]', array($this, 'readEntry')); |
||
| 29 | $app->patch('/{name}[/]', array($this, 'updateEntry')); |
||
| 30 | $app->delete('/{name}[/]', array($this, 'deleteEntry')); |
||
| 31 | } |
||
| 32 | } |
||
| 33 | |||
| 34 | protected function getDataTable() |
||
| 35 | { |
||
| 36 | return \DataSetFactory::getDataTableByNames($this->dataSetName, $this->dataTableName); |
||
| 37 | } |
||
| 38 | |||
| 39 | protected function canRead($request) |
||
| 40 | { |
||
| 41 | $this->validateLoggedIn($request); |
||
| 42 | //validateLoggedIn is fatal if not logged in... |
||
| 43 | return true; |
||
| 44 | } |
||
| 45 | |||
| 46 | protected function canCreate($request) |
||
|
0 ignored issues
–
show
|
|||
| 47 | { |
||
| 48 | //Must be overriden in a child class to allow create |
||
| 49 | return false; |
||
| 50 | } |
||
| 51 | |||
| 52 | protected function canUpdate($request, $entity) |
||
|
0 ignored issues
–
show
|
|||
| 53 | { |
||
| 54 | //Must be overriden in a child class to allow update |
||
| 55 | return false; |
||
| 56 | } |
||
| 57 | |||
| 58 | protected function canDelete($request, $entity) |
||
|
0 ignored issues
–
show
|
|||
| 59 | { |
||
| 60 | //Must be overriden in a child class to allow update |
||
| 61 | return false; |
||
| 62 | } |
||
| 63 | |||
| 64 | protected function getFilterForPrimaryKey($value) |
||
| 65 | { |
||
| 66 | return new \Data\Filter($this->primaryKeyName." eq '$value'"); |
||
| 67 | } |
||
| 68 | |||
| 69 | protected function manipulateParameters($request, &$odata) |
||
|
0 ignored issues
–
show
|
|||
| 70 | { |
||
| 71 | return false; |
||
| 72 | } |
||
| 73 | |||
| 74 | protected function validateCreate(&$obj, $request) |
||
|
0 ignored issues
–
show
|
|||
| 75 | { |
||
| 76 | return true; |
||
| 77 | } |
||
| 78 | |||
| 79 | protected function validateUpdate(&$newObj, $request, $oldObj) |
||
|
0 ignored issues
–
show
|
|||
| 80 | { |
||
| 81 | return true; |
||
| 82 | } |
||
| 83 | |||
| 84 | public function readEntries($request, $response, $args) |
||
|
0 ignored issues
–
show
|
|||
| 85 | { |
||
| 86 | if($this->canRead($request) === false) |
||
| 87 | { |
||
| 88 | return $response->withStatus(401); |
||
| 89 | } |
||
| 90 | $dataTable = $this->getDataTable(); |
||
| 91 | $odata = $request->getAttribute('odata', new \ODataParams(array())); |
||
| 92 | $params = $this->manipulateParameters($request, $odata); |
||
| 93 | $areas = $dataTable->read($odata->filter, $odata->select, $odata->top, |
||
| 94 | $odata->skip, $odata->orderby, $params); |
||
| 95 | if($areas === false) |
||
| 96 | { |
||
| 97 | $areas = array(); |
||
| 98 | } |
||
| 99 | if(method_exists($this, 'processEntry')) |
||
| 100 | { |
||
| 101 | $count = count($areas); |
||
| 102 | for($i = 0; $i < $count; $i++) |
||
| 103 | { |
||
| 104 | $areas[$i] = $this->processEntry($areas[$i], $request); |
||
|
0 ignored issues
–
show
The method
processEntry() does not seem to exist on object<Http\Rest\DataTableAPI>.
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
|
|||
| 105 | } |
||
| 106 | } |
||
| 107 | return $response->withJson($areas); |
||
| 108 | } |
||
| 109 | |||
| 110 | public function createEntry($request, $response, $args) |
||
|
0 ignored issues
–
show
|
|||
| 111 | { |
||
| 112 | if($this->canCreate($request) === false) |
||
| 113 | { |
||
| 114 | return $response->withStatus(401); |
||
| 115 | } |
||
| 116 | $dataTable = $this->getDataTable(); |
||
| 117 | $obj = $request->getParsedBody(); |
||
| 118 | if($this->validateCreate($obj, $request) === false) |
||
| 119 | { |
||
| 120 | return $response->withStatus(400); |
||
| 121 | } |
||
| 122 | $ret = $dataTable->create($obj); |
||
| 123 | return $response->withJson($ret); |
||
| 124 | } |
||
| 125 | |||
| 126 | public function readEntry($request, $response, $args) |
||
| 127 | { |
||
| 128 | if($this->canRead($request) === false) |
||
| 129 | { |
||
| 130 | return $response->withStatus(401); |
||
| 131 | } |
||
| 132 | $dataTable = $this->getDataTable(); |
||
| 133 | $odata = $request->getAttribute('odata', new \ODataParams(array())); |
||
| 134 | $filter = $this->getFilterForPrimaryKey($args['name']); |
||
| 135 | $areas = $dataTable->read($filter, $odata->select, $odata->top, |
||
| 136 | $odata->skip, $odata->orderby); |
||
| 137 | if(empty($areas)) |
||
| 138 | { |
||
| 139 | return $response->withStatus(404); |
||
| 140 | } |
||
| 141 | if(method_exists($this, 'processEntry')) |
||
| 142 | { |
||
| 143 | $areas[0] = $this->processEntry($areas[0], $request); |
||
|
0 ignored issues
–
show
The method
processEntry() does not seem to exist on object<Http\Rest\DataTableAPI>.
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
|
|||
| 144 | } |
||
| 145 | return $response->withJson($areas[0]); |
||
| 146 | } |
||
| 147 | |||
| 148 | public function updateEntry($request, $response, $args) |
||
| 149 | { |
||
| 150 | if($this->canRead($request) === false) |
||
| 151 | { |
||
| 152 | return $response->withStatus(401); |
||
| 153 | } |
||
| 154 | $filter = $this->getFilterForPrimaryKey($args['name']); |
||
| 155 | $dataTable = $this->getDataTable(); |
||
| 156 | $entry = $dataTable->read($filter); |
||
| 157 | if(empty($entry)) |
||
| 158 | { |
||
| 159 | return $response->withStatus(404); |
||
| 160 | } |
||
| 161 | if($this->canUpdate($request, $entry) === false) |
||
| 162 | { |
||
| 163 | return $response->withStatus(401); |
||
| 164 | } |
||
| 165 | $obj = $request->getParsedBody(); |
||
| 166 | if($this->validateUpdate($obj, $request, $entry) === false) |
||
| 167 | { |
||
| 168 | return $response->withStatus(400); |
||
| 169 | } |
||
| 170 | $ret = $dataTable->update($filter, $obj); |
||
| 171 | return $response->withJson($ret); |
||
| 172 | } |
||
| 173 | |||
| 174 | public function deleteEntry($request, $response, $args) |
||
| 175 | { |
||
| 176 | if($this->canRead($request) === false) |
||
| 177 | { |
||
| 178 | return $response->withStatus(401); |
||
| 179 | } |
||
| 180 | $filter = $this->getFilterForPrimaryKey($args['name']); |
||
| 181 | $dataTable = $this->getDataTable(); |
||
| 182 | $entry = $dataTable->read($filter); |
||
| 183 | if(empty($entry)) |
||
| 184 | { |
||
| 185 | return $response->withStatus(404); |
||
| 186 | } |
||
| 187 | if($this->canDelete($request, $entry) === false) |
||
| 188 | { |
||
| 189 | return $response->withStatus(401); |
||
| 190 | } |
||
| 191 | $ret = $dataTable->delete($filter); |
||
| 192 | return $response->withJson($ret); |
||
| 193 | } |
||
| 194 | } |
||
| 195 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.