Laravel-Backpack / CRUD

src/Crud.php

Doc Comments +21 added lines, -4 removed lines

@@ -334,6 +334,7 @@ 
      * Delete a row from the database.
      *
      * @param  [int] The id of the item to be deleted.
+     * @param integer $id
      * @return [bool] Deletion confirmation.
      *
      * TODO: should this delete items with relations to it too?
@@ -452,7 +453,8 @@ 
      * Check if a permission is enabled for a Crud Panel. Fail if not.
      *
      * @param  [string] Permission.
-     * @return boolean
+     * @param string $permission
+     * @return boolean|null
      */
     public function hasAccessOrFail($permission)
     {
@@ -481,6 +483,7 @@ 
      * All Create-Read-Update-Delete operations are done using that Eloquent Collection.
      *
      * @param [string] Full model namespace. Ex: App\Models\Article
+     * @param string $model_namespace
      */
     public function setModel($model_namespace)
     {
@@ -508,6 +511,7 @@ 
      *
      * @param [string] Route name.
      * @param [array] Parameters.
+     * @param string $route
      */
     public function setRoute($route)
     {
@@ -540,7 +544,7 @@ 
      * - $this->crud->setRouteName('admin.article')
      * - $this->crud->route = "admin/article"
      *
-     * @return [string]
+     * @return string
      */
     public function getRoute()
     {
@@ -553,6 +557,8 @@ 
      *
      * @param [string] Entity name, in singular. Ex: article
      * @param [string] Entity name, in plural. Ex: articles
+     * @param string $singular
+     * @param string $plural
      */
     public function setEntityNameStrings($singular, $plural) {
         $this->entity_name = $singular;
@@ -731,8 +737,6 @@ 
 
     /**
      * Add a field to the create/update form or both.
-     * @param [string] $name    Field name (the column name in the db in most cases)
-     * @param [array] $options Field-type-specific information.
      * @param string $form    The form to add the field to (create/update/both)
      */
     public function addField($field, $form='both')
@@ -1374,6 +1378,9 @@ 
     //     return array_filter($this->{$entity}[] = $this->syncField($field));
     // }
 
+    /**
+     * @param string $entity
+     */
     public function addMultiple($entity, $field)
     {
         $this->{$entity} = array_filter(array_map([$this, 'syncField'], $fields));
@@ -1398,11 +1405,17 @@ 
     //     return array_values(array_filter($this->{$entity}, function($field) use ($fields) { return !in_array($field['name'], (array)$fields);}));
     // }
 
+    /**
+     * @param string $items
+     */
     public function setSort($items, $order)
     {
         $this->sort[$items] = $order;
     }
 
+    /**
+     * @param string $items
+     */
     public function sort($items)
     {
         if (array_key_exists($items, $this->sort))
@@ -1438,6 +1451,10 @@ 
     }
 
     // face un fel de merge intre ce ii dai si ce e in CRUD
+
+    /**
+     * @param string $entity
+     */
     public function syncRelations($entity)
     {
         foreach ($this->relations as $field => $relation) {

Spacing +27 added lines, -27 removed lines

@@ -101,8 +101,8 @@ 
 
         $relationFields = [];
 
-        foreach($fields as $field){
-            if(isset($field['model']) || isset($field['dependencies'])){
+        foreach ($fields as $field) {
+            if (isset($field['model']) || isset($field['dependencies'])) {
                 array_push($relationFields, $field);
             }
         }
@@ -118,22 +118,22 @@ 
 
         foreach ($relations as $key => $relation)
         {
-            if ( (isset($relation['pivot']) && $relation['pivot'] ) || isset($relation['dependencies']) ){
-                if(is_array($relation['name'])){
-                    foreach($relation['name'] as $relation){
-                        if(isset($data[$relation])){
+            if ((isset($relation['pivot']) && $relation['pivot']) || isset($relation['dependencies'])) {
+                if (is_array($relation['name'])) {
+                    foreach ($relation['name'] as $relation) {
+                        if (isset($data[$relation])) {
                             $model->{$relation}()->sync($data[$relation]);
-                        }else{
+                        } else {
                              $model->{$relation}()->sync([]);
                         }
                     }
-                }else{
+                } else {
                     $model->{$relation['name']}()->sync($data[$relation['name']]);
                 }
 
-                if( isset($relation['pivotFields']) ){
-                    foreach($relation['pivotFields'] as $pivotField){
-                       foreach($data[$pivotField] as $pivot_id =>  $field){
+                if (isset($relation['pivotFields'])) {
+                    foreach ($relation['pivotFields'] as $pivotField) {
+                       foreach ($data[$pivotField] as $pivot_id =>  $field) {
                          $model->{$relation['name']}()->updateExistingPivot($pivot_id, [$pivotField => $field]);
                        }
                     }
@@ -298,14 +298,14 @@ 
             // set the value
             if (!isset($fields[$k]['value']))
             {
-                if(is_array($field['name'])){
+                if (is_array($field['name'])) {
 
                     $fields[$k]['value'] = [];
-                    foreach($field['name'] as  $key => $relation){
+                    foreach ($field['name'] as  $key => $relation) {
                         $fields[$k]['value'][] = $entry->{$relation};
                     }
 
-                }else{
+                } else {
                     $fields[$k]['value'] = $entry->{$field['name']};
                 }
             }
@@ -424,13 +424,13 @@ 
     public function allowAccess($access)
     {
         // $this->addButtons((array)$access);
-        return $this->access = array_merge(array_diff((array)$access, $this->access), $this->access);
+        return $this->access = array_merge(array_diff((array) $access, $this->access), $this->access);
     }
 
     public function denyAccess($access)
     {
         // $this->removeButtons((array)$access);
-        return $this->access = array_diff($this->access, (array)$access);
+        return $this->access = array_diff($this->access, (array) $access);
     }
 
     /**
@@ -643,7 +643,7 @@ 
      */
     public function addDefaultTypeToColumn($column)
     {
-        if (array_key_exists('name', (array)$column))
+        if (array_key_exists('name', (array) $column))
         {
             $default_type = $this->getFieldTypeFromDbColumnType($column['name']);
             return array_merge(['type' => $default_type], $column);
@@ -659,7 +659,7 @@ 
      * @param [field or column]
      */
     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' => ucfirst($this->makeLabel($array['name']))], $array);
             return $array;
         }
@@ -735,7 +735,7 @@ 
      * @param [array] $options Field-type-specific information.
      * @param string $form    The form to add the field to (create/update/both)
      */
-    public function addField($field, $form='both')
+    public function addField($field, $form = 'both')
     {
         // if the field_defition_array array is a string, it means the programmer was lazy and has only passed the name
         // set some default values, so the field will still work
@@ -778,7 +778,7 @@ 
      * @param  string $name Field name (as defined with the addField() procedure)
      * @param  string $form update/create/both
      */
-    public function removeField($name, $form='both')
+    public function removeField($name, $form = 'both')
     {
         switch (strtolower($form)) {
             case 'create':
@@ -801,7 +801,7 @@ 
      * @param  array $array_of_names A simple array of the names of the fields to be removed.
      * @param  string $form          update/create/both
      */
-    public function removeFields($array_of_names, $form='both')
+    public function removeFields($array_of_names, $form = 'both')
     {
         if (!empty($array_of_names)) {
             foreach ($array_of_names as $name) {
@@ -922,7 +922,7 @@ 
         array_map(function($field) {
             // $this->labels[$field] = $this->makeLabel($field);
 
-            $new_field =  [
+            $new_field = [
                                 'name' => $field,
                                 'label' => ucfirst($field),
                                 'value' => '', 'default' => $this->field_types[$field]['default'],
@@ -1263,7 +1263,7 @@ 
 
     public function orderColumns($order)
     {
-        $this->setSort('columns', (array)$order);
+        $this->setSort('columns', (array) $order);
     }
 
 
@@ -1338,7 +1338,7 @@ 
 
     public function orderFields($order)
     {
-        $this->setSort('fields', (array)$order);
+        $this->setSort('fields', (array) $order);
     }
 
 
@@ -1384,7 +1384,7 @@ 
         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);
+                if (in_array($field['name'], (array) $fields)) $field = array_merge($field, $attributes);
 
                 return $field;
             }, $this->{$type});
@@ -1414,7 +1414,7 @@ 
                 if (is_numeric($key = array_search($item, array_column($this->{$items}, 'name')))) $elements[] = $this->{$items}[$key];
             }
 
-            return $this->{$items} = array_merge($elements, array_filter($this->{$items}, function($item) use($items) {return !in_array($item['name'], $this->sort[$items]);}));
+            return $this->{$items} = array_merge($elements, array_filter($this->{$items}, function($item) use($items) {return !in_array($item['name'], $this->sort[$items]); }));
         }
 
         return $this->{$items};
@@ -1427,7 +1427,7 @@ 
     // cred ca ia valorile din tabela de legatura ca sa ti le afiseze in select
     public function getRelationValues($model, $field, $where = [], $order = [])
     {
-        $order = (array)$order;
+        $order = (array) $order;
         $values = $model->select('*');
 
         if (!empty($where)) call_user_func_array([$values, $where[0]], array_slice($where, 1));

Braces +52 added lines, -27 removed lines

@@ -93,8 +93,7 @@ 
         if ($form == 'create')
         {
             $fields = $this->create_fields;
-        }
-        else
+        } else
         {
             $fields = $this->update_fields;
         }
@@ -123,11 +122,11 @@ 
                     foreach($relation['name'] as $relation){
                         if(isset($data[$relation])){
                             $model->{$relation}()->sync($data[$relation]);
-                        }else{
+                        } else{
                              $model->{$relation}()->sync([]);
                         }
                     }
-                }else{
+                } else{
                     $model->{$relation['name']}()->sync($data[$relation['name']]);
                 }
 
@@ -305,7 +304,7 @@ 
                         $fields[$k]['value'][] = $entry->{$relation};
                     }
 
-                }else{
+                } else{
                     $fields[$k]['value'] = $entry->{$field['name']};
                 }
             }
@@ -484,7 +483,9 @@ 
      */
     public function setModel($model_namespace)
     {
-        if (!class_exists($model_namespace)) throw new \Exception('This model does not exist.', 404);
+        if (!class_exists($model_namespace)) {
+            throw new \Exception('This model does not exist.', 404);
+        }
 
         $this->model = new $model_namespace();
         $this->query = $this->model->select('*');
@@ -526,7 +527,9 @@ 
     {
         $complete_route = $route.'.index';
 
-        if (!\Route::has($complete_route)) throw new \Exception('There are no routes for this route name.', 404);
+        if (!\Route::has($complete_route)) {
+            throw new \Exception('There are no routes for this route name.', 404);
+        }
 
         $this->route = route($complete_route, $parameters);
         $this->initButtons();
@@ -582,8 +585,7 @@ 
                 // if label and other details have been defined in the array
                 if (is_array($columns[0])) {
                     $this->addColumn($column);
-                }
-                else
+                } else
                 {
                     $this->addColumn([
                                     'name' => $column,
@@ -742,19 +744,20 @@ 
         if (is_string($field))
         {
             $complete_field_array['name'] = $field;
-        }
-        else
+        } else
         {
             $complete_field_array = $field;
         }
 
         // if the label is missing, we should set it
-        if (!isset($complete_field_array['label']))
-            $complete_field_array['label'] = ucfirst($complete_field_array['name']);
+        if (!isset($complete_field_array['label'])) {
+                    $complete_field_array['label'] = ucfirst($complete_field_array['name']);
+        }
 
         // if the field type is missing, we should set it
-        if (!isset($complete_field_array['type']))
-            $complete_field_array['type'] = $this->getFieldTypeFromDbColumnType($complete_field_array['name']);
+        if (!isset($complete_field_array['type'])) {
+                    $complete_field_array['type'] = $this->getFieldTypeFromDbColumnType($complete_field_array['name']);
+        }
 
         // store the field information into the correct variable on the CRUD object
         switch (strtolower($form)) {
@@ -970,11 +973,17 @@ 
      */
     public function getFieldTypeFromDbColumnType($field)
     {
-        if (!array_key_exists($field, $this->field_types)) return 'text';
+        if (!array_key_exists($field, $this->field_types)) {
+            return 'text';
+        }
 
-        if ($field == 'password') return 'password';
+        if ($field == 'password') {
+            return 'password';
+        }
 
-        if ($field == 'email') return 'email';
+        if ($field == 'email') {
+            return 'email';
+        }
 
         switch ($this->field_types[$field]['type'])
         {
@@ -1047,7 +1056,9 @@ 
         $columns = \Schema::getColumnListing($this->model->getTable());
         $fillable = $this->model->getFillable();
 
-        if (!empty($fillable)) $columns = array_intersect($columns, $fillable);
+        if (!empty($fillable)) {
+            $columns = array_intersect($columns, $fillable);
+        }
 
         // but not updated_at, deleted_at
         return array_values(array_diff($columns, [$this->model->getKeyName(), 'updated_at', 'deleted_at']));
@@ -1363,8 +1374,11 @@ 
 
             foreach ($this->{$fields} as $key => $field)
             {
-                if (array_key_exists($field['name'], $this->relations) && $this->relations[$field['name']]['pivot']) $this->{$fields}[$key]['value'] = $this->entry->{$this->relations[$field['name']]['name']}()->lists($this->relations[$field['name']]['model']->getKeyName())->toArray();
-                    else $this->{$fields}[$key]['value'] = $this->entry->{$field['name']};
+                if (array_key_exists($field['name'], $this->relations) && $this->relations[$field['name']]['pivot']) {
+                    $this->{$fields}[$key]['value'] = $this->entry->{$this->relations[$field['name']]['name']}()->lists($this->relations[$field['name']]['model']->getKeyName())->toArray();
+                } else {
+                        $this->{$fields}[$key]['value'] = $this->entry->{$field['name']};
+                    }
             }
         }
     }
@@ -1384,7 +1398,9 @@ 
         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);
+                if (in_array($field['name'], (array)$fields)) {
+                    $field = array_merge($field, $attributes);
+                }
 
                 return $field;
             }, $this->{$type});
@@ -1411,7 +1427,9 @@ 
 
             foreach ($this->sort[$items] as $item)
             {
-                if (is_numeric($key = array_search($item, array_column($this->{$items}, 'name')))) $elements[] = $this->{$items}[$key];
+                if (is_numeric($key = array_search($item, array_column($this->{$items}, 'name')))) {
+                    $elements[] = $this->{$items}[$key];
+                }
             }
 
             return $this->{$items} = array_merge($elements, array_filter($this->{$items}, function($item) use($items) {return !in_array($item['name'], $this->sort[$items]);}));
@@ -1430,9 +1448,13 @@ 
         $order = (array)$order;
         $values = $model->select('*');
 
-        if (!empty($where)) call_user_func_array([$values, $where[0]], array_slice($where, 1));
+        if (!empty($where)) {
+            call_user_func_array([$values, $where[0]], array_slice($where, 1));
+        }
 
-        if (!empty($order)) call_user_func_array([$values, 'orderBy'], $order);
+        if (!empty($order)) {
+            call_user_func_array([$values, 'orderBy'], $order);
+        }
 
         return $values->get()->lists($field, $model->getKeyName())->toArray();
     }
@@ -1441,8 +1463,11 @@ 
     public function syncRelations($entity)
     {
         foreach ($this->relations as $field => $relation) {
-            if ($relation['pivot']) $this->add($entity, ['name' => $field, 'type' => 'multiselect', 'value' => [], 'values' => $this->relations[$field]['values']]);
-                else $this->sync($entity, $field, ['type' => 'select', 'values' => $this->relations[$field]['values']]);
+            if ($relation['pivot']) {
+                $this->add($entity, ['name' => $field, 'type' => 'multiselect', 'value' => [], 'values' => $this->relations[$field]['values']]);
+            } else {
+                    $this->sync($entity, $field, ['type' => 'select', 'values' => $this->relations[$field]['values']]);
+                }
         }
     }