silverstripe / silverstripe-framework

src/Forms/GridField/GridField.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,7 @@
      *
      * @todo refactor this into GridFieldComponent
      *
-     * @param mixed $value
+     * @param string $value
      * @param string|array $castingDefinition
      *
      * @return mixed

src/Forms/GridField/GridFieldDetailForm_ItemRequest.php

Doc Comments +9 added lines

@@ -92,6 +92,9 @@ 
         parent::__construct();
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         return Controller::join_links(
@@ -341,6 +344,9 @@ 
         return $c;
     }
 
+    /**
+     * @return string
+     */
     protected function getBackLink()
     {
         // TODO Coupling with CMS
@@ -448,6 +454,9 @@ 
         }
     }
 
+    /**
+     * @param integer $errorCode
+     */
     public function httpError($errorCode, $errorMessage = null)
     {
         $controller = $this->getToplevelController();

src/Forms/GridField/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
      * Which columns are handled by this component
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -87,7 +87,7 @@ 
      * @param GridField $gridField
      * @param DataObject $record
      * @param string $columnName
-     * @return string The HTML for the column
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText The HTML for the column
      */
     public function getColumnContent($gridField, $record, $columnName)
     {

src/Forms/GridField/GridFieldExportButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -75,7 +75,7 @@ 
      * export is an action button
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {
@@ -149,7 +149,7 @@ 
      * Generate export fields for CSV.
      *
      * @param GridField $gridField
-     * @return array
+     * @return string
      */
     public function generateExportFileData($gridField)
     {

src/Forms/HiddenField.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 
     /**
      * @param array $properties
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function FieldHolder($properties = array())
     {

src/Forms/HTMLEditor/EmbedShortcodeProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     /**
      * Gets the list of shortcodes provided by this handler
      *
-     * @return mixed
+     * @return string[]
      */
     public static function get_shortcodes()
     {

src/Forms/HTMLEditor/HTMLEditorField_Embed.php

Doc Comments +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
     }
 
     /**
-     * @return AdapterInterface
+     * @return Embed
      */
     public function getEmbed()
     {

src/Forms/HTMLEditor/HTMLEditorField_Toolbar.php

Doc Comments +5 added lines, -1 removed lines

@@ -67,6 +67,10 @@ 
      */
     protected $name;
 
+    /**
+     * @param Controller|null $controller
+     * @param string $name
+     */
     public function __construct($controller, $name)
     {
         parent::__construct();
@@ -508,7 +512,7 @@ 
     /**
      * Find all anchors available on the given page.
      *
-     * @return array
+     * @return string
      * @throws HTTPResponse_Exception
      */
     public function getanchors()

src/Forms/HTMLEditor/HTMLEditorSanitiser.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     /**
      * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
      *
-     * @param $str - The TinyMCE pattern
+     * @param string|null $str - The TinyMCE pattern
      * @return string - The equivalent regex
      */
     protected function patternToRegex($str)