sminnee / silverstripe-framework

Forms/AssetField.php

Doc Comments +6 added lines, -2 removed lines

@@ -195,7 +195,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) {
@@ -264,6 +264,10 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param null|DataObject $value
+	 * @param DataObject $record
+	 */
 	public function setValue($value, $record = null) {
 		// Extract value from underlying record
 		if(empty($value) && $this->getName() && $record instanceof DataObject) {
@@ -370,7 +374,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) {

Forms/CompositeField.php

Doc Comments +14 added lines

@@ -209,6 +209,9 @@ 
 
 
 
+	/**
+	 * @param boolean $disabled
+	 */
 	public function setDisabled($disabled) {
 		parent::setDisabled($disabled);
 		foreach($this->getChildren() as $child) {
@@ -217,6 +220,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $readonly
+	 */
 	public function setReadonly($readonly)
 	{
 		parent::setReadonly($readonly);
@@ -299,6 +305,10 @@ 
 		$this->children->removeByName($fieldName, $dataFieldOnly);
 	}
 
+	/**
+	 * @param string $fieldName
+	 * @param FormField $newField
+	 */
 	public function replaceField($fieldName, $newField) {
 		return $this->children->replaceField($fieldName, $newField);
 	}
@@ -362,6 +372,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @return boolean
+	 */
 	public function IsReadonly() {
 		return $this->readonly;
 	}
@@ -371,6 +384,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.
 	 */

Forms/DateField.php

Doc Comments +6 added lines, -1 removed lines

@@ -99,6 +99,11 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param string $value
+	 */
 	public function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -300,7 +305,7 @@ 
 	}
 
 	/**
-	 * @param mixed $class
+	 * @param string $class
 	 * @return FormField
 	 */
 	public function castedCopy($class) {

Forms/DatetimeField.php

Doc Comments +20 added lines, -4 removed lines

@@ -69,6 +69,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -79,6 +83,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -89,6 +96,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -101,7 +111,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -115,7 +125,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/client/dist/styles/DatetimeField.css');
@@ -228,6 +238,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
 		$this->dateField->setReadonly($bool);
@@ -317,7 +330,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 * @return $this
 	 */
 	public function setConfig($name, $val) {
@@ -336,7 +349,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -346,6 +359,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

Forms/FieldList.php

Doc Comments +6 added lines, -2 removed lines

@@ -79,6 +79,9 @@ 
 		$this->sequentialSaveableSet = null;
 	}
 
+	/**
+	 * @param FormField[] $list
+	 */
 	protected function collateDataFields(&$list, $saveableOnly = false) {
 		foreach($this as $field) {
 			if($field instanceof CompositeField) {
@@ -175,7 +178,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) {
 		$this->flushFieldsCache();
@@ -568,7 +571,7 @@ 
 	}
 
 	/**
-	 * @param $field
+	 * @param CompositeField $field
 	 * @return $this
 	 */
 	public function setContainerField($field) {
@@ -638,6 +641,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.
 	 */

Forms/FileField.php

Doc Comments +1 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -259,7 +259,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {

Forms/Form.php

Doc Comments +4 added lines, -3 removed lines

@@ -533,7 +533,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) {
@@ -593,7 +593,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
 	 */
@@ -734,6 +734,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 * @return $this
 	 */
 	public function setValidationExemptActions($actions) {
@@ -1131,7 +1132,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) {

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use SilverStripe\ORM\DataQuery;
 use SilverStripe\ORM\DB;
-use InvalidArgumentException;
 
 /**
  * Matches textual content with a LIKE '%keyword%' construct.

Forms/FormAction.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * Determines if the field should render open or closed by default.
 	 *
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function startClosed($bool) {
 		($bool) ? $this->addExtraClass('startClosed') : $this->removeExtraClass('startClosed');

Forms/FormField.php

Doc Comments +2 added lines, -3 removed lines

@@ -769,7 +769,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 * @return $this
 	 */
 	public function setValue($value) {
@@ -1184,7 +1183,7 @@ 
 	/**
 	 * @param FormTransformation $transformation
 	 *
-	 * @return mixed
+	 * @return FormField
 	 */
 	public function transform(FormTransformation $transformation) {
 		return $transformation->transform($this);
@@ -1287,7 +1286,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() {
 		return $this->Field();

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use SilverStripe\ORM\DataQuery;
 use SilverStripe\ORM\DB;
-use InvalidArgumentException;
 
 /**
  * Matches textual content with a LIKE '%keyword%' construct.