silverstripe / silverstripe-framework

src/Forms/DatetimeField.php

Doc Comments +20 added lines, -4 removed lines

@@ -70,6 +70,10 @@ 
      */
     protected $config;
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title = null, $value = "")
     {
         $this->config = $this->config()->default_config;
@@ -81,6 +85,9 @@ 
         parent::__construct($name, $title, $value);
     }
 
+    /**
+     * @param Form $form
+     */
     public function setForm($form)
     {
         parent::setForm($form);
@@ -92,6 +99,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $name
+     */
     public function setName($name)
     {
         parent::setName($name);
@@ -105,7 +115,7 @@ 
 
     /**
      * @param array $properties
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function FieldHolder($properties = array())
     {
@@ -120,7 +130,7 @@ 
 
     /**
      * @param array $properties
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function Field($properties = array())
     {
@@ -254,6 +264,9 @@ 
         return $this;
     }
 
+    /**
+     * @param boolean $bool
+     */
     public function setReadonly($bool)
     {
         parent::setReadonly($bool);
@@ -354,7 +367,7 @@ 
      * to set field-specific config options.
      *
      * @param string $name
-     * @param mixed $val
+     * @param string $val
      * @return $this
      */
     public function setConfig($name, $val)
@@ -374,7 +387,7 @@ 
      * to get field-specific config options.
      *
      * @param String $name Optional, returns the whole configuration array if empty
-     * @return mixed
+     * @return string|null
      */
     public function getConfig($name = null)
     {
@@ -385,6 +398,9 @@ 
         }
     }
 
+    /**
+     * @param RequiredFields $validator
+     */
     public function validate($validator)
     {
         $dateValid = $this->dateField->validate($validator);

src/Forms/FieldList.php

Doc Comments +6 added lines, -2 removed lines

@@ -86,6 +86,9 @@ 
         $this->sequentialSaveableSet = null;
     }
 
+    /**
+     * @param FormField[] $list
+     */
     protected function collateDataFields(&$list, $saveableOnly = false)
     {
         foreach ($this as $field) {
@@ -191,7 +194,7 @@ 
      * Removes a number of fields from a Tab/TabSet within this FieldList.
      *
      * @param string $tabName The name of the Tab or TabSet field
-     * @param array $fields A list of fields, e.g. array('Name', 'Email')
+     * @param string[] $fields A list of fields, e.g. array('Name', 'Email')
      */
     public function removeFieldsFromTab($tabName, $fields)
     {
@@ -618,7 +621,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param CompositeField $field
      * @return $this
      */
     public function setContainerField($field)
@@ -700,6 +703,7 @@ 
      * the children collection. Doesn't work recursively.
      *
      * @param string|FormField
+     * @param string $field
      * @return int Position in children collection (first position starts with 0).
      * Returns FALSE if the field can't be found.
      */

src/Forms/Form.php

Doc Comments +4 added lines, -3 removed lines

@@ -541,7 +541,7 @@ 
      * The callback can opt out of handling specific responses by returning NULL,
      * in which case the default form behaviour will kick in.
      *
-     * @param $callback
+     * @param \Closure $callback
      * @return self
      */
     public function setValidationResponseCallback($callback)
@@ -603,7 +603,7 @@ 
     /**
      * Fields can have action to, let's check if anyone of the responds to $funcname them
      *
-     * @param SS_List|array $fields
+     * @param FieldList $fields
      * @param callable $funcName
      * @return FormField
      */
@@ -755,6 +755,7 @@ 
      * Set actions that are exempt from validation
      *
      * @param array
+     * @param string[] $actions
      * @return $this
      */
     public function setValidationExemptActions($actions)
@@ -1198,7 +1199,7 @@ 
      * If set to false (the default), then the form method is only used to construct the default
      * form.
      *
-     * @param $bool boolean
+     * @param boolean $bool boolean
      * @return $this
      */
     public function setStrictFormMethodCheck($bool)

src/Forms/FormField.php

Doc Comments +2 added lines, -3 removed lines

@@ -807,7 +807,6 @@ 
      * Set the field value.
      *
      * @param mixed $value
-     * @param null|array|DataObject $data {@see Form::loadDataFrom}
      * @return $this
      */
     public function setValue($value)
@@ -1251,7 +1250,7 @@ 
     /**
      * @param FormTransformation $transformation
      *
-     * @return mixed
+     * @return FormField
      */
     public function transform(FormTransformation $transformation)
     {
@@ -1362,7 +1361,7 @@ 
      * This function is used by the template processor. If you refer to a field as a $ variable, it
      * will return the $Field value.
      *
-     * @return string
+     * @return DBHTMLText
      */
     public function forTemplate()
     {

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/GridField/GridFieldPrintButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
     /**
      * Get location of all editor.css files
      *
-     * @return array
+     * @return string[]
      */
     protected function getEditorCSS() {
         $editor = array();