Laravel-Backpack / CRUD

src/PanelTraits/Views.php

Doc Comments +6 added lines

@@ -301,6 +301,9 @@ 
         return $this->getShowView();
     }
 
+    /**
+     * @param string $view
+     */
     public function setPreviewView($view)
     {
         return $this->setShowView($view);
@@ -311,6 +314,9 @@ 
         return $this->getEditView();
     }
 
+    /**
+     * @param string $view
+     */
     public function setUpdateView($view)
     {
         return $this->setEditView($view);

src/CrudPanel.php

Spacing +11 added lines, -11 removed lines

@@ -76,11 +76,11 @@ 
      */
     public function setModel($model_namespace)
     {
-        if (! class_exists($model_namespace)) {
+        if (!class_exists($model_namespace)) {
             throw new \Exception('The model does not exist.', 500);
         }
 
-        if (! method_exists($model_namespace, 'hasCrudTrait')) {
+        if (!method_exists($model_namespace, 'hasCrudTrait')) {
             throw new \Exception('Please use CrudTrait on the model.', 500);
         }
 
@@ -143,7 +143,7 @@ 
     {
         $complete_route = $route.'.index';
 
-        if (! \Route::has($complete_route)) {
+        if (!\Route::has($complete_route)) {
             throw new \Exception('There are no routes for this route name.', 404);
         }
 
@@ -244,7 +244,7 @@ 
      */
     public function getFirstOfItsTypeInArray($type, $array)
     {
-        return array_first($array, function ($item) use ($type) {
+        return array_first($array, function($item) use ($type) {
             return $item['type'] == $type;
         });
     }
@@ -261,8 +261,8 @@ 
 
     public function sync($type, $fields, $attributes)
     {
-        if (! empty($this->{$type})) {
-            $this->{$type} = array_map(function ($field) use ($fields, $attributes) {
+        if (!empty($this->{$type})) {
+            $this->{$type} = array_map(function($field) use ($fields, $attributes) {
                 if (in_array($field['name'], (array) $fields)) {
                     $field = array_merge($field, $attributes);
                 }
@@ -294,15 +294,15 @@ 
     {
         $relationArray = explode('.', $relationString);
 
-        if (! isset($length)) {
+        if (!isset($length)) {
             $length = count($relationArray);
         }
 
-        if (! isset($model)) {
+        if (!isset($model)) {
             $model = $this->model;
         }
 
-        $result = array_reduce(array_splice($relationArray, 0, $length), function ($obj, $method) {
+        $result = array_reduce(array_splice($relationArray, 0, $length), function($obj, $method) {
             return $obj->$method()->getRelated();
         }, $model);
 
@@ -352,7 +352,7 @@ 
         $relation = $model->{$firstRelationName};
 
         $results = [];
-        if (! empty($relation)) {
+        if (!empty($relation)) {
             if ($relation instanceof Collection) {
                 $currentResults = $relation->toArray();
             } else {
@@ -361,7 +361,7 @@ 
 
             array_shift($relationArray);
 
-            if (! empty($relationArray)) {
+            if (!empty($relationArray)) {
                 foreach ($currentResults as $currentResult) {
                     $results = array_merge($results, $this->getRelationModelInstances($currentResult, implode('.', $relationArray)));
                 }

Unused Use Statements +17 added lines, -17 removed lines

@@ -2,33 +2,33 @@
 
 namespace Backpack\CRUD;
 
-use Backpack\CRUD\PanelTraits\Read;
-use Backpack\CRUD\PanelTraits\Tabs;
-use Backpack\CRUD\PanelTraits\Query;
-use Backpack\CRUD\PanelTraits\Views;
 use Backpack\CRUD\PanelTraits\Access;
+use Backpack\CRUD\PanelTraits\AutoFocus;
+use Backpack\CRUD\PanelTraits\AutoSet;
+use Backpack\CRUD\PanelTraits\Buttons;
+use Backpack\CRUD\PanelTraits\Columns;
 use Backpack\CRUD\PanelTraits\Create;
 use Backpack\CRUD\PanelTraits\Delete;
 use Backpack\CRUD\PanelTraits\Errors;
+use Backpack\CRUD\PanelTraits\FakeColumns;
+use Backpack\CRUD\PanelTraits\FakeFields;
 use Backpack\CRUD\PanelTraits\Fields;
-use Backpack\CRUD\PanelTraits\Search;
-use Backpack\CRUD\PanelTraits\Update;
-use Backpack\CRUD\PanelTraits\AutoSet;
-use Backpack\CRUD\PanelTraits\Buttons;
-use Backpack\CRUD\PanelTraits\Columns;
 use Backpack\CRUD\PanelTraits\Filters;
-use Backpack\CRUD\PanelTraits\Reorder;
-use Backpack\CRUD\PanelTraits\Settings;
-use Backpack\CRUD\PanelTraits\AutoFocus;
+use Backpack\CRUD\PanelTraits\HeadingsAndTitles;
 use Backpack\CRUD\PanelTraits\Macroable;
-use Backpack\CRUD\PanelTraits\FakeFields;
 use Backpack\CRUD\PanelTraits\Operations;
-use Backpack\CRUD\PanelTraits\Validation;
-use Backpack\CRUD\PanelTraits\FakeColumns;
+use Backpack\CRUD\PanelTraits\Query;
+use Backpack\CRUD\PanelTraits\Read;
+use Backpack\CRUD\PanelTraits\Reorder;
 use Backpack\CRUD\PanelTraits\SaveActions;
-use Illuminate\Database\Eloquent\Collection;
-use Backpack\CRUD\PanelTraits\HeadingsAndTitles;
+use Backpack\CRUD\PanelTraits\Search;
+use Backpack\CRUD\PanelTraits\Settings;
+use Backpack\CRUD\PanelTraits\Tabs;
+use Backpack\CRUD\PanelTraits\Update;
+use Backpack\CRUD\PanelTraits\Validation;
+use Backpack\CRUD\PanelTraits\Views;
 use Backpack\CRUD\PanelTraits\ViewsAndRestoresRevisions;
+use Illuminate\Database\Eloquent\Collection;
 
 class CrudPanel
 {

src/PanelTraits/Read.php

Doc Comments +1 added lines

@@ -175,6 +175,7 @@
 
     /**
      * Set the number of rows that should be show on the list view.
+     * @param integer $value
      */
     public function setDefaultPageLength($value)
     {

Spacing +4 added lines, -4 removed lines

@@ -38,7 +38,7 @@ 
     {
         $id = $this->getCurrentEntryId();
 
-        if (! $id) {
+        if (!$id) {
             return false;
         }
 
@@ -54,7 +54,7 @@ 
      */
     public function getEntry($id)
     {
-        if (! $this->entry) {
+        if (!$this->entry) {
             $this->entry = $this->model->findOrFail($id);
             $this->entry = $this->entry->withFakes();
         }
@@ -199,7 +199,7 @@ 
     {
         // If the default Page Length isn't in the menu's values, Add it the beginnin and resort all to show a croissant list.
         // assume both arrays are the same length.
-        if (! in_array($this->getDefaultPageLength(), $this->getOperationSetting('pageLengthMenu')[0])) {
+        if (!in_array($this->getDefaultPageLength(), $this->getOperationSetting('pageLengthMenu')[0])) {
             // Loop through 2 arrays of prop. page_length_menu
             foreach ($this->getOperationSetting('pageLengthMenu') as $key => &$page_length_choices) {
                 // This is a condition that should be always true.
@@ -230,7 +230,7 @@ 
     public function getPageLengthMenu()
     {
         // if already set, use that
-        if (! $this->getOperationSetting('pageLengthMenu')) {
+        if (!$this->getOperationSetting('pageLengthMenu')) {
             // try to get the menu settings from the config file
             $this->setOperationSetting('pageLengthMenu', config('backpack.crud.page_length_menu') ?? [[10, 25, 50, 100, -1], [10, 25, 50, 100, 'backpack::crud.all']]);
 

src/PanelTraits/HeadingsAndTitles.php

Spacing +6 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function getTitle($action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 
@@ -38,7 +38,7 @@ 
      */
     public function setTitle($string, $action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 
@@ -58,7 +58,7 @@ 
      */
     public function getHeading($action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 
@@ -75,7 +75,7 @@ 
      */
     public function setHeading($string, $action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 
@@ -95,7 +95,7 @@ 
      */
     public function getSubheading($action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 
@@ -112,7 +112,7 @@ 
      */
     public function setSubheading($string, $action = false)
     {
-        if (! $action) {
+        if (!$action) {
             $action = $this->getActionMethod();
         }
 

tests/Unit/CrudPanel/CrudPanelAutoSetTest.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace Backpack\CRUD\Tests\Unit\CrudPanel;
 
-use Doctrine\DBAL\DBALException;
 use Backpack\CRUD\Tests\Unit\Models\ColumnType;
+use Doctrine\DBAL\DBALException;
 
 class MyColumnTypeWithOtherConnection extends ColumnType
 {

src/PanelTraits/AutoFocus.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         return $this->getOperationSetting('autoFocusOnFirstField');
     }
 
+    /**
+     * @param boolean $value
+     */
     public function setAutoFocusOnFirstField($value)
     {
         return $this->setOperationSetting('autoFocusOnFirstField', (bool) $value);

src/PanelTraits/Buttons.php

Doc Comments +13 added lines, -1 removed lines

@@ -62,6 +62,9 @@ 
         $this->addButton($stack, $name, 'model_function', $model_function_name, $position);
     }
 
+    /**
+     * @param string $view
+     */
     public function addButtonFromView($stack, $name, $view, $position = false)
     {
         $view = 'crud::buttons.'.$view;
@@ -119,7 +122,7 @@ 
     }
 
     /**
-     * @param array $names Button names
+     * @param string[] $names Button names
      * @param string|null $stack Optional stack name.
      */
     public function removeButtons($names, $stack = null)
@@ -136,6 +139,9 @@ 
         $this->setOperationSetting('buttons', collect());
     }
 
+    /**
+     * @param string $stack
+     */
     public function removeAllButtonsFromStack($stack)
     {
         $this->setOperationSetting('buttons', $this->buttons()->reject(function ($button) use ($stack) {
@@ -158,6 +164,12 @@ 
     public $type = 'view';
     public $content;
 
+    /**
+     * @param string $stack
+     * @param string $name
+     * @param string $type
+     * @param string $content
+     */
     public function __construct($stack, $name, $type, $content)
     {
         $this->stack = $stack;

Spacing +5 added lines, -5 removed lines

@@ -92,7 +92,7 @@ 
          */
         $button = $this->buttons()->firstWhere('name', $name);
 
-        if (! $button) {
+        if (!$button) {
             abort(500, 'CRUD Button "'.$name.'" not found. Please check the button exists before you modify it.');
         }
 
@@ -113,7 +113,7 @@ 
      */
     public function removeButton($name, $stack = null)
     {
-        $this->setOperationSetting('buttons', $this->buttons()->reject(function ($button) use ($name, $stack) {
+        $this->setOperationSetting('buttons', $this->buttons()->reject(function($button) use ($name, $stack) {
             return $stack == null ? $button->name == $name : ($button->stack == $stack) && ($button->name == $name);
         }));
     }
@@ -124,7 +124,7 @@ 
      */
     public function removeButtons($names, $stack = null)
     {
-        if (! empty($names)) {
+        if (!empty($names)) {
             foreach ($names as $name) {
                 $this->removeButton($name, $stack);
             }
@@ -138,14 +138,14 @@ 
 
     public function removeAllButtonsFromStack($stack)
     {
-        $this->setOperationSetting('buttons', $this->buttons()->reject(function ($button) use ($stack) {
+        $this->setOperationSetting('buttons', $this->buttons()->reject(function($button) use ($stack) {
             return $button->stack == $stack;
         }));
     }
 
     public function removeButtonFromStack($name, $stack)
     {
-        $this->setOperationSetting('buttons', $this->buttons()->reject(function ($button) use ($name, $stack) {
+        $this->setOperationSetting('buttons', $this->buttons()->reject(function($button) use ($name, $stack) {
             return $button->name == $name && $button->stack == $stack;
         }));
     }

src/PanelTraits/Columns.php

Doc Comments +3 added lines, -3 removed lines

@@ -141,7 +141,7 @@ 
     /**
      * Move the most recently added column after the given target column.
      *
-     * @param string|array $targetColumn The target column name or array.
+     * @param string $targetColumn The target column name or array.
      */
     public function afterColumn($targetColumn)
     {
@@ -160,7 +160,7 @@ 
 
     /**
      * Move this column to be first in the columns list.
-     * @return bool|null
+     * @return false|null
      */
     public function makeFirstColumn()
     {
@@ -237,7 +237,7 @@ 
     /**
      * Remove a column from the CRUD panel by name.
      *
-     * @param string $column The column key.
+     * @param string $columnKey The column key.
      */
     public function removeColumn($columnKey)
     {

Spacing +14 added lines, -15 removed lines

@@ -63,7 +63,7 @@ 
     public function addColumn($column)
     {
         // if a string was passed, not an array, change it to an array
-        if (! is_array($column)) {
+        if (!is_array($column)) {
             $column = ['name' => $column];
         }
 
@@ -71,7 +71,7 @@ 
         $column_with_details = $this->addDefaultLabel($column);
 
         // make sure the column has a name
-        if (! array_key_exists('name', $column_with_details)) {
+        if (!array_key_exists('name', $column_with_details)) {
             $column_with_details['name'] = 'anonymous_column_'.str_random(5);
         }
 
@@ -79,27 +79,27 @@ 
         $columnExistsInDb = $this->hasColumn($this->model->getTable(), $column_with_details['name']);
 
         // make sure the column has a type
-        if (! array_key_exists('type', $column_with_details)) {
+        if (!array_key_exists('type', $column_with_details)) {
             $column_with_details['type'] = 'text';
         }
 
         // make sure the column has a key
-        if (! array_key_exists('key', $column_with_details)) {
+        if (!array_key_exists('key', $column_with_details)) {
             $column_with_details['key'] = $column_with_details['name'];
         }
 
         // make sure the column has a tableColumn boolean
-        if (! array_key_exists('tableColumn', $column_with_details)) {
+        if (!array_key_exists('tableColumn', $column_with_details)) {
             $column_with_details['tableColumn'] = $columnExistsInDb ? true : false;
         }
 
         // make sure the column has a orderable boolean
-        if (! array_key_exists('orderable', $column_with_details)) {
+        if (!array_key_exists('orderable', $column_with_details)) {
             $column_with_details['orderable'] = $columnExistsInDb ? true : false;
         }
 
         // make sure the column has a searchLogic
-        if (! array_key_exists('searchLogic', $column_with_details)) {
+        if (!array_key_exists('searchLogic', $column_with_details)) {
             $column_with_details['searchLogic'] = $columnExistsInDb ? true : false;
         }
 
@@ -108,14 +108,14 @@ 
 
         // make sure the column has a priority in terms of visibility
         // if no priority has been defined, use the order in the array plus one
-        if (! array_key_exists('priority', $column_with_details)) {
+        if (!array_key_exists('priority', $column_with_details)) {
             $position_in_columns_array = (int) array_search($column_with_details['key'], array_keys($this->columns()));
             $columnsArray[$column_with_details['key']]['priority'] = $position_in_columns_array + 1;
         }
 
         // if this is a relation type field and no corresponding model was specified, get it from the relation method
         // defined in the main model
-        if (isset($column_with_details['entity']) && ! isset($column_with_details['model'])) {
+        if (isset($column_with_details['entity']) && !isset($column_with_details['model'])) {
             $columnsArray[$column_with_details['key']]['model'] = $this->getRelationModel($column_with_details['entity']);
         }
 
@@ -164,7 +164,7 @@ 
      */
     public function makeFirstColumn()
     {
-        if (! $this->columns()) {
+        if (!$this->columns()) {
             return false;
         }
 
@@ -186,8 +186,7 @@ 
         $columnsArray = $this->columns();
 
         if (array_key_exists($targetColumnName, $columnsArray)) {
-            $targetColumnPosition = $before ? array_search($targetColumnName, array_keys($columnsArray)) :
-                array_search($targetColumnName, array_keys($columnsArray)) + 1;
+            $targetColumnPosition = $before ? array_search($targetColumnName, array_keys($columnsArray)) : array_search($targetColumnName, array_keys($columnsArray)) + 1;
 
             $element = array_pop($columnsArray);
             $beginningPart = array_slice($columnsArray, 0, $targetColumnPosition, true);
@@ -225,7 +224,7 @@ 
      */
     public function addDefaultLabel($array)
     {
-        if (! array_key_exists('label', (array) $array) && array_key_exists('name', (array) $array)) {
+        if (!array_key_exists('label', (array) $array) && array_key_exists('name', (array) $array)) {
             $array = array_merge(['label' => mb_ucfirst($this->makeLabel($array['name']))], $array);
 
             return $array;
@@ -253,7 +252,7 @@ 
      */
     public function removeColumns($columns)
     {
-        if (! empty($columns)) {
+        if (!empty($columns)) {
             foreach ($columns as $columnKey) {
                 $this->removeColumn($columnKey);
             }
@@ -331,7 +330,7 @@ 
     {
         $columns = $this->columns();
 
-        return collect($columns)->pluck('entity')->reject(function ($value, $key) {
+        return collect($columns)->pluck('entity')->reject(function($value, $key) {
             return $value == null;
         })->toArray();
     }

src/PanelTraits/Fields.php

Doc Comments -7 removed lines

@@ -22,7 +22,6 @@ 
      * Add a field to the create/update form or both.
      *
      * @param string|array $field The new field.
-     * @param string       $form  The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'.
      *
      * @return self
      */
@@ -70,7 +69,6 @@ 
      * Add multiple fields to the create/update form or both.
      *
      * @param array  $fields The new fields.
-     * @param string $form   The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'.
      */
     public function addFields($fields)
     {
@@ -85,7 +83,6 @@ 
      * Move the most recently added field after the given target field.
      *
      * @param string $targetFieldName The target field name.
-     * @param string $form            The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'.
      */
     public function afterField($targetFieldName)
     {
@@ -98,7 +95,6 @@ 
      * Move the most recently added field before the given target field.
      *
      * @param string $targetFieldName The target field name.
-     * @param string $form            The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'.
      */
     public function beforeField($targetFieldName)
     {
@@ -141,7 +137,6 @@ 
      * Remove a certain field from the create/update/both forms by its name.
      *
      * @param string $name Field name (as defined with the addField() procedure)
-     * @param string $form update/create/both
      */
     public function removeField($name)
     {
@@ -330,8 +325,6 @@ 
      * Check if the create/update form has upload fields.
      * Upload fields are the ones that have "upload" => true defined on them.
      *
-     * @param  string   $form create/update/both - defaults to 'both'
-     * @param  bool|int $id   id of the entity - defaults to false
      *
      * @return bool
      */

Spacing +12 added lines, -12 removed lines

@@ -38,23 +38,23 @@ 
 
         // if this is a relation type field and no corresponding model was specified, get it from the relation method
         // defined in the main model
-        if (isset($newField['entity']) && ! isset($newField['model'])) {
+        if (isset($newField['entity']) && !isset($newField['model'])) {
             $newField['model'] = $this->getRelationModel($newField['entity']);
         }
 
         // if the label is missing, we should set it
-        if (! isset($newField['label'])) {
+        if (!isset($newField['label'])) {
             $newField['label'] = mb_ucfirst(str_replace('_', ' ', $newField['name']));
         }
 
         // if the field type is missing, we should set it
-        if (! isset($newField['type'])) {
+        if (!isset($newField['type'])) {
             $newField['type'] = $this->getFieldTypeFromDbColumnType($newField['name']);
         }
 
         // if a tab was mentioned, we should enable it
         if (isset($newField['tab'])) {
-            if (! $this->tabsEnabled()) {
+            if (!$this->tabsEnabled()) {
                 $this->enableTabs();
             }
         }
@@ -89,7 +89,7 @@ 
      */
     public function afterField($targetFieldName)
     {
-        $this->transformFields(function ($fields) use ($targetFieldName) {
+        $this->transformFields(function($fields) use ($targetFieldName) {
             return $this->moveField($fields, $targetFieldName, false);
         });
     }
@@ -102,7 +102,7 @@ 
      */
     public function beforeField($targetFieldName)
     {
-        $this->transformFields(function ($fields) use ($targetFieldName) {
+        $this->transformFields(function($fields) use ($targetFieldName) {
             return $this->moveField($fields, $targetFieldName, true);
         });
     }
@@ -145,7 +145,7 @@ 
      */
     public function removeField($name)
     {
-        $this->transformFields(function ($fields) use ($name) {
+        $this->transformFields(function($fields) use ($name) {
             array_forget($fields, $name);
 
             return $fields;
@@ -159,7 +159,7 @@ 
      */
     public function removeFields($array_of_names)
     {
-        if (! empty($array_of_names)) {
+        if (!empty($array_of_names)) {
             foreach ($array_of_names as $name) {
                 $this->removeField($name);
             }
@@ -172,7 +172,7 @@ 
     public function removeAllFields()
     {
         $current_fields = $this->getCurrentFields();
-        if (! empty($current_fields)) {
+        if (!empty($current_fields)) {
             foreach ($current_fields as $field) {
                 $this->removeField($field['name']);
             }
@@ -246,7 +246,7 @@ 
                 $jsonCastables = ['array', 'object', 'json'];
                 $fieldCasting = $casted_attributes[$field['name']];
 
-                if (in_array($fieldCasting, $jsonCastables) && isset($data[$field['name']]) && ! empty($data[$field['name']]) && ! is_array($data[$field['name']])) {
+                if (in_array($fieldCasting, $jsonCastables) && isset($data[$field['name']]) && !empty($data[$field['name']]) && !is_array($data[$field['name']])) {
                     try {
                         $data[$field['name']] = json_decode($data[$field['name']]);
                     } catch (\Exception $e) {
@@ -275,7 +275,7 @@ 
      */
     public function orderFields($order)
     {
-        $this->transformFields(function ($fields) use ($order) {
+        $this->transformFields(function($fields) use ($order) {
             return $this->applyOrderToFields($fields, $order);
         });
     }
@@ -338,7 +338,7 @@ 
     public function hasUploadFields()
     {
         $fields = $this->getFields();
-        $upload_fields = array_where($fields, function ($value, $key) {
+        $upload_fields = array_where($fields, function($value, $key) {
             return isset($value['upload']) && $value['upload'] == true;
         });