silverstripe / silverstripe-framework

model/DataExtension.php

Doc Comments +6 added lines

@@ -7,6 +7,9 @@ 
 
 	protected static $fixture_file = 'MemberDatetimeOptionsetFieldTest.yml';
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createDateFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultDateFormat = Zend_Locale_Format::getDateFormat($member->Locale);
@@ -26,6 +29,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createTimeFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultTimeFormat = Zend_Locale_Format::getTimeFormat($member->Locale);

security/RememberLoginHash.php

Doc Comments +6 added lines, -2 removed lines

@@ -76,6 +76,9 @@ 
 		return $this->token;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	public function setToken($token) {
 		$this->token = $token;
 	}
@@ -92,7 +95,7 @@ 
 	/**
 	 * Creates a new random token and hashes it using the
 	 * member information
-	 * @param Member The logged in user
+	 * @param Member Member logged in user
 	 * @return string The hash to be stored in the database
 	 */
 	public function getNewHash(Member $member){
@@ -106,7 +109,7 @@ 
 	 * The device is assigned a globally unique device ID
 	 * The returned login hash stores the hashed token in the
 	 * database, for this device and this member
-	 * @param Member The logged in user
+	 * @param Member Member logged in user
 	 * @return RememberLoginHash The generated login hash
 	 */
 	public static function generate(Member $member) {
@@ -149,6 +152,7 @@ 
 	 * Deletes existing tokens for this member
 	 * if logout_across_devices is true, all tokens are deleted, otherwise
 	 * only the token for the provided device ID will be removed
+	 * @param string $alcDevice
 	 */
 	public static function clear(Member $member, $alcDevice = null) {
 		if(!$member->exists()) { return; }

model/queries/SQLSelect.php

Doc Comments +2 added lines, -5 removed lines

@@ -61,7 +61,7 @@ 
 	/**
 	 * Construct a new SQLSelect.
 	 *
-	 * @param array|string $select An array of SELECT fields.
+	 * @param string $select An array of SELECT fields.
 	 * @param array|string $from An array of FROM clauses. The first one should be just the table name.
 	 * Each should be ANSI quoted.
 	 * @param array $where An array of WHERE clauses.
@@ -115,7 +115,6 @@ 
 	 * </code>
 	 *
 	 * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted.
-	 * @param boolean $clear Clear existing select fields?
 	 * @return $this Self reference
 	 */
 	public function setSelect($fields) {
@@ -352,7 +351,7 @@ 
 	 *
 	 * @param string $value
 	 * @param string $defaultDirection
-	 * @return array A two element array: array($column, $direction)
+	 * @return string[] A two element array: array($column, $direction)
 	 */
 	private function getDirectionFromString($value, $defaultDirection = null) {
 		if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) {
@@ -447,7 +446,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setHaving($having) {
@@ -462,7 +460,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addHaving($having) {

forms/Form.php

Doc Comments +12 added lines, -6 removed lines

@@ -498,7 +498,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) {
@@ -558,7 +558,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -697,6 +697,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;
@@ -836,6 +837,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -870,6 +872,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -1077,7 +1080,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) {
@@ -1592,7 +1595,7 @@ 
 	 * This is returned when you access a form as $FormObject rather
 	 * than <% with FormObject %>
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forTemplate() {
 		$return = $this->renderWith(array_merge(
@@ -1612,7 +1615,7 @@ 
 	 * It triggers slightly different behaviour, such as disabling the rewriting
 	 * of # links.
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forAjaxTemplate() {
 		$view = new SSViewer(array(
@@ -1635,7 +1638,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1896,6 +1899,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/ListboxField.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
 	 * Returns a <select> tag containing all the appropriate <option> tags
 	 *
 	 * @param array $properties
-	 * @return string
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(

forms/MoneyField.php

Doc Comments +6 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);

filesystem/File.php

Doc Comments +3 added lines, -3 removed lines

@@ -248,7 +248,7 @@ 
 	 *
 	 * @param array $args Array of input shortcode arguments
 	 * @param int $errorCode If the file is not found, or is inaccessible, this will be assigned to a HTTP error code.
-	 * @return File|null The File DataObject, if it can be found.
+	 * @return null|DataObject The File DataObject, if it can be found.
 	 */
 	public static function find_shortcode_record($args, &$errorCode = null) {
 		// Validate shortcode
@@ -617,7 +617,7 @@ 
 	 *
 	 * @param string $condition The PHP condition to be evaluated.  The page will be called $item
 	 * @param array $collator An array, passed by reference, to collect all of the matching descendants.
-	 * @return true|null
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {
@@ -978,6 +978,7 @@ 
 	 *
 	 * @param String File extension, without dot prefix. Use an asterisk ('*')
 	 * to specify a generic fallback if no mapping is found for an extension.
+	 * @param string $ext
 	 * @return String Classname for a subclass of {@link File}
 	 */
 	public static function get_class_for_file_extension($ext) {
@@ -1115,7 +1116,6 @@ 
 	 * Note that the result will not have a leading slash, and should not be used
 	 * with local file paths.
 	 *
-	 * @param string $part,... Parts
 	 * @return string
 	 */
 	public static function join_paths() {

view/ViewableData.php

Doc Comments +6 added lines, -4 removed lines

@@ -144,7 +144,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -247,7 +247,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');
@@ -339,7 +339,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)) {
@@ -499,6 +499,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));
@@ -506,6 +507,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));
@@ -513,6 +515,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));
@@ -523,7 +526,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/FormField.php

Doc Comments +4 added lines, -3 removed lines

@@ -587,6 +587,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -698,7 +699,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1179,6 +1179,7 @@ 
 	 * @todo Make this abstract.
 	 *
 	 * @param Validator
+	 * @param RequiredFields $validator
 	 *
 	 * @return bool
 	 */
@@ -1248,7 +1249,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;
@@ -1433,7 +1434,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`.