sminnee / silverstripe-framework

forms/DatetimeField.php

Doc Comments +19 added lines, -4 removed lines

@@ -59,6 +59,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -71,6 +75,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -81,6 +88,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -93,7 +103,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -108,7 +118,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -243,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -268,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -306,7 +318,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;
@@ -324,7 +336,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) {
@@ -334,6 +346,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

@@ -85,7 +85,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -249,7 +249,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 +3 added lines, -2 removed lines

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

forms/FormScaffolder.php

Doc Comments -1 removed lines

@@ -49,7 +49,6 @@
 
 	/**
 	 * @param DataObject $obj
-	 * @param array $params
 	 */
 	public function __construct($obj) {
 		$this->obj = $obj;

forms/gridfield/GridField.php

Doc Comments +4 added lines, -4 removed lines

@@ -199,7 +199,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -286,7 +286,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -571,7 +571,7 @@ 
 	 * @param int $index
 	 * @param DataObject $record
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected function newRowClasses($total, $index, $record) {
 		$classes = array('ss-gridfield-item');
@@ -596,7 +596,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return $this->FieldHolder($properties);

forms/gridfield/GridFieldAddExistingAutocompleter.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');

forms/gridfield/GridFieldComponent.php

Doc Comments +4 added lines, -1 removed lines

@@ -33,6 +33,7 @@ 
 	 * If you attempt to return HTML for a fragment that doesn't exist, an
 	 * exception will be thrown when the {@link GridField} is rendered.
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 */
 	public function getHTMLFragments($gridField);
@@ -57,6 +58,7 @@ 
 	 * @param GridField $gridField
 	 * @param arary $columns List of columns
 	 * @param array - List reference of all column names.
+	 * @return void
 	 */
 	public function augmentColumns($gridField, &$columns);
 
@@ -139,6 +141,7 @@ 
 	 * @param String Action identifier, see {@link getActions()}.
 	 * @param Array Arguments relevant for this
 	 * @param Array All form data
+	 * @param string $actionName
 	 */
 	public function handleAction(GridField $gridField, $actionName, $arguments, $data);
 }
@@ -189,6 +192,7 @@ 
 	 *
 	 * Handler methods will be called on the component, rather than the
 	 * {@link GridField}.
+	 * @param GridField $gridField
 	 */
 	public function getURLHandlers($gridField);
 }
@@ -205,7 +209,6 @@ 
 	/**
 	 * Called when a grid field is saved - i.e. the form is submitted.
 	 *
-	 * @param GridField $field
 	 * @param DataObjectInterface $record
 	 */
 	public function handleSave(GridField $grid, DataObjectInterface $record);

forms/gridfield/GridFieldConfig.php

Doc Comments +2 added lines

@@ -78,6 +78,7 @@ 
 
 	/**
 	 * @param String Class name or interface
+	 * @param string $type
 	 * @return GridFieldConfig $this
 	 */
 	public function removeComponentsByType($type) {
@@ -116,6 +117,7 @@ 
 	 * Returns the first available component with the given class or interface.
 	 *
 	 * @param String ClassName
+	 * @param string $type
 	 * @return GridFieldComponent
 	 */
 	public function getComponentByType($type) {

forms/gridfield/GridFieldDataColumns.php

Doc Comments +2 added lines, -1 removed lines

@@ -70,6 +70,7 @@ 
 	/**
 	 * Get the DisplayFields
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 * @see GridFieldDataColumns::setDisplayFields
 	 */
@@ -174,7 +175,7 @@ 
 	 * e.g. to set a title for a search column header.
 	 *
 	 * @param GridField $gridField
-	 * @param string $columnName
+	 * @param string $column
 	 * @return array - Map of arbitrary metadata identifiers to their values.
 	 */
 	public function getColumnMetadata($gridField, $column) {