RecordsRequestHandler - Code Metrics - Inspection of "RecordsRequestHandler cleanup" - Divergence/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a67e20...527622 )

by Henry

created 2018-05-25 23:53 UTC

RecordsRequestHandler F

↳ Parent: Project

Complexity

Total Complexity

104

Size/Duplication

Total Lines	592
Duplicated Lines	0 %

Importance

Changes

Metric	Value
dl	0
loc	592
rs	1.5789
c	0
b	0
f	0
wmc	104

30 Methods

Rating	Name	Size	Complexity
A	handleRequest()	17	4
C	handleRecordsRequest()	30	8
A	prepareBrowseConditions()	9	3
B	prepareDefaultBrowseOptions()	16	7
C	handleRecordRequest()	31	7
C	handleBrowseRequest()	57	12
A	getRecordByHandle()	6	2
C	handleMultiDestroyRequest()	68	13
A	checkWriteAccess()	3	1
A	onBeforeRecordSaved()	2	1
A	onRecordDeleted()	2	1
C	handleEditRequest()	62	8
A	onRecordRequestNotHandled()	6	1
A	throwNotFoundError()	6	1
A	handleCreateRequest()	14	2
A	checkAPIAccess()	3	1
A	applyRecordDelta()	6	2
A	checkBrowseAccess()	3	1
B	handleDeleteRequest()	25	3
A	prepareResponseModeJSON()	6	4
A	onBeforeRecordValidated()	2	1
A	throwUnauthorizedError()	6	1
A	respond()	8	2
A	onRecordSaved()	2	1
A	throwRecordNotFoundError()	3	1
A	onRecordCreated()	2	1
A	checkReadAccess()	3	1
C	handleMultiSaveRequest()	77	12
A	throwAPIUnAuthorizedError()	6	1
A	getTemplateName()	5	1

How to fix Complexity

<?php
namespace Divergence\Controllers;

use Exception;

use Divergence\Helpers\JSON;
use Divergence\Helpers\JSONP;
use Divergence\Helpers\Util as Util;
use Divergence\IO\Database\MySQL as DB;
use Divergence\Models\ActiveRecord as ActiveRecord;

abstract class RecordsRequestHandler extends RequestHandler
{
    public static $config;

    // configurables
    public static $recordClass;
    public static $accountLevelRead = false;
    public static $accountLevelBrowse = 'Staff';
    public static $accountLevelWrite = 'Staff';
    public static $accountLevelAPI = false;
    public static $browseOrder = false;
    public static $browseConditions = false;
    public static $browseLimitDefault = false;
    public static $editableFields = false;
    public static $searchConditions = false;
    
    public static $calledClass = __CLASS__;
    public static $responseMode = 'dwoo';
    
    public static function handleRequest()
    {
        // save static class
        static::$calledClass = get_called_class();
    
        // handle JSON requests
        if (static::peekPath() == 'json') {
            // check access for API response modes
            static::$responseMode = static::shiftPath();
            if (in_array(static::$responseMode, ['json','jsonp'])) {
                if (!static::checkAPIAccess()) {
                    return static::throwAPIUnAuthorizedError();
                }
            }
        }
        
        return static::handleRecordsRequest();
    }


    public static function handleRecordsRequest($action = false)
    {
        switch ($action ? $action : $action = static::shiftPath()) {
            case 'save':
            {
                return static::handleMultiSaveRequest();
            }
            
            case 'destroy':
            {
                return static::handleMultiDestroyRequest();
            }
            
            case 'create':
            {
                return static::handleCreateRequest();
            }
            
            case '':
            case false:
            {
                return static::handleBrowseRequest();
            }

            default:
            {
                if ($Record = static::getRecordByHandle($action)) {
                    return static::handleRecordRequest($Record);
                } else {
                    return static::throwRecordNotFoundError();
                }
            }
        }
    }
    
    public static function getRecordByHandle($handle)
    {
        $className = static::$recordClass;
        
        if (method_exists($className, 'getByHandle')) {
            return $className::getByHandle($handle);
        }
    }

    public static function prepareBrowseConditions($conditions = [])
    {
        if (static::$browseConditions) {
            if (!is_array(static::$browseConditions)) {
                static::$browseConditions = [static::$browseConditions];
            }
            $conditions = array_merge(static::$browseConditions, $conditions);
        }
        return $conditions;
    }

    public static function prepareDefaultBrowseOptions()
    {
        if (empty($_REQUEST['offset']) && is_numeric($_REQUEST['start'])) {
            $_REQUEST['offset'] = $_REQUEST['start'];
        }

        $limit = !empty($_REQUEST['limit']) && is_numeric($_REQUEST['limit']) ? $_REQUEST['limit'] : static::$browseLimitDefault;
        $offset = !empty($_REQUEST['offset']) && is_numeric($_REQUEST['offset']) ? $_REQUEST['offset'] : false;
        
        $options = [
            'limit' =>  $limit,
            'offset' => $offset,
            'order' => static::$browseOrder,
        ];

        return $options;
    }

    public static function handleBrowseRequest($options = [], $conditions = [], $responseID = null, $responseData = [])
    {
        if (!static::checkBrowseAccess(func_get_args())) {
            return static::throwUnauthorizedError();
        }
        
        $conditions = static::prepareBrowseConditions($conditions);
        
        $options = static::prepareDefaultBrowseOptions();

        // process sorter
        if (!empty($_REQUEST['sort'])) {
            $sort = json_decode($_REQUEST['sort'], true);
            if (!$sort || !is_array($sort)) {
                return static::respond('error', [
                    'success' => false,
                    'failed' => [
                        'errors'	=>	'Invalid sorter.',
                    ],
                ]);
            }

            if (is_array($sort)) {

                foreach ($sort as $field) {
                    $options['order'][$field['property']] = $field['direction'];
                }
            }
        }
        
        // process filter
        if (!empty($_REQUEST['filter'])) {
            $filter = json_decode($_REQUEST['filter'], true);
            if (!$filter || !is_array($filter)) {
                return static::respond('error', [
                    'success' => false,
                    'failed' => [
                        'errors'	=>	'Invalid filter.',
                    ],
                ]);
            }

            foreach ($filter as $field) {
                $conditions[$field['property']] = $field['value'];
            }
        }

        $className = static::$recordClass;

        return static::respond(
            isset($responseID) ? $responseID : static::getTemplateName($className::$pluralNoun),
            array_merge($responseData, [
                'success' => true,
                'data' => $className::getAllByWhere($conditions, $options),
                'conditions' => $conditions,
                'total' => DB::foundRows(),
                'limit' => $options['limit'],
                'offset' => $options['offset'],
            ])
        );
    }


    public static function handleRecordRequest(ActiveRecord $Record, $action = false)
    {
        if (!static::checkReadAccess($Record)) {
            return static::throwUnauthorizedError();
        }

        switch ($action ? $action : $action = static::shiftPath()) {
            case '':
            case false:
            {
                $className = static::$recordClass;
                
                return static::respond(static::getTemplateName($className::$singularNoun), [
                    'success' => true,
                    'data' => $Record,
                ]);
            }
            
            case 'edit':
            {
                return static::handleEditRequest($Record);
            }
            
            case 'delete':
            {
                return static::handleDeleteRequest($Record);
            }
        
            default:
            {
                return static::onRecordRequestNotHandled($Record, $action);
            }
        }
    }


    public static function prepareResponseModeJSON($methods = [])
    {
        if (static::$responseMode == 'json' && in_array($_SERVER['REQUEST_METHOD'], $methods)) {
            $JSONData = JSON::getRequestData();
            if (is_array($JSONData)) {
                $_REQUEST = $JSONData;
            }
        }
    }

    public static function handleMultiSaveRequest()
    {
        $className = static::$recordClass;
    
        $PrimaryKey = $className::getPrimaryKey();
            
        static::prepareResponseModeJSON(['POST','PUT']);
        
        if ($className::fieldExists(key($_REQUEST['data']))) {
            $_REQUEST['data'] = [$_REQUEST['data']];
        }

        if (empty($_REQUEST['data']) || !is_array($_REQUEST['data'])) {
            return static::respond('error', [
                'success' => false,
                'failed' => [
                    'errors'	=>	'Save expects "data" field as array of records.',
                ],
            ]);
        }
        
        $results = [];
        $failed = [];

        foreach ($_REQUEST['data'] as $datum) {
            // get record
            if (empty($datum[$PrimaryKey])) {
                $Record = new $className::$defaultClass();
                static::onRecordCreated($Record, $datum);
            } else {
                if (!$Record = $className::getByID($datum[$PrimaryKey])) {
                    $failed[] = [
                        'record' => $datum,
                        'errors' => 'Record not found',
                    ];
                    continue;
                }
            }
            
            // check write access
            if (!static::checkWriteAccess($Record)) {
                $failed[] = [
                    'record' => $datum,
                    'errors' => 'Write access denied',
                ];
                continue;
            }
            
            // apply delta
            static::applyRecordDelta($Record, $datum);

            // call template function
            static::onBeforeRecordValidated($Record, $datum);

            // try to save record
            try {
                // call template function
                static::onBeforeRecordSaved($Record, $datum);

                $Record->save();
                $results[] = (!$Record::fieldExists('Class') || get_class($Record) == $Record->Class) ? $Record : $Record->changeClass();
                
                // call template function
                static::onRecordSaved($Record, $datum);
            } catch (Exception $e) {
                $failed[] = [
                    'record' => $Record->data,
                    'validationErrors' => $Record->validationErrors,
                ];
            }
        }
        
        
        return static::respond(static::getTemplateName($className::$pluralNoun).'Saved', [
            'success' => count($results) || !count($failed),
            'data' => $results,
            'failed' => $failed,
        ]);
    }
    
    
    public static function handleMultiDestroyRequest()
    {
        $className = static::$recordClass;

        $PrimaryKey = $className::getPrimaryKey();

        static::prepareResponseModeJSON(['POST','PUT','DELETE']);
        
        if ($className::fieldExists(key($_REQUEST['data']))) {
            $_REQUEST['data'] = [$_REQUEST['data']];
        }

        if (empty($_REQUEST['data']) || !is_array($_REQUEST['data'])) {
            if (static::$responseMode == 'json') {
                return static::respond('error', [
                    'success' => false,
                    'failed' => [
                        'errors'	=>	'Save expects "data" field as array of records.',
                    ],
                ]);
            }
        }


        $results = [];
        $failed = [];
        
        foreach ($_REQUEST['data'] as $datum) {
            // get record
            if (is_numeric($datum)) {
                $recordID = $datum;
            } elseif (!empty($datum[$PrimaryKey]) && is_numeric($datum[$PrimaryKey])) {
                $recordID = $datum[$PrimaryKey];
            } else {
                $failed[] = [
                    'record' => $datum,
                    'errors' => $PrimaryKey.' missing',
                ];
                continue;
            }

            if (!$Record = $className::getByField($PrimaryKey, $recordID)) {
                $failed[] = [
                    'record' => $datum,
                    'errors' => $PrimaryKey.' not found',
                ];
                continue;
            }
            
            // check write access
            if (!static::checkWriteAccess($Record)) {
                $failed[] = [
                    'record' => $datum,
                    'errors' => 'Write access denied',
                ];
                continue;
            }
        
            // destroy record
            if ($Record->destroy()) {
                $results[] = $Record;
            }
        }
        
        return static::respond(static::getTemplateName($className::$pluralNoun).'Destroyed', [
            'success' => count($results) || !count($failed),
            'data' => $results,
            'failed' => $failed,
        ]);
    }


    public static function handleCreateRequest(ActiveRecord $Record = null)
    {
        // save static class
        static::$calledClass = get_called_class();

        if (!$Record) {
            $className = static::$recordClass;
            $Record = new $className::$defaultClass();
        }
        
        // call template function
        static::onRecordCreated($Record, $_REQUEST);

        return static::handleEditRequest($Record);
    }

    public static function handleEditRequest(ActiveRecord $Record)
    {
        $className = static::$recordClass;

        if (!static::checkWriteAccess($Record)) {
            return static::throwUnauthorizedError();
        }

        if (in_array($_SERVER['REQUEST_METHOD'], ['POST','PUT'])) {
            if (static::$responseMode == 'json') {
                $_REQUEST = JSON::getRequestData();
                if (is_array($_REQUEST['data'])) {
                    $_REQUEST = $_REQUEST['data'];
                }
            }
            $_REQUEST = $_REQUEST ? $_REQUEST : $_POST;
        
            // apply delta
            static::applyRecordDelta($Record, $_REQUEST);
            
            // call template function
            static::onBeforeRecordValidated($Record, $_REQUEST);

            // validate
            if ($Record->validate()) {
                // call template function
                static::onBeforeRecordSaved($Record, $_REQUEST);
                
                try {
                    // save session
                    $Record->save();
                } catch (Exception $e) {
                    return static::respond('Error', [
                        'success' => false,
                        'failed' => [
                            'errors'	=>	$e->getMessage(),
                        ],
                    ]);
                }
                
                // call template function
                static::onRecordSaved($Record, $_REQUEST);
        
                // fire created response
                $responseID = static::getTemplateName($className::$singularNoun).'Saved';
                $responseData = [
                    'success' => true,
                    'data' => $Record,
                ];
                return static::respond($responseID, $responseData);
            }
            
            // fall through back to form if validation failed
        }
        
        $responseID = static::getTemplateName($className::$singularNoun).'Edit';
        $responseData = [
            'success' => false,
            'data' => $Record,
        ];
    
        return static::respond($responseID, $responseData);
    }


    public static function handleDeleteRequest(ActiveRecord $Record)
    {
        $className = static::$recordClass;

        if (!static::checkWriteAccess($Record)) {
            return static::throwUnauthorizedError();
        }
    
        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
            $data = $Record->data;
            $Record->destroy();
                    
            // call cleanup function after delete
            static::onRecordDeleted($Record, $data);
            
            // fire created response
            return static::respond(static::getTemplateName($className::$singularNoun).'Deleted', [
                'success' => true,
                'data' => $Record,
            ]);
        }
    
        return static::respond('confirm', [
            'question' => 'Are you sure you want to delete this '.$className::$singularNoun.'?',
            'data' => $Record,
        ]);
    }
    
    
    public static function respond($responseID, $responseData = [], $responseMode = false)
    {
        // default to static property
        if (!$responseMode) {
            $responseMode = static::$responseMode;
        }
    
        return parent::respond($responseID, $responseData, $responseMode);
    }
    
    // access control template functions
    public static function checkBrowseAccess($arguments)
    {
        return true;
    }

    public static function checkReadAccess(ActiveRecord $Record)
    {
        return true;
    }
    
    public static function checkWriteAccess(ActiveRecord $Record)
    {
        return true;
    }
    
    public static function checkAPIAccess()
    {
        return true;
    }
    
    public static function throwUnauthorizedError()
    {
        return static::respond('Unauthorized', [
            'success' => false,
            'failed' => [
                'errors'	=>	'Login required.',
            ],
        ]);
    }

    public static function throwAPIUnAuthorizedError()
    {
        return static::respond('Unauthorized', [
            'success' => false,
            'failed' => [
                'errors'	=>	'API access required.',
            ],
        ]);
    }

    public static function throwNotFoundError()
    {
        return static::respond('error', [
            'success' => false,
            'failed' => [
                'errors'	=>	'Record not found.',
            ],
        ]);
    }
    
    public static function onRecordRequestNotHandled(ActiveRecord $Record, $action)
    {
        return static::respond('error', [
            'success' => false,
            'failed' => [
                'errors'	=>	'Malformed request.',
            ],
        ]);
    }
    


    public static function getTemplateName($noun)
    {
        return preg_replace_callback('/\s+([a-zA-Z])/', function ($matches) {
            return strtoupper($matches[1]);
        }, $noun);
    }
    
    public static function applyRecordDelta(ActiveRecord $Record, $data)
    {
        if (is_array(static::$editableFields)) {

            $Record->setFields(array_intersect_key($data, array_flip(static::$editableFields)));
        } else {
            $Record->setFields($data);
        }
    }
    
    // event template functions
    protected static function onRecordCreated(ActiveRecord $Record, $data)
    {
    }
    protected static function onBeforeRecordValidated(ActiveRecord $Record, $data)
    {
    }
    protected static function onBeforeRecordSaved(ActiveRecord $Record, $data)
    {
    }
    protected static function onRecordDeleted(ActiveRecord $Record, $data)
    {
    }
    protected static function onRecordSaved(ActiveRecord $Record, $data)
    {
    }
    
    protected static function throwRecordNotFoundError()
    {
        return static::throwNotFoundError();
    }
}


1			<?php
2			namespace Divergence\Controllers;
3
4			use Exception;
5
6			use Divergence\Helpers\JSON;
7			use Divergence\Helpers\JSONP;
8			use Divergence\Helpers\Util as Util;
9			use Divergence\IO\Database\MySQL as DB;
10			use Divergence\Models\ActiveRecord as ActiveRecord;
11
12			abstract class RecordsRequestHandler extends RequestHandler
13			{
14			public static $config;
15
16			// configurables
17			public static $recordClass;
18			public static $accountLevelRead = false;
19			public static $accountLevelBrowse = 'Staff';
20			public static $accountLevelWrite = 'Staff';
21			public static $accountLevelAPI = false;
22			public static $browseOrder = false;
23			public static $browseConditions = false;
24			public static $browseLimitDefault = false;
25			public static $editableFields = false;
26			public static $searchConditions = false;
27
28			public static $calledClass = __CLASS__;
29			public static $responseMode = 'dwoo';
30
31			public static function handleRequest()
32			{
33			// save static class
34			static::$calledClass = get_called_class();
35
36			// handle JSON requests
37			if (static::peekPath() == 'json') {
38			// check access for API response modes
39			static::$responseMode = static::shiftPath();
40			if (in_array(static::$responseMode, ['json','jsonp'])) {
41			if (!static::checkAPIAccess()) {
42			return static::throwAPIUnAuthorizedError();
43			}
44			}
45			}
46
47			return static::handleRecordsRequest();
48			}
49
50
51			public static function handleRecordsRequest($action = false)
52			{
53			switch ($action ? $action : $action = static::shiftPath()) {
54			case 'save':
55			{
56			return static::handleMultiSaveRequest();
57			}
58
59			case 'destroy':
60			{
61			return static::handleMultiDestroyRequest();
62			}
63
64			case 'create':
65			{
66			return static::handleCreateRequest();
67			}
68
69			case '':
70			case false:
71			{
72			return static::handleBrowseRequest();
73			}
74
75			default:
76			{
77			if ($Record = static::getRecordByHandle($action)) {
78			return static::handleRecordRequest($Record);
79			} else {
80			return static::throwRecordNotFoundError();
81			}
82			}
83			}
84			}
85
86			public static function getRecordByHandle($handle)
87			{
88			$className = static::$recordClass;
89
90			if (method_exists($className, 'getByHandle')) {
91			return $className::getByHandle($handle);
92			}
93			}
94
95			public static function prepareBrowseConditions($conditions = [])
96			{
97			if (static::$browseConditions) {
98			if (!is_array(static::$browseConditions)) {
99			static::$browseConditions = [static::$browseConditions];
100			}
101			$conditions = array_merge(static::$browseConditions, $conditions);
102			}
103			return $conditions;
104			}
105
106			public static function prepareDefaultBrowseOptions()
107			{
108			if (empty($_REQUEST['offset']) && is_numeric($_REQUEST['start'])) {
109			$_REQUEST['offset'] = $_REQUEST['start'];
110			}
111
112			$limit = !empty($_REQUEST['limit']) && is_numeric($_REQUEST['limit']) ? $_REQUEST['limit'] : static::$browseLimitDefault;
113			$offset = !empty($_REQUEST['offset']) && is_numeric($_REQUEST['offset']) ? $_REQUEST['offset'] : false;
114
115			$options = [
116			'limit' => $limit,
117			'offset' => $offset,
118			'order' => static::$browseOrder,
119			];
120
121			return $options;
122			}
123
124			public static function handleBrowseRequest($options = [], $conditions = [], $responseID = null, $responseData = [])
125			{
126			if (!static::checkBrowseAccess(func_get_args())) {
127			return static::throwUnauthorizedError();
128			}
129
130			$conditions = static::prepareBrowseConditions($conditions);
131
132			$options = static::prepareDefaultBrowseOptions();
133
134			// process sorter
135			if (!empty($_REQUEST['sort'])) {
136			$sort = json_decode($_REQUEST['sort'], true);
137			if (!$sort \|\| !is_array($sort)) {
138			return static::respond('error', [
139			'success' => false,
140			'failed' => [
141			'errors' => 'Invalid sorter.',
142			],
143			]);
144			}
145
146			if (is_array($sort)) {
			1 ignored issue – show introduced 2018-05-15 05:01 UTC by Report Bug Copy Issue Report The condition `is_array($sort)` is always `true`. Loading history...
147			foreach ($sort as $field) {
148			$options['order'][$field['property']] = $field['direction'];
149			}
150			}
151			}
152
153			// process filter
154			if (!empty($_REQUEST['filter'])) {
155			$filter = json_decode($_REQUEST['filter'], true);
156			if (!$filter \|\| !is_array($filter)) {
157			return static::respond('error', [
158			'success' => false,
159			'failed' => [
160			'errors' => 'Invalid filter.',
161			],
162			]);
163			}
164
165			foreach ($filter as $field) {
166			$conditions[$field['property']] = $field['value'];
167			}
168			}
169
170			$className = static::$recordClass;
171
172			return static::respond(
173			isset($responseID) ? $responseID : static::getTemplateName($className::$pluralNoun),
174			array_merge($responseData, [
175			'success' => true,
176			'data' => $className::getAllByWhere($conditions, $options),
177			'conditions' => $conditions,
178			'total' => DB::foundRows(),
179			'limit' => $options['limit'],
180			'offset' => $options['offset'],
181			])
182			);
183			}
184
185
186			public static function handleRecordRequest(ActiveRecord $Record, $action = false)
187			{
188			if (!static::checkReadAccess($Record)) {
189			return static::throwUnauthorizedError();
190			}
191
192			switch ($action ? $action : $action = static::shiftPath()) {
193			case '':
194			case false:
195			{
196			$className = static::$recordClass;
197
198			return static::respond(static::getTemplateName($className::$singularNoun), [
199			'success' => true,
200			'data' => $Record,
201			]);
202			}
203
204			case 'edit':
205			{
206			return static::handleEditRequest($Record);
207			}
208
209			case 'delete':
210			{
211			return static::handleDeleteRequest($Record);
212			}
213
214			default:
215			{
216			return static::onRecordRequestNotHandled($Record, $action);
217			}
218			}
219			}
220
221
222			public static function prepareResponseModeJSON($methods = [])
223			{
224			if (static::$responseMode == 'json' && in_array($_SERVER['REQUEST_METHOD'], $methods)) {
225			$JSONData = JSON::getRequestData();
226			if (is_array($JSONData)) {
227			$_REQUEST = $JSONData;
228			}
229			}
230			}
231
232			public static function handleMultiSaveRequest()
233			{
234			$className = static::$recordClass;
235
236			$PrimaryKey = $className::getPrimaryKey();
237
238			static::prepareResponseModeJSON(['POST','PUT']);
239
240			if ($className::fieldExists(key($_REQUEST['data']))) {
241			$_REQUEST['data'] = [$_REQUEST['data']];
242			}
243
244			if (empty($_REQUEST['data']) \|\| !is_array($_REQUEST['data'])) {
245			return static::respond('error', [
246			'success' => false,
247			'failed' => [
248			'errors' => 'Save expects "data" field as array of records.',
249			],
250			]);
251			}
252
253			$results = [];
254			$failed = [];
255
256			foreach ($_REQUEST['data'] as $datum) {
257			// get record
258			if (empty($datum[$PrimaryKey])) {
259			$Record = new $className::$defaultClass();
260			static::onRecordCreated($Record, $datum);
261			} else {
262			if (!$Record = $className::getByID($datum[$PrimaryKey])) {
263			$failed[] = [
264			'record' => $datum,
265			'errors' => 'Record not found',
266			];
267			continue;
268			}
269			}
270
271			// check write access
272			if (!static::checkWriteAccess($Record)) {
273			$failed[] = [
274			'record' => $datum,
275			'errors' => 'Write access denied',
276			];
277			continue;
278			}
279
280			// apply delta
281			static::applyRecordDelta($Record, $datum);
282
283			// call template function
284			static::onBeforeRecordValidated($Record, $datum);
285
286			// try to save record
287			try {
288			// call template function
289			static::onBeforeRecordSaved($Record, $datum);
290
291			$Record->save();
292			$results[] = (!$Record::fieldExists('Class') \|\| get_class($Record) == $Record->Class) ? $Record : $Record->changeClass();
293
294			// call template function
295			static::onRecordSaved($Record, $datum);
296			} catch (Exception $e) {
297			$failed[] = [
298			'record' => $Record->data,
299			'validationErrors' => $Record->validationErrors,
300			];
301			}
302			}
303
304
305			return static::respond(static::getTemplateName($className::$pluralNoun).'Saved', [
306			'success' => count($results) \|\| !count($failed),
307			'data' => $results,
308			'failed' => $failed,
309			]);
310			}
311
312
313			public static function handleMultiDestroyRequest()
314			{
315			$className = static::$recordClass;
316
317			$PrimaryKey = $className::getPrimaryKey();
318
319			static::prepareResponseModeJSON(['POST','PUT','DELETE']);
320
321			if ($className::fieldExists(key($_REQUEST['data']))) {
322			$_REQUEST['data'] = [$_REQUEST['data']];
323			}
324
325			if (empty($_REQUEST['data']) \|\| !is_array($_REQUEST['data'])) {
326			if (static::$responseMode == 'json') {
327			return static::respond('error', [
328			'success' => false,
329			'failed' => [
330			'errors' => 'Save expects "data" field as array of records.',
331			],
332			]);
333			}
334			}
335
336
337			$results = [];
338			$failed = [];
339
340			foreach ($_REQUEST['data'] as $datum) {
341			// get record
342			if (is_numeric($datum)) {
343			$recordID = $datum;
344			} elseif (!empty($datum[$PrimaryKey]) && is_numeric($datum[$PrimaryKey])) {
345			$recordID = $datum[$PrimaryKey];
346			} else {
347			$failed[] = [
348			'record' => $datum,
349			'errors' => $PrimaryKey.' missing',
350			];
351			continue;
352			}
353
354			if (!$Record = $className::getByField($PrimaryKey, $recordID)) {
355			$failed[] = [
356			'record' => $datum,
357			'errors' => $PrimaryKey.' not found',
358			];
359			continue;
360			}
361
362			// check write access
363			if (!static::checkWriteAccess($Record)) {
364			$failed[] = [
365			'record' => $datum,
366			'errors' => 'Write access denied',
367			];
368			continue;
369			}
370
371			// destroy record
372			if ($Record->destroy()) {
373			$results[] = $Record;
374			}
375			}
376
377			return static::respond(static::getTemplateName($className::$pluralNoun).'Destroyed', [
378			'success' => count($results) \|\| !count($failed),
379			'data' => $results,
380			'failed' => $failed,
381			]);
382			}
383
384
385			public static function handleCreateRequest(ActiveRecord $Record = null)
386			{
387			// save static class
388			static::$calledClass = get_called_class();
389
390			if (!$Record) {
391			$className = static::$recordClass;
392			$Record = new $className::$defaultClass();
393			}
394
395			// call template function
396			static::onRecordCreated($Record, $_REQUEST);
397
398			return static::handleEditRequest($Record);
399			}
400
401			public static function handleEditRequest(ActiveRecord $Record)
402			{
403			$className = static::$recordClass;
404
405			if (!static::checkWriteAccess($Record)) {
406			return static::throwUnauthorizedError();
407			}
408
409			if (in_array($_SERVER['REQUEST_METHOD'], ['POST','PUT'])) {
410			if (static::$responseMode == 'json') {
411			$_REQUEST = JSON::getRequestData();
412			if (is_array($_REQUEST['data'])) {
413			$_REQUEST = $_REQUEST['data'];
414			}
415			}
416			$_REQUEST = $_REQUEST ? $_REQUEST : $_POST;
417
418			// apply delta
419			static::applyRecordDelta($Record, $_REQUEST);
420
421			// call template function
422			static::onBeforeRecordValidated($Record, $_REQUEST);
423
424			// validate
425			if ($Record->validate()) {
426			// call template function
427			static::onBeforeRecordSaved($Record, $_REQUEST);
428
429			try {
430			// save session
431			$Record->save();
432			} catch (Exception $e) {
433			return static::respond('Error', [
434			'success' => false,
435			'failed' => [
436			'errors' => $e->getMessage(),
437			],
438			]);
439			}
440
441			// call template function
442			static::onRecordSaved($Record, $_REQUEST);
443
444			// fire created response
445			$responseID = static::getTemplateName($className::$singularNoun).'Saved';
446			$responseData = [
447			'success' => true,
448			'data' => $Record,
449			];
450			return static::respond($responseID, $responseData);
451			}
452
453			// fall through back to form if validation failed
454			}
455
456			$responseID = static::getTemplateName($className::$singularNoun).'Edit';
457			$responseData = [
458			'success' => false,
459			'data' => $Record,
460			];
461
462			return static::respond($responseID, $responseData);
463			}
464
465
466			public static function handleDeleteRequest(ActiveRecord $Record)
467			{
468			$className = static::$recordClass;
469
470			if (!static::checkWriteAccess($Record)) {
471			return static::throwUnauthorizedError();
472			}
473
474			if ($_SERVER['REQUEST_METHOD'] == 'POST') {
475			$data = $Record->data;
476			$Record->destroy();
477
478			// call cleanup function after delete
479			static::onRecordDeleted($Record, $data);
480
481			// fire created response
482			return static::respond(static::getTemplateName($className::$singularNoun).'Deleted', [
483			'success' => true,
484			'data' => $Record,
485			]);
486			}
487
488			return static::respond('confirm', [
489			'question' => 'Are you sure you want to delete this '.$className::$singularNoun.'?',
490			'data' => $Record,
491			]);
492			}
493
494
495			public static function respond($responseID, $responseData = [], $responseMode = false)
496			{
497			// default to static property
498			if (!$responseMode) {
499			$responseMode = static::$responseMode;
500			}
501
502			return parent::respond($responseID, $responseData, $responseMode);
503			}
504
505			// access control template functions
506			public static function checkBrowseAccess($arguments)
507			{
508			return true;
509			}
510
511			public static function checkReadAccess(ActiveRecord $Record)
512			{
513			return true;
514			}
515
516			public static function checkWriteAccess(ActiveRecord $Record)
517			{
518			return true;
519			}
520
521			public static function checkAPIAccess()
522			{
523			return true;
524			}
525
526			public static function throwUnauthorizedError()
527			{
528			return static::respond('Unauthorized', [
529			'success' => false,
530			'failed' => [
531			'errors' => 'Login required.',
532			],
533			]);
534			}
535
536			public static function throwAPIUnAuthorizedError()
537			{
538			return static::respond('Unauthorized', [
539			'success' => false,
540			'failed' => [
541			'errors' => 'API access required.',
542			],
543			]);
544			}
545
546			public static function throwNotFoundError()
547			{
548			return static::respond('error', [
549			'success' => false,
550			'failed' => [
551			'errors' => 'Record not found.',
552			],
553			]);
554			}
555
556			public static function onRecordRequestNotHandled(ActiveRecord $Record, $action)
557			{
558			return static::respond('error', [
559			'success' => false,
560			'failed' => [
561			'errors' => 'Malformed request.',
562			],
563			]);
564			}
565
566
567
568			public static function getTemplateName($noun)
569			{
570			return preg_replace_callback('/\s+([a-zA-Z])/', function ($matches) {
571			return strtoupper($matches[1]);
572			}, $noun);
573			}
574
575			public static function applyRecordDelta(ActiveRecord $Record, $data)
576			{
577			if (is_array(static::$editableFields)) {
			1 ignored issue – show introduced 2018-05-16 00:31 UTC by Report Bug Copy Issue Report The condition `is_array(static::editableFields)` is always `false`. Loading history...
578			$Record->setFields(array_intersect_key($data, array_flip(static::$editableFields)));
579			} else {
580			$Record->setFields($data);
581			}
582			}
583
584			// event template functions
585			protected static function onRecordCreated(ActiveRecord $Record, $data)
586			{
587			}
588			protected static function onBeforeRecordValidated(ActiveRecord $Record, $data)
589			{
590			}
591			protected static function onBeforeRecordSaved(ActiveRecord $Record, $data)
592			{
593			}
594			protected static function onRecordDeleted(ActiveRecord $Record, $data)
595			{
596			}
597			protected static function onRecordSaved(ActiveRecord $Record, $data)
598			{
599			}
600
601			protected static function throwRecordNotFoundError()
602			{
603			return static::throwNotFoundError();
604			}
605			}
606

Divergence / framework

Push — master ( a67e20...527622 )

RecordsRequestHandler F

Complexity

Size/Duplication

Importance

30 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like