Mapper::put() - Code Metrics - vijinho/f3-cms - Measure and Improve Code Quality continuously with Scrutinizer

Mapper::put() A
last analyzed 2017-10-19 21:00 UTC

↳ Parent: Mapper

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	2
nop	2
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0

<?php

namespace FFCMS\Controllers\API;

use FFMVC\Helpers;
use FFCMS\{Traits, Models, Mappers};


/**
 * REST API Base Controller Class.
 *
 * @author Vijay Mahrra <[email protected]>
 * @copyright Vijay Mahrra
 * @license GPLv3 (http://www.gnu.org/licenses/gpl-3.0.html)
 */
abstract class Mapper extends API
{
    use Traits\Validation,
        Traits\SearchController;

    /**
     * For admin listing and search results
     */
    use Traits\SearchController;

    /**
     * @var object database class
     */
    protected $db;

    /**
     * @var string table in the db
     */
    protected $table = null;

    /**
     * @var string class name
     */
    protected $mapperClass;

    /**
     * @var \FFMVC\Mappers\Mapper mapper for class
     */
    protected $mapper;

    /**
     * is the user authorised for access?
     *
     * @var bool
     */
    protected $isAuthorised = false;

    /**
     * is the user authorised for access to the object type?
     *
     * @var bool
     */
    protected $adminOnly = true;


    /**
     * initialize
     * @param \Base $f3
     */
    public function __construct(\Base $f3)
    {
        parent::__construct();

        // guess the table name from the class name if not specified as a class member
        $class = \UTF::instance()->substr(strrchr(get_class($this), '\\'),1);
        $this->table = empty($this->table) ? $f3->snakecase($class) : $this->table;
        $mapperClass = "\FFCMS\Mappers\\" . $class;

        if (class_exists($mapperClass) && $this instanceof Mapper) {
            $this->mapperClass = $mapperClass;
            $this->mapper = new $this->mapperClass;
        }

        $this->isAuthorised = $this->validateAccess();
        if (empty($this->isAuthorised)) {
            $this->setOAuthError('invalid_grant');
        } elseif (empty($f3->get('isAdmin')) && !empty($this->adminOnly)) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            $this->setOAuthError('access_denied');
        } else {
            $this->isAuthorised = true;
        }
    }


    /**
     * Get the associated mapper for the table
     *
     * @return
     */
    public function &getMapper()
    {
        return $this->mapper;
    }


    /**
     * Check permissions and load the mapper with the object in the URL param @id
     * for the user
     *
     * @param \Base $f3
     * @param array $params
     * @param string $idField the field used for the unique id to load by
     * @param string|null $defaultId defaule value to use if not found
     * @return null|array|boolean|\FFMVC\Mappers\Mapper
     */
    public function getIdObjectIfUser(\Base $f3, array $params, string $idField = 'uuid', $defaultId = null)
    {
        // valid user?
        if (empty($this->isAuthorised)) {
            return;
        }

        // only admin has permission to specify @id param
        $isAdmin = $f3->get('isAdmin');
        $id = !empty($params['id']) ? $params['id'] : $f3->get('REQUEST.id');

        if ((!$isAdmin && !empty($this->adminOnly))) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        }

        // use default user id
        if (empty($id)) {
            $id = $defaultId;
        }

        // load object by correct id
        $m = $this->getMapper();
        $m->load([$m->quotekey($idField) . ' = ?', $id]);
        if (null == $m->$idField) {
            $this->failure('authentication_error', "Object with @id does not exist.", 404);
            return $this->setOAuthError('invalid_request');
        }

        $this->mapper =& $m;
        return $m;
    }


    /**
     * Check permissions and load the mapper with the object in the URL param @id
     * if the user is an admin
     *
     * @param \Base $f3
     * @param array $params
     * @param string $idField the field used for the unique id to load by
     * @param string|null $defaultId defaule value to use if not found
     * @return null|array|boolean|\FFMVC\Mappers\Mapper
     */
    public function getIdObjectIfAdmin(\Base $f3, array $params, string $idField = 'uuid', $defaultId = null)
    {
        if (empty($this->isAuthorised)) {
            return;
        }

        // only admin has permission to delete @id
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        }

        // invalid id
        $id = !empty($params['id']) ? $params['id'] : $f3->get('REQUEST.id');
        if (empty($id)) {
            $id = $defaultId;
        }

        if (!empty($id) && ('uuid' == $idField && 8 !== strlen($id))) {
            $this->failure('authentication_error', "Invalid @id parameter.", 400);
            return $this->setOAuthError('invalid_request');
        }

        // check id exists
        $m = $this->getMapper();
        $m->load([$m->quotekey($idField) . ' = ?', $id]);
        if (null == $m->$idField) {
            $this->failure('authentication_error', "Object with @id does not exist.", 404);
            return $this->setOAuthError('invalid_request');
        }

        $this->mapper =& $m;
        return $m;
    }


    /**
     * Display the data item
     *
     * @param \Base $f3
     * @param array $params
     * @return null|array|boolean
     */
    public function get(\Base $f3, array $params)
    {
        $isAdmin = $f3->get('isAdmin');
        $m = $this->getIdObjectIfUser($f3, $params, 'uuid', $params['id']);
        if (!is_object($m) || null == $m->uuid) {
            return;
        } elseif (!$isAdmin && $m->users_uuid !== $f3->get('uuid')) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        }
        // return raw data for object?
        $adminView = $f3->get('isAdmin') && 'admin' == $f3->get('REQUEST.view');
        $this->data = $adminView ? $m->castFields($f3->get('REQUEST.fields')) : $m->exportArray($f3->get('REQUEST.fields'));
    }


    /**
     * Replace data
     *
     * @param \Base $f3
     * @param array $params
     * @return null|array|boolean
     */
    public function put(\Base $f3, array $params)
    {
        $m = $this->getIdObjectIfAdmin($f3, $params, 'uuid', $params['id']);
        if (!is_object($m) || null == $m->uuid) {
            return;
        }

        $f3->set('REQUEST.uuid', $m->uuid);

        // these fields can't be modified
        return $this->save($f3, [
            'id'
        ]);
    }


    /**
     * Create new data
     *
     * @param \Base $f3
     * @return null|array|boolean
     */
    public function post(\Base $f3)
    {
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin) {
            return;
        }

        // this fields can't be modified
        $prohibitedFields = [
            'id', 'uuid'
        ];

        return $this->save($f3, $prohibitedFields);
    }


    /**
     * Update data
     *
     * @param \Base $f3
     * @param array $params
     * @return null|array|boolean
     */
    public function patch(\Base $f3, array $params)
    {
        $m = $this->getIdObjectIfAdmin($f3, $params, 'uuid', $params['id']);
        if (!is_object($m) || null == $m->uuid) {
            return;
        }

        $f3->set('REQUEST.uuid', $m->uuid);

        // these fields can't be modified
        return $this->save($f3, [
            'id', 'uuid'
        ]);
    }


    /**
     * Delete the data object indicated by @id in the request
     *
     * @param \Base $f3
     * @param array $params
     * @return null|array|boolean
     */
    public function delete(\Base $f3, array $params)
    {
        $m = $this->getIdObjectIfUser($f3, $params);
        if (!is_object($m) || null == $m->uuid) {
            return;
        }

        // a user can only delete if they own the object
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin) {
            if (!empty($m->users_uuid) && $m->users_uuid !== $f3->get('uuid')) {
                $this->failure('authentication_error', "User does not have permission.", 401);
                return $this->setOAuthError('access_denied');
            }
        }

        $this->data = [
            'deleted' => $m->erase()
        ];
    }


    /**
     * list objects (list is a reserved keyword)
     *
     * @param \Base $f3
     * @return null|array|boolean
     */
    public function listingAdmin(\Base $f3)
    {
        // must be an admin
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        }

        $this->data = $this->getListingResults($f3, $this->getMapper());
    }


    /**
     * list objects (list is a reserved keyword)
     *
     * @param \Base $f3
     * @param array $params
     * @return array|boolean|null
     */
    public function listing(\Base $f3, array $params)
    {
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin && array_key_exists('id', $params)) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        } elseif ($isAdmin && array_key_exists('id', $params)) {
            $users_uuid = $params['id'];
        } elseif (!$isAdmin) {
            $users_uuid = $f3->get('uuid');
        } else {
            $users_uuid = null;
        }

        $this->data = $this->getListingResults($f3, $this->getMapper(), $users_uuid);
    }


    /**
     * search objects
     *
     * @param \Base $f3
     * @return null|array|boolean
     */
    public function searchAdmin(\Base $f3)
    {
        // must be an admin
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        }

        $this->data = $this->getSearchResults($f3, $this->getMapper());
    }


    /**
     * search objects
     *
     * @param \Base $f3
     * @param array $params
     * @return null|array|boolean
     */
    public function search(\Base $f3, array $params)
    {
        $isAdmin = $f3->get('isAdmin');
        if (!$isAdmin && array_key_exists('id', $params)) {
            $this->failure('authentication_error', "User does not have permission.", 401);
            return $this->setOAuthError('access_denied');
        } elseif ($isAdmin && array_key_exists('id', $params)) {
            $users_uuid = $params['id'];
        } elseif (!$isAdmin) {
            $users_uuid = $f3->get('uuid');
        } else {
            $users_uuid = null;
        }

        $this->data = $this->getSearchResults($f3, $this->getMapper(), $users_uuid);
    }

}


1		<?php
2
3		namespace FFCMS\Controllers\API;
4
5		use FFMVC\Helpers;
6		use FFCMS\{Traits, Models, Mappers};
7
8
9		/**
10		* REST API Base Controller Class.
11		*
12		* @author Vijay Mahrra <[email protected]>
13		* @copyright Vijay Mahrra
14		* @license GPLv3 (http://www.gnu.org/licenses/gpl-3.0.html)
15		*/
16		abstract class Mapper extends API
17		{
18		use Traits\Validation,
19		Traits\SearchController;
20
21		/**
22		* For admin listing and search results
23		*/
24		use Traits\SearchController;
25
26		/**
27		* @var object database class
28		*/
29		protected $db;
30
31		/**
32		* @var string table in the db
33		*/
34		protected $table = null;
35
36		/**
37		* @var string class name
38		*/
39		protected $mapperClass;
40
41		/**
42		* @var \FFMVC\Mappers\Mapper mapper for class
43		*/
44		protected $mapper;
45
46		/**
47		* is the user authorised for access?
48		*
49		* @var bool
50		*/
51		protected $isAuthorised = false;
52
53		/**
54		* is the user authorised for access to the object type?
55		*
56		* @var bool
57		*/
58		protected $adminOnly = true;
59
60
61		/**
62		* initialize
63		* @param \Base $f3
64		*/
65		public function __construct(\Base $f3)
66		{
67		parent::__construct();
68
69		// guess the table name from the class name if not specified as a class member
70		$class = \UTF::instance()->substr(strrchr(get_class($this), '\\'),1);
71		$this->table = empty($this->table) ? $f3->snakecase($class) : $this->table;
72		$mapperClass = "\FFCMS\Mappers\\" . $class;
73
74		if (class_exists($mapperClass) && $this instanceof Mapper) {
75		$this->mapperClass = $mapperClass;
76		$this->mapper = new $this->mapperClass;
77		}
78
79		$this->isAuthorised = $this->validateAccess();
80		if (empty($this->isAuthorised)) {
81		$this->setOAuthError('invalid_grant');
82	View Code Duplication	} elseif (empty($f3->get('isAdmin')) && !empty($this->adminOnly)) {
83		$this->failure('authentication_error', "User does not have permission.", 401);
84		$this->setOAuthError('access_denied');
85		} else {
86		$this->isAuthorised = true;
87		}
88		}
89
90
91		/**
92		* Get the associated mapper for the table
93		*
94		* @return
95		*/
96		public function &getMapper()
97		{
98		return $this->mapper;
99		}
100
101
102		/**
103		* Check permissions and load the mapper with the object in the URL param @id
104		* for the user
105		*
106		* @param \Base $f3
107		* @param array $params
108		* @param string $idField the field used for the unique id to load by
109		* @param string\|null $defaultId defaule value to use if not found
110		* @return null\|array\|boolean\|\FFMVC\Mappers\Mapper
111		*/
112		public function getIdObjectIfUser(\Base $f3, array $params, string $idField = 'uuid', $defaultId = null)
113		{
114		// valid user?
115		if (empty($this->isAuthorised)) {
116		return;
117		}
118
119		// only admin has permission to specify @id param
120		$isAdmin = $f3->get('isAdmin');
121		$id = !empty($params['id']) ? $params['id'] : $f3->get('REQUEST.id');
122
123	View Code Duplication	if ((!$isAdmin && !empty($this->adminOnly))) {
124		$this->failure('authentication_error', "User does not have permission.", 401);
125		return $this->setOAuthError('access_denied');
126		}
127
128		// use default user id
129		if (empty($id)) {
130		$id = $defaultId;
131		}
132
133		// load object by correct id
134		$m = $this->getMapper();
135		$m->load([$m->quotekey($idField) . ' = ?', $id]);
136	View Code Duplication	if (null == $m->$idField) {
137		$this->failure('authentication_error', "Object with @id does not exist.", 404);
138		return $this->setOAuthError('invalid_request');
139		}
140
141		$this->mapper =& $m;
142		return $m;
143		}
144
145
146		/**
147		* Check permissions and load the mapper with the object in the URL param @id
148		* if the user is an admin
149		*
150		* @param \Base $f3
151		* @param array $params
152		* @param string $idField the field used for the unique id to load by
153		* @param string\|null $defaultId defaule value to use if not found
154		* @return null\|array\|boolean\|\FFMVC\Mappers\Mapper
155		*/
156		public function getIdObjectIfAdmin(\Base $f3, array $params, string $idField = 'uuid', $defaultId = null)
157		{
158		if (empty($this->isAuthorised)) {
159		return;
160		}
161
162		// only admin has permission to delete @id
163		$isAdmin = $f3->get('isAdmin');
164		if (!$isAdmin) {
165		$this->failure('authentication_error', "User does not have permission.", 401);
166		return $this->setOAuthError('access_denied');
167		}
168
169		// invalid id
170		$id = !empty($params['id']) ? $params['id'] : $f3->get('REQUEST.id');
171		if (empty($id)) {
172		$id = $defaultId;
173		}
174
175		if (!empty($id) && ('uuid' == $idField && 8 !== strlen($id))) {
176		$this->failure('authentication_error', "Invalid @id parameter.", 400);
177		return $this->setOAuthError('invalid_request');
178		}
179
180		// check id exists
181		$m = $this->getMapper();
182		$m->load([$m->quotekey($idField) . ' = ?', $id]);
183	View Code Duplication	if (null == $m->$idField) {
184		$this->failure('authentication_error', "Object with @id does not exist.", 404);
185		return $this->setOAuthError('invalid_request');
186		}
187
188		$this->mapper =& $m;
189		return $m;
190		}
191
192
193		/**
194		* Display the data item
195		*
196		* @param \Base $f3
197		* @param array $params
198		* @return null\|array\|boolean
199		*/
200		public function get(\Base $f3, array $params)
201		{
202		$isAdmin = $f3->get('isAdmin');
203		$m = $this->getIdObjectIfUser($f3, $params, 'uuid', $params['id']);
204		if (!is_object($m) \|\| null == $m->uuid) {
205		return;
206		} elseif (!$isAdmin && $m->users_uuid !== $f3->get('uuid')) {
207		$this->failure('authentication_error', "User does not have permission.", 401);
208		return $this->setOAuthError('access_denied');
209		}
210		// return raw data for object?
211		$adminView = $f3->get('isAdmin') && 'admin' == $f3->get('REQUEST.view');
212		$this->data = $adminView ? $m->castFields($f3->get('REQUEST.fields')) : $m->exportArray($f3->get('REQUEST.fields'));
213		}
214
215
216		/**
217		* Replace data
218		*
219		* @param \Base $f3
220		* @param array $params
221		* @return null\|array\|boolean
222		*/
223		public function put(\Base $f3, array $params)
224		{
225		$m = $this->getIdObjectIfAdmin($f3, $params, 'uuid', $params['id']);
226		if (!is_object($m) \|\| null == $m->uuid) {
227		return;
228		}
229
230		$f3->set('REQUEST.uuid', $m->uuid);
231
232		// these fields can't be modified
233		return $this->save($f3, [
234		'id'
235		]);
236		}
237
238
239		/**
240		* Create new data
241		*
242		* @param \Base $f3
243		* @return null\|array\|boolean
244		*/
245		public function post(\Base $f3)
246		{
247		$isAdmin = $f3->get('isAdmin');
248		if (!$isAdmin) {
249		return;
250		}
251
252		// this fields can't be modified
253		$prohibitedFields = [
254		'id', 'uuid'
255		];
256
257		return $this->save($f3, $prohibitedFields);
258		}
259
260
261		/**
262		* Update data
263		*
264		* @param \Base $f3
265		* @param array $params
266		* @return null\|array\|boolean
267		*/
268		public function patch(\Base $f3, array $params)
269		{
270		$m = $this->getIdObjectIfAdmin($f3, $params, 'uuid', $params['id']);
271		if (!is_object($m) \|\| null == $m->uuid) {
272		return;
273		}
274
275		$f3->set('REQUEST.uuid', $m->uuid);
276
277		// these fields can't be modified
278		return $this->save($f3, [
279		'id', 'uuid'
280		]);
281		}
282
283
284		/**
285		* Delete the data object indicated by @id in the request
286		*
287		* @param \Base $f3
288		* @param array $params
289		* @return null\|array\|boolean
290		*/
291		public function delete(\Base $f3, array $params)
292		{
293		$m = $this->getIdObjectIfUser($f3, $params);
294		if (!is_object($m) \|\| null == $m->uuid) {
295		return;
296		}
297
298		// a user can only delete if they own the object
299		$isAdmin = $f3->get('isAdmin');
300		if (!$isAdmin) {
301		if (!empty($m->users_uuid) && $m->users_uuid !== $f3->get('uuid')) {
302		$this->failure('authentication_error', "User does not have permission.", 401);
303		return $this->setOAuthError('access_denied');
304		}
305		}
306
307		$this->data = [
308		'deleted' => $m->erase()
309		];
310		}
311
312
313		/**
314		* list objects (list is a reserved keyword)
315		*
316		* @param \Base $f3
317		* @return null\|array\|boolean
318		*/
319		public function listingAdmin(\Base $f3)
320		{
321		// must be an admin
322		$isAdmin = $f3->get('isAdmin');
323		if (!$isAdmin) {
324		$this->failure('authentication_error', "User does not have permission.", 401);
325		return $this->setOAuthError('access_denied');
326		}
327
328		$this->data = $this->getListingResults($f3, $this->getMapper());
329		}
330
331
332		/**
333		* list objects (list is a reserved keyword)
334		*
335		* @param \Base $f3
336		* @param array $params
337		* @return array\|boolean\|null
338		*/
339		public function listing(\Base $f3, array $params)
340		{
341		$isAdmin = $f3->get('isAdmin');
342		if (!$isAdmin && array_key_exists('id', $params)) {
343		$this->failure('authentication_error', "User does not have permission.", 401);
344		return $this->setOAuthError('access_denied');
345		} elseif ($isAdmin && array_key_exists('id', $params)) {
346		$users_uuid = $params['id'];
347		} elseif (!$isAdmin) {
348		$users_uuid = $f3->get('uuid');
349		} else {
350		$users_uuid = null;
351		}
352
353		$this->data = $this->getListingResults($f3, $this->getMapper(), $users_uuid);
354		}
355
356
357		/**
358		* search objects
359		*
360		* @param \Base $f3
361		* @return null\|array\|boolean
362		*/
363		public function searchAdmin(\Base $f3)
364		{
365		// must be an admin
366		$isAdmin = $f3->get('isAdmin');
367		if (!$isAdmin) {
368		$this->failure('authentication_error', "User does not have permission.", 401);
369		return $this->setOAuthError('access_denied');
370		}
371
372		$this->data = $this->getSearchResults($f3, $this->getMapper());
373		}
374
375
376		/**
377		* search objects
378		*
379		* @param \Base $f3
380		* @param array $params
381		* @return null\|array\|boolean
382		*/
383		public function search(\Base $f3, array $params)
384		{
385		$isAdmin = $f3->get('isAdmin');
386		if (!$isAdmin && array_key_exists('id', $params)) {
387		$this->failure('authentication_error', "User does not have permission.", 401);
388		return $this->setOAuthError('access_denied');
389		} elseif ($isAdmin && array_key_exists('id', $params)) {
390		$users_uuid = $params['id'];
391		} elseif (!$isAdmin) {
392		$users_uuid = $f3->get('uuid');
393		} else {
394		$users_uuid = null;
395		}
396
397		$this->data = $this->getSearchResults($f3, $this->getMapper(), $users_uuid);
398		}
399
400		}
401

vijinho / f3-cms

Mapper::put() A last analyzed 2017-10-19 21:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Mapper::put() A
last analyzed 2017-10-19 21:00 UTC