silverstripe / 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|null
 	 */
 	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/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/InlineFormAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
 
 	/**
 	 * Create a new action button.
-	 * @param action The method to call when the button is clicked
+	 * @param action string method to call when the button is clicked
 	 * @param title The label on the button
 	 * @param extraClass A CSS class to apply to the button in addition to 'action'
 	 */
@@ -32,7 +32,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		if($this->includeDefaultJS) {
@@ -78,7 +78,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',

model/fieldtypes/Datetime.php

Doc Comments +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
 	 * Return a date and time formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A time and date pair formatted as per user-defined settings.
+	 * @return false|string | string A time and date pair formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

security/PermissionCheckboxSetField.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/CheckboxSetField.css');

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -338,7 +338,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -412,6 +411,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -753,7 +756,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1083,7 +1086,7 @@ 
 	 * @param array|null $arguments - arguments to an included template
 	 * @param Object $inheritedScope - the current scope of a parent template including a sub-template
 	 *
-	 * @return HTMLText Parsed template output.
+	 * @return DBField Parsed template output.
 	 */
 	public function process($item, $arguments = null, $inheritedScope = null) {
 		SSViewer::$topLevel[] = $item;
@@ -1158,7 +1161,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBField Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1184,6 +1187,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1212,7 +1218,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1253,6 +1259,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

view/ViewableData.php

Doc Comments +5 added lines, -5 removed lines

@@ -192,8 +192,6 @@ 
 	/**
 	 * Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
 	 *
-	 * @param string $field
-	 * @param array $arguments
 	 * @param string $identifier an optional custom cache identifier
 	 * @return unknown
 	 */
@@ -254,7 +252,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -346,7 +344,7 @@ 
 	 *
 	 * @param string|array|SSViewer $template the template to render into
 	 * @param array $customFields fields to customise() the object with before rendering
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function renderWith($template, $customFields = null) {
 		if(!is_object($template)) {
@@ -506,6 +504,7 @@ 
 
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -513,6 +512,7 @@ 
 
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -520,6 +520,7 @@ 
 
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -530,7 +531,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {

forms/MoneyField.php

Doc Comments +9 added lines, -1 removed lines

@@ -36,6 +36,10 @@ 
 	 */
 	protected $fieldCurrency = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
@@ -46,7 +50,7 @@ 
 
 	/**
 	 * @param array
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',
@@ -139,6 +143,7 @@ 
 	/**
 	 * @todo Implement removal of readonly state with $bool=false
 	 * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
+	 * @param boolean $bool
 	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
@@ -179,6 +184,9 @@ 
 		return $this->allowedCurrencies;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function setLocale($locale) {
 		$this->_locale = $locale;
 		return $this;

model/fieldtypes/DBClassName.php

Doc Comments +3 added lines

@@ -186,6 +186,9 @@
 		return $classNames;
 	}
 
+	/**
+	 * @param \DBClassNameTest_ObjectSubClass $record
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		parent::setValue($value, $record, $markChanged);