We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
Total Complexity | 52 |
Total Lines | 464 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like CrudPanel often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CrudPanel, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
40 | class CrudPanel |
||
41 | { |
||
42 | // load all the default CrudPanel features |
||
43 | use Create, Read, Search, Update, Delete, Input, Errors, Reorder, Access, Columns, Fields, Query, Buttons, AutoSet, FakeFields, FakeColumns, AutoFocus, Filters, Tabs, Views, Validation, HeadingsAndTitles, Operations, SaveActions, Settings, Relationships, HasViewNamespaces, MorphRelationships; |
||
44 | |||
45 | // allow developers to add their own closures to this object |
||
46 | use Macroable; |
||
47 | |||
48 | // -------------- |
||
49 | // CRUD variables |
||
50 | // -------------- |
||
51 | // These variables are passed to the CRUD views, inside the $crud variable. |
||
52 | // All variables are public, so they can be modified from your EntityCrudController. |
||
53 | // All functions and methods are also public, so they can be used in your EntityCrudController to modify these variables. |
||
54 | |||
55 | public $model = "\App\Models\Entity"; // what's the namespace for your entity's model |
||
56 | |||
57 | public $route; // what route have you defined for your entity? used for links. |
||
58 | |||
59 | public $entity_name = 'entry'; // what name will show up on the buttons, in singural (ex: Add entity) |
||
60 | |||
61 | public $entity_name_plural = 'entries'; // what name will show up on the buttons, in plural (ex: Delete 5 entities) |
||
62 | |||
63 | public $entry; |
||
64 | |||
65 | protected $request; |
||
66 | |||
67 | // The following methods are used in CrudController or your EntityCrudController to manipulate the variables above. |
||
68 | |||
69 | public function __construct() |
||
70 | { |
||
71 | $this->setRequest(); |
||
72 | |||
73 | if ($this->getCurrentOperation()) { |
||
74 | $this->setOperation($this->getCurrentOperation()); |
||
75 | } |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * Set the request instance for this CRUD. |
||
80 | * |
||
81 | * @param \Illuminate\Http\Request $request |
||
82 | */ |
||
83 | public function setRequest($request = null) |
||
84 | { |
||
85 | $this->request = $request ?? \Request::instance(); |
||
86 | } |
||
87 | |||
88 | /** |
||
89 | * Get the request instance for this CRUD. |
||
90 | * |
||
91 | * @return \Illuminate\Http\Request |
||
92 | */ |
||
93 | public function getRequest() |
||
94 | { |
||
95 | return $this->request; |
||
96 | } |
||
97 | |||
98 | // ------------------------------------------------------ |
||
99 | // BASICS - model, route, entity_name, entity_name_plural |
||
100 | // ------------------------------------------------------ |
||
101 | |||
102 | /** |
||
103 | * This function binds the CRUD to its corresponding Model (which extends Eloquent). |
||
104 | * All Create-Read-Update-Delete operations are done using that Eloquent Collection. |
||
105 | * |
||
106 | * @param string $model_namespace Full model namespace. Ex: App\Models\Article |
||
107 | * |
||
108 | * @throws \Exception in case the model does not exist |
||
109 | */ |
||
110 | public function setModel($model_namespace) |
||
111 | { |
||
112 | if (! class_exists($model_namespace)) { |
||
113 | throw new \Exception('The model does not exist.', 500); |
||
114 | } |
||
115 | |||
116 | if (! method_exists($model_namespace, 'hasCrudTrait')) { |
||
117 | throw new \Exception('Please use CrudTrait on the model.', 500); |
||
118 | } |
||
119 | |||
120 | $this->model = new $model_namespace(); |
||
121 | $this->query = clone $this->totalQuery = $this->model->select('*'); |
||
122 | $this->entry = null; |
||
123 | } |
||
124 | |||
125 | /** |
||
126 | * Get the corresponding Eloquent Model for the CrudController, as defined with the setModel() function. |
||
127 | * |
||
128 | * @return string|\Illuminate\Database\Eloquent\Model |
||
129 | */ |
||
130 | public function getModel() |
||
131 | { |
||
132 | return $this->model; |
||
133 | } |
||
134 | |||
135 | /** |
||
136 | * Get the database connection, as specified in the .env file or overwritten by the property on the model. |
||
137 | * |
||
138 | * @return \Illuminate\Database\Schema\Builder |
||
139 | */ |
||
140 | private function getSchema() |
||
143 | } |
||
144 | |||
145 | /** |
||
146 | * Check if the database connection driver is using mongodb. |
||
147 | * |
||
148 | * DEPRECATION NOTICE: This method is no longer used and will be removed in future versions of Backpack |
||
149 | * |
||
150 | * @deprecated |
||
151 | * |
||
152 | * @codeCoverageIgnore |
||
153 | * |
||
154 | * @return bool |
||
155 | */ |
||
156 | private function driverIsMongoDb() |
||
157 | { |
||
158 | return $this->getSchema()->getConnection()->getConfig()['driver'] === 'mongodb'; |
||
159 | } |
||
160 | |||
161 | /** |
||
162 | * Check if the database connection is any sql driver. |
||
163 | * |
||
164 | * @return bool |
||
165 | */ |
||
166 | private function driverIsSql() |
||
167 | { |
||
168 | $driver = $this->getSchema()->getConnection()->getConfig('driver'); |
||
169 | |||
170 | return in_array($driver, $this->getSqlDriverList()); |
||
171 | } |
||
172 | |||
173 | /** |
||
174 | * Get SQL driver list. |
||
175 | * |
||
176 | * @return array |
||
177 | */ |
||
178 | public function getSqlDriverList() |
||
179 | { |
||
180 | return ['mysql', 'sqlsrv', 'sqlite', 'pgsql', 'mariadb']; |
||
181 | } |
||
182 | |||
183 | /** |
||
184 | * Set the route for this CRUD. |
||
185 | * Ex: admin/article. |
||
186 | * |
||
187 | * @param string $route Route name. |
||
188 | */ |
||
189 | public function setRoute($route) |
||
190 | { |
||
191 | $this->route = ltrim($route, '/'); |
||
192 | } |
||
193 | |||
194 | /** |
||
195 | * Set the route for this CRUD using the route name. |
||
196 | * Ex: admin.article. |
||
197 | * |
||
198 | * @param string $route Route name. |
||
199 | * @param array $parameters Parameters. |
||
200 | * |
||
201 | * @throws \Exception |
||
202 | */ |
||
203 | public function setRouteName($route, $parameters = []) |
||
204 | { |
||
205 | $route = ltrim($route, '.'); |
||
206 | |||
207 | $complete_route = $route.'.index'; |
||
208 | |||
209 | if (! \Route::has($complete_route)) { |
||
210 | throw new \Exception('There are no routes for this route name.', 404); |
||
211 | } |
||
212 | |||
213 | $this->route = route($complete_route, $parameters); |
||
214 | } |
||
215 | |||
216 | /** |
||
217 | * Get the current CrudController route. |
||
218 | * |
||
219 | * Can be defined in the CrudController with: |
||
220 | * - $this->crud->setRoute(config('backpack.base.route_prefix').'/article') |
||
221 | * - $this->crud->setRouteName(config('backpack.base.route_prefix').'.article') |
||
222 | * - $this->crud->route = config('backpack.base.route_prefix')."/article" |
||
223 | * |
||
224 | * @return string |
||
225 | */ |
||
226 | public function getRoute() |
||
227 | { |
||
228 | return $this->route; |
||
229 | } |
||
230 | |||
231 | /** |
||
232 | * Set the entity name in singular and plural. |
||
233 | * Used all over the CRUD interface (header, add button, reorder button, breadcrumbs). |
||
234 | * |
||
235 | * @param string $singular Entity name, in singular. Ex: article |
||
236 | * @param string $plural Entity name, in plural. Ex: articles |
||
237 | */ |
||
238 | public function setEntityNameStrings($singular, $plural) |
||
239 | { |
||
240 | $this->entity_name = $singular; |
||
241 | $this->entity_name_plural = $plural; |
||
242 | } |
||
243 | |||
244 | // ----------------------------------------------- |
||
245 | // ACTIONS - the current operation being processed |
||
246 | // ----------------------------------------------- |
||
247 | |||
248 | /** |
||
249 | * Get the action being performed by the controller, |
||
250 | * including middleware names, route name, method name, |
||
251 | * namespace, prefix, etc. |
||
252 | * |
||
253 | * @return string The EntityCrudController route action array. |
||
254 | */ |
||
255 | public function getAction() |
||
256 | { |
||
257 | return $this->getRequest()->route()->getAction(); |
||
258 | } |
||
259 | |||
260 | /** |
||
261 | * Get the full name of the controller method |
||
262 | * currently being called (including namespace). |
||
263 | * |
||
264 | * @return string The EntityCrudController full method name with namespace. |
||
265 | */ |
||
266 | public function getActionName() |
||
269 | } |
||
270 | |||
271 | /** |
||
272 | * Get the name of the controller method |
||
273 | * currently being called. |
||
274 | * |
||
275 | * @return string The EntityCrudController method name. |
||
276 | */ |
||
277 | public function getActionMethod() |
||
278 | { |
||
279 | return $this->getRequest()->route()->getActionMethod(); |
||
280 | } |
||
281 | |||
282 | /** |
||
283 | * Check if the controller method being called |
||
284 | * matches a given string. |
||
285 | * |
||
286 | * @param string $methodName Name of the method (ex: index, create, update) |
||
287 | * @return bool Whether the condition is met or not. |
||
288 | */ |
||
289 | public function actionIs($methodName) |
||
290 | { |
||
291 | return $methodName === $this->getActionMethod(); |
||
292 | } |
||
293 | |||
294 | // ---------------------------------- |
||
295 | // Miscellaneous functions or methods |
||
296 | // ---------------------------------- |
||
297 | |||
298 | /** |
||
299 | * Return the first element in an array that has the given 'type' attribute. |
||
300 | * |
||
301 | * @param string $type |
||
302 | * @param array $array |
||
303 | * @return array |
||
304 | */ |
||
305 | public function getFirstOfItsTypeInArray($type, $array) |
||
306 | { |
||
307 | return Arr::first($array, function ($item) use ($type) { |
||
308 | return $item['type'] == $type; |
||
309 | }); |
||
310 | } |
||
311 | |||
312 | /** |
||
313 | * TONE FUNCTIONS - UNDOCUMENTED, UNTESTED, SOME MAY BE USED IN THIS FILE. |
||
314 | * |
||
315 | * TODO: |
||
316 | * - figure out if they are really needed |
||
317 | * - comments inside the function to explain how they work |
||
318 | * - write docblock for them |
||
319 | * - place in the correct section above (CREATE, READ, UPDATE, DELETE, ACCESS, MANIPULATION) |
||
320 | * |
||
321 | * @deprecated |
||
322 | * |
||
323 | * @codeCoverageIgnore |
||
324 | */ |
||
325 | public function sync($type, $fields, $attributes) |
||
326 | { |
||
327 | if (! empty($this->{$type})) { |
||
328 | $this->{$type} = array_map(function ($field) use ($fields, $attributes) { |
||
329 | if (in_array($field['name'], (array) $fields)) { |
||
330 | $field = array_merge($field, $attributes); |
||
331 | } |
||
332 | |||
333 | return $field; |
||
334 | }, $this->{$type}); |
||
335 | } |
||
336 | } |
||
337 | |||
338 | /** |
||
339 | * Get the Eloquent Model name from the given relation definition string. |
||
340 | * |
||
341 | * @example For a given string 'company' and a relation between App/Models/User and App/Models/Company, defined by a |
||
342 | * company() method on the user model, the 'App/Models/Company' string will be returned. |
||
343 | * @example For a given string 'company.address' and a relation between App/Models/User, App/Models/Company and |
||
344 | * App/Models/Address defined by a company() method on the user model and an address() method on the |
||
345 | * company model, the 'App/Models/Address' string will be returned. |
||
346 | * |
||
347 | * @param string $relationString Relation string. A dot notation can be used to chain multiple relations. |
||
348 | * @param int $length Optionally specify the number of relations to omit from the start of the relation string. If |
||
349 | * the provided length is negative, then that many relations will be omitted from the end of the relation |
||
350 | * string. |
||
351 | * @param \Illuminate\Database\Eloquent\Model $model Optionally specify a different model than the one in the crud object. |
||
352 | * @return string Relation model name. |
||
353 | */ |
||
354 | public function getRelationModel($relationString, $length = null, $model = null) |
||
355 | { |
||
356 | $relationArray = explode('.', $relationString); |
||
357 | |||
358 | if (! isset($length)) { |
||
359 | $length = count($relationArray); |
||
360 | } |
||
361 | |||
362 | if (! isset($model)) { |
||
363 | $model = $this->model; |
||
364 | } |
||
365 | |||
366 | $result = array_reduce(array_splice($relationArray, 0, $length), function ($obj, $method) { |
||
367 | try { |
||
368 | $result = $obj->$method(); |
||
369 | |||
370 | return $result->getRelated(); |
||
371 | } catch (Exception $e) { |
||
372 | return $obj; |
||
373 | } |
||
374 | }, $model); |
||
375 | |||
376 | return get_class($result); |
||
377 | } |
||
378 | |||
379 | /** |
||
380 | * Get the given attribute from a model or models resulting from the specified relation string (eg: the list of streets from |
||
381 | * the many addresses of the company of a given user). |
||
382 | * |
||
383 | * @param \Illuminate\Database\Eloquent\Model $model Model (eg: user). |
||
384 | * @param string $relationString Model relation. Can be a string representing the name of a relation method in the given |
||
385 | * Model or one from a different Model through multiple relations. A dot notation can be used to specify |
||
386 | * multiple relations (eg: user.company.address). |
||
387 | * @param string $attribute The attribute from the relation model (eg: the street attribute from the address model). |
||
388 | * @return array An array containing a list of attributes from the resulting model. |
||
389 | */ |
||
390 | public function getRelatedEntriesAttributes($model, $relationString, $attribute) |
||
428 | } |
||
429 | |||
430 | /** |
||
431 | * Parse translatable attributes from a model or models resulting from the specified relation string. |
||
432 | * |
||
433 | * @param \Illuminate\Database\Eloquent\Model $model Model (eg: user). |
||
434 | * @param string $attribute The attribute from the relation model (eg: the street attribute from the address model). |
||
435 | * @param string $value Attribute value translatable or not |
||
436 | * @return string A string containing the translated attributed based on app()->getLocale() |
||
437 | */ |
||
438 | public function parseTranslatableAttributes($model, $attribute, $value) |
||
439 | { |
||
440 | if (! method_exists($model, 'isTranslatableAttribute')) { |
||
441 | return $value; |
||
442 | } |
||
443 | |||
444 | if (! $model->isTranslatableAttribute($attribute)) { |
||
445 | return $value; |
||
446 | } |
||
447 | |||
448 | if (! is_array($value)) { |
||
449 | $decodedAttribute = json_decode($value, true); |
||
450 | } else { |
||
451 | $decodedAttribute = $value; |
||
452 | } |
||
453 | |||
454 | if (is_array($decodedAttribute) && ! empty($decodedAttribute)) { |
||
455 | if (isset($decodedAttribute[app()->getLocale()])) { |
||
456 | return $decodedAttribute[app()->getLocale()]; |
||
457 | } else { |
||
458 | return Arr::first($decodedAttribute); |
||
459 | } |
||
460 | } |
||
461 | |||
462 | return $value; |
||
463 | } |
||
464 | |||
465 | /** |
||
466 | * Traverse the tree of relations for the given model, defined by the given relation string, and return the ending |
||
467 | * associated model instance or instances. |
||
468 | * |
||
469 | * @param \Illuminate\Database\Eloquent\Model $model The CRUD model. |
||
470 | * @param string $relationString Relation string. A dot notation can be used to chain multiple relations. |
||
471 | * @return array An array of the associated model instances defined by the relation string. |
||
472 | */ |
||
473 | private function getRelatedEntries($model, $relationString) |
||
504 | } |
||
505 | } |
||
506 |