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

model/DataObject.php

Doc Comments +10 added lines, -5 removed lines

@@ -545,8 +545,8 @@ 
 
 	/**
 	 * Helper function to duplicate relations from one object to another
-	 * @param $sourceObject the source object to duplicate from
-	 * @param $destinationObject the destination object to populate with the duplicated relations
+	 * @param DataObject $sourceObject the source object to duplicate from
+	 * @param DataObject $destinationObject the destination object to populate with the duplicated relations
 	 * @param $name the name of the relation to duplicate (e.g. members)
 	 */
 	private function duplicateRelations($sourceObject, $destinationObject, $name) {
@@ -926,6 +926,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -1613,7 +1614,7 @@ 
 	/**
 	 * Find the foreign class of a relation on this DataObject, regardless of the relation type.
 	 *
-	 * @param $relationName Relation name.
+	 * @param string $relationName Relation name.
 	 * @return string Class name, or null if not found.
 	 */
 	public function getRelationClass($relationName) {
@@ -2080,6 +2081,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2883,7 +2885,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -2952,7 +2954,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3151,6 +3153,8 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
+	 * @param string $value
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3158,6 +3162,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

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 HTMLText
 	 */
 	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 HTMLText
 	 */
 	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/FormFieldSchemaTrait.php

Doc Comments +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
 	 * Sets the component type the FormField will be rendered as on the front-end.
 	 *
 	 * @param string $componentType
-	 * @return FormField
+	 * @return FormFieldSchemaTrait
 	 */
 	public function setSchemaComponent($componentType) {
 		$this->schemaComponent = $componentType;
@@ -42,7 +42,7 @@ 
 	 * 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.
-	 * @return FormField
+	 * @return FormFieldSchemaTrait
 	 *
 	 * @todo Add deep merging of arrays like `data` and `attributes`.
 	 */
@@ -96,8 +96,8 @@ 
 	 * 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.
-	 * @return FormField
+	 * @param array $schemaState - The data to be merged with $this->schemaData.
+	 * @return FormFieldSchemaTrait
 	 *
 	 * @todo Add deep merging of arrays like `data` and `attributes`.
 	 */

filesystem/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -589,7 +589,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()) {
@@ -950,6 +950,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) {
@@ -1087,7 +1088,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() {

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/DataQuery.php

Doc Comments +10 added lines, -2 removed lines

@@ -44,6 +44,7 @@ 
 	 * Create a new DataQuery.
 	 *
 	 * @param String The name of the DataObject class that you wish to query
+	 * @param string $dataClass
 	 */
 	public function __construct($dataClass) {
 		$this->dataClass = $dataClass;
@@ -166,7 +167,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLSelect The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -641,7 +642,7 @@ 
 	 * mappings to the query object state. This has to be called
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
 	 *
-	 * @param String|array $relation The array/dot-syntax relation to follow
+	 * @param string $relation The array/dot-syntax relation to follow
 	 * @param bool $linearOnly Set to true to restrict to linear relations only. Set this
 	 * if this relation will be used for sorting, and should not include duplicate rows.
 	 * @return The model class of the related item
@@ -917,6 +918,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -949,6 +951,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -958,6 +963,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

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

model/versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -953,7 +953,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1051,7 +1051,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param DataObject|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1161,7 +1161,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1236,7 +1236,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1306,7 +1306,7 @@ 
 	/**
 	 * Get the latest published DataObject.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2267,7 +2267,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasVersionedStages()) {