Cherry-Pie / Jarboe

src/Jarboe/Http/Controllers/AbstractTableController.php

Doc Comments +4 added lines, -4 removed lines

@@ -104,9 +104,6 @@ 
      * Handle relation search action.
      * Currently used for SelectField with type `select2` and `ajax = true`.
      *
-     * @param string $field
-     * @param string $page
-     * @param string $term
      * @return \Illuminate\Http\JsonResponse
      */
     public function searchRelation(Request $request)
@@ -712,6 +709,9 @@ 
         }
     }
 
+    /**
+     * @param string $title
+     */
     protected function addTab($title, array $fields)
     {
         foreach ($fields as $field) {
@@ -807,7 +807,7 @@ 
     /**
      * Check if user has permission for the action.
      *
-     * @param $action
+     * @param string $action
      * @return bool
      */
     protected function can($action): bool

src/Jarboe/Table/CRUD.php

Doc Comments +9 added lines

@@ -273,6 +273,9 @@ 
         return sprintf('%s%s%s/force-delete', $this->baseUrl(), self::BASE_URL_DELIMITER, $id);
     }
 
+    /**
+     * @param string $identifier
+     */
     public function toolbarUrl($identifier)
     {
         return sprintf('%s%stoolbar/%s', $this->baseUrl(), self::BASE_URL_DELIMITER, $identifier);
@@ -325,6 +328,9 @@ 
         return rtrim($chunks[0], '/');
     }
 
+    /**
+     * @param integer $ident
+     */
     public function tableIdentifier($ident = null)
     {
         if (is_null($ident)) {
@@ -369,6 +375,9 @@ 
         $this->preferences()->saveCurrentLocale($this->tableIdentifier(), $locale);
     }
 
+    /**
+     * @return \Illuminate\Http\Request
+     */
     public function getTool($ident)
     {
         if (array_key_exists($ident, $this->toolbar)) {

src/Jarboe/Table/Fields/AbstractField.php

Doc Comments +3 added lines

@@ -40,6 +40,9 @@
         return $field;
     }
 
+    /**
+     * @param string $model
+     */
     public function setModel($model)
     {
         $this->model = $model;

src/Jarboe/Table/Fields/Traits/Storage.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
         return $this;
     }
 
+    /**
+     * @return string
+     */
     public function getPath()
     {
         return $this->path;

src/Jarboe/Table/Fields/Traits/Relations.php

Doc Comments +3 added lines

@@ -254,6 +254,9 @@
         return $this;
     }
 
+    /**
+     * @return integer
+     */
     abstract public function getModel();
     abstract public function isMultiple();
 }

src/Jarboe/Table/Actions/ActionsContainer.php

Doc Comments +9 added lines

@@ -64,6 +64,9 @@ 
         $this->add($actions);
     }
 
+    /**
+     * @param string $ident
+     */
     public function isAllowed($ident, $model = null): bool
     {
         $action = $this->find($ident);
@@ -84,6 +87,9 @@ 
         return $action->shouldRender($model);
     }
 
+    /**
+     * @param string $baseActionIdent
+     */
     public function moveAfter($baseActionIdent, $movableActionIdent)
     {
         $actions = [];
@@ -102,6 +108,9 @@ 
         $this->actions = $actions;
     }
 
+    /**
+     * @param string $baseActionIdent
+     */
     public function moveBefore($baseActionIdent, $movableActionIdent)
     {
         $actions = [];

src/Jarboe/Table/Toolbar/Interfaces/ToolInterface.php

Doc Comments +1 added lines

@@ -43,6 +43,7 @@
      * Set CRUD object.
      *
      * @param CRUD $crud
+     * @return void
      */
     public function setCrud(CRUD $crud);
 

src/Jarboe/Table/Fields/Traits/Placeholder.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
 {
     protected $placeholder;
 
+    /**
+     * @param string $placeholder
+     */
     public function placeholder($placeholder)
     {
         $this->placeholder = $placeholder;

src/Jarboe/Table/Fields/Interfaces/FieldPropsInterface.php

Doc Comments +23 added lines

@@ -4,15 +4,38 @@
 
 interface FieldPropsInterface
 {
+    /**
+     * @return boolean
+     */
     public function isEncode();
+
+    /**
+     * @return boolean
+     */
     public function isInline();
+
+    /**
+     * @return boolean
+     */
     public function isMarkupRow();
     public function isMultiple();
     public function isOrderable();
+
+    /**
+     * @return boolean
+     */
     public function isRelationField();
     public function isNullable();
+
+    /**
+     * @return boolean
+     */
     public function hasTooltip();
     public function hasClipboardButton();
     public function isTranslatable();
+
+    /**
+     * @return boolean
+     */
     public function isMaskable();
 }