silverstripe / silverstripe-framework

forms/DatetimeField.php

Doc Comments +18 added lines, -3 removed lines

@@ -63,6 +63,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -75,6 +79,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -85,6 +92,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -97,7 +107,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -249,6 +259,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -274,6 +285,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -312,7 +324,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -330,7 +342,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) {
 		if($name) {
@@ -340,6 +352,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/FileField.php

Doc Comments +1 added lines, -2 removed lines

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

forms/FormAction.php

Doc Comments +2 added lines, -1 removed lines

@@ -93,7 +93,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge(
@@ -158,6 +158,7 @@ 
 	 * Enable or disable the rendering of this action as a <button />
 	 *
 	 * @param boolean
+	 * @param boolean $bool
 	 * @return $this
 	 */
 	public function setUseButtonTag($bool) {

forms/FormField.php

Doc Comments +5 added lines, -4 removed lines

@@ -647,6 +647,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -758,7 +759,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1239,6 +1239,7 @@ 
 	 * @todo Make this abstract.
 	 *
 	 * @param Validator
+	 * @param RequiredFields $validator
 	 *
 	 * @return bool
 	 */
@@ -1286,7 +1287,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();
@@ -1308,7 +1309,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;
@@ -1471,7 +1472,7 @@ 
 	 * Any passed keys that are not defined in {@link getSchemaDataDefaults()} are ignored.
 	 * If you want to pass around ad hoc data use the `data` array e.g. pass `['data' => ['myCustomKey' => 'yolo']]`.
 	 *
-	 * @param array $schemaData - The data to be merged with $this->schemaData.
+	 * @param array $schemaState - The data to be merged with $this->schemaData.
 	 * @return FormField
 	 *
 	 * @todo Add deep merging of arrays like `data` and `attributes`.

forms/HiddenField.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function FieldHolder($properties = array()) {
 		return $this->Field($properties);

forms/LookupField.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 	 *
 	 * @param array $properties
 	 *
-	 * @return string
+	 * @return SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		$source = ArrayLib::flatten($this->getSource());

forms/TextField.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	}
 
 	/**
-	 * @return null|int
+	 * @return integer
 	 */
 	public function getMaxLength() {
 		return $this->maxLength;
@@ -73,7 +73,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function InternallyLabelledField() {
 		Deprecation::notice('4.0', 'Please use ->setValue() instead');

forms/TreeDropdownField.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -216,7 +216,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/client/lang');

forms/UploadField.php

Doc Comments +5 added lines, -5 removed lines

@@ -285,7 +285,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()) return false;
@@ -638,7 +638,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) return false;
@@ -662,7 +662,7 @@ 
 	 * Determine if the user has permission to attach existing files
 	 * By default returns true if the user has the CMS_ACCESS_AssetAdmin permission
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canAttachExisting() {
 		if(!$this->isActive()) return false;
@@ -1094,7 +1094,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1457,7 +1457,7 @@ 
 	 * Action to handle editing of a single file
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return DBHTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state