silverstripe / silverstripe-framework

forms/MemberDatetimeOptionsetField.php

Doc Comments +3 added lines

@@ -105,6 +105,9 @@
 		return $this->descriptionTemplate;
 	}
 
+	/**
+	 * @param string $template
+	 */
 	public function setDescriptionTemplate($template) {
 		$this->descriptionTemplate = $template;
 	}

ORM/ArrayList.php

Doc Comments +2 added lines, -6 removed lines

@@ -379,7 +379,7 @@ 
 	 *
 	 * Note that columns may be double quoted as per ANSI sql standard
 	 *
-	 * @return DataList
+	 * @return ArrayList
 	 * @see SS_List::sort()
 	 * @example $list->sort('Name'); // default ASC sorting
 	 * @example $list->sort('Name DESC'); // DESC sorting
@@ -515,7 +515,7 @@ 
 	 *          $list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
 	 *
 	 * @param string|array See {@link filter()}
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function filterAny() {
 		$keepUs = call_user_func_array(array($this, 'normaliseFilterArgs'), func_get_args());
@@ -666,7 +666,6 @@ 
 	/**
 	 * Returns whether an item with $key exists
 	 *
-	 * @param mixed $key
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
@@ -676,7 +675,6 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {
@@ -686,7 +684,6 @@ 
 	/**
 	 * Set an item with the key in $key
 	 *
-	 * @param mixed $key
 	 * @param mixed $value
 	 */
 	public function offsetSet($offset, $value) {
@@ -700,7 +697,6 @@ 
 	/**
 	 * Unset an item with the key in $key
 	 *
-	 * @param mixed $key
 	 */
 	public function offsetUnset($offset) {
 		unset($this->items[$offset]);

tests/forms/RequirementsTest.php

Doc Comments +9 added lines

@@ -118,6 +118,11 @@ 
 		);
 	}
 	
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param boolean $async
+	 * @param boolean $defer
+	 */
 	protected function setupCombinedRequirementsJavascriptAsyncDefer($backend, $async, $defer) {
         $basePath = $this->getCurrentRelativePath();
         $this->setupRequirements($backend);
@@ -805,6 +810,10 @@ 
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$includedFiles = $this->getBackendFiles($backend, $type);
 		if(is_array($files)) {

forms/gridfield/GridField.php

Doc Comments +2 added lines, -2 removed lines

@@ -193,7 +193,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList
+	 * @return SilverStripe\ORM\ArrayList
 	 */
 	public function getComponents() {
 		return $this->config->getComponents();
@@ -204,7 +204,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed

filesystem/ImagickBackend.php

Doc Comments +3 added lines, -3 removed lines

@@ -156,7 +156,7 @@ 
 	 * @param int $width
 	 * @param int $height
 	 * @param int $transparencyPercent
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function paddedResize($width, $height, $backgroundColor = "FFFFFF", $transparencyPercent = 0) {
 		if(!$this->valid()) {
@@ -182,7 +182,7 @@ 
 	/**
 	 * Convert a percentage (or 'true') to a two char hex code to signifiy the level of an alpha channel
 	 *
-	 * @param $percent
+	 * @param integer $percent
 	 * @return string
 	 */
 	public function calculateAlphaHex($percent) {
@@ -203,7 +203,7 @@ 
 	 *
 	 * @param int $width
 	 * @param int $height
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function croppedResize($width, $height) {
 		if(!$this->valid()) {

forms/CurrencyField.php

Doc Comments +4 added lines

@@ -14,6 +14,7 @@ 
 	/**
 	 * allows the value to be set. removes the first character
 	 * if it is not a number (probably a currency symbol)
+	 * @param string $val
 	 */
 	public function setValue($val) {
 		if(!$val) $val = 0.00;
@@ -43,6 +44,9 @@ 
 		return $this->castedCopy('CurrencyField_Readonly');
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
         $currencySymbol = preg_quote(Config::inst()->get('SilverStripe\\ORM\\FieldType\\DBCurrency', 'currency_symbol'));
         $regex = '/^\s*(\-?'.$currencySymbol.'?|'.$currencySymbol.'\-?)?(\d{1,3}(\,\d{3})*|(\d+))(\.\d{2})?\s*$/';

forms/OptionsetField.php

Doc Comments +1 added lines

@@ -126,6 +126,7 @@
 
 	/**
 	 * {@inheritdoc}
+	 * @param RequiredFields $validator
 	 */
 	public function validate($validator) {
 		if (!$this->Value()) {

parsers/SQLFormatter.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
 		'LIMIT',
 	);
 
+	/**
+	 * @param string $sql
+	 */
 	public function formatPlain($sql) {
 		$sql = $this->addNewlines($sql, false);
 

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);