Laravel-Backpack / CRUD

src/app/Library/CrudPanel/Traits/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 +3 added lines, -3 removed lines

@@ -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);
         }));
     }
@@ -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/app/Library/CrudPanel/Traits/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)
     {
@@ -161,7 +161,7 @@ 
     /**
      * Move this column to be first in the columns list.
      *
-     * @return bool|null
+     * @return false|null
      */
     public function makeFirstColumn()
     {
@@ -239,7 +239,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 +2 added lines, -3 removed lines

@@ -187,8 +187,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);
@@ -334,7 +333,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/app/Library/CrudPanel/Traits/Delete.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      *
      * TODO: should this delete items with relations to it too?
      *
-     * @return bool True if the item was deleted.
+     * @return string True if the item was deleted.
      */
     public function delete($id)
     {

src/app/Library/CrudPanel/Traits/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 +5 added lines, -5 removed lines

@@ -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;
@@ -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;
         });
 

src/app/Library/CrudPanel/Traits/Operations.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
     /**
      * Convenience method to make sure all calls are made to a particular operation.
      *
-     * @param string|array  $operation Operation name in string form
+     * @param string|array  $operations Operation name in string form
      * @param bool|\Closure $closure   Code that calls CrudPanel methods.
      *
      * @return void
@@ -71,7 +71,7 @@ 
      * Allc configurations are put inside that operation's namespace.
      * Ex: show.configuration.
      *
-     * @param string|array  $operation Operation name in string form
+     * @param string|array  $operations Operation name in string form
      * @param bool|\Closure $closure   Code that calls CrudPanel methods.
      *
      * @return void

src/app/Library/CrudPanel/Traits/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
      * Order results of the query in a custom way.
      *
      * @param array  $column           Column array with all attributes
-     * @param string $column_direction ASC or DESC
+     * @param string $columnDirection ASC or DESC
      *
      * @return \Illuminate\Database\Eloquent\Builder
      */

src/app/Library/CrudPanel/Traits/Tabs.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
         return !$this->tabsEnabled();
     }
 
+    /**
+     * @param string $type
+     */
     public function setTabsType($type)
     {
         $this->enableTabs();

Spacing +4 added lines, -4 removed lines

@@ -114,7 +114,7 @@ 
     {
         $all_fields = $this->getCurrentFields();
 
-        $fields_without_a_tab = collect($all_fields)->filter(function ($value, $key) {
+        $fields_without_a_tab = collect($all_fields)->filter(function($value, $key) {
             return !isset($value['tab']);
         });
 
@@ -131,7 +131,7 @@ 
         if ($this->tabExists($label)) {
             $all_fields = $this->getCurrentFields();
 
-            $fields_for_current_tab = collect($all_fields)->filter(function ($value, $key) use ($label) {
+            $fields_for_current_tab = collect($all_fields)->filter(function($value, $key) use ($label) {
                 return isset($value['tab']) && $value['tab'] == $label;
             });
 
@@ -150,10 +150,10 @@ 
         $fields = $this->getCurrentFields();
 
         $fields_with_tabs = collect($fields)
-            ->filter(function ($value, $key) {
+            ->filter(function($value, $key) {
                 return isset($value['tab']);
             })
-            ->each(function ($value, $key) use (&$tabs) {
+            ->each(function($value, $key) use (&$tabs) {
                 if (!in_array($value['tab'], $tabs)) {
                     $tabs[] = $value['tab'];
                 }

src/app/Library/CrudPanel/Traits/Validation.php

Doc Comments -1 removed lines

@@ -107,7 +107,6 @@
      * for the given operation.
      *
      * @param string $inputKey  Field or input name.
-     * @param string $operation create / update
      *
      * @return bool
      */

src/Stats.php

Doc Comments +2 added lines, -2 removed lines

@@ -8,7 +8,7 @@ 
      * Check if the application is running in normal conditions
      * (production env, not in console, not in unit tests).
      *
-     * @return void
+     * @return boolean
      */
     private function runningInProduction()
     {
@@ -85,7 +85,7 @@ 
      * @param string $url     URL to point the request at.
      * @param array  $payload The data you want sent to the URL.
      *
-     * @return void
+     * @return boolean
      */
     private function makeCurlRequest($method, $url, $payload)
     {