silverstripe / silverstripe-framework

admin/code/ModelAdmin.php

Doc Comments +4 added lines

@@ -113,6 +113,9 @@ 
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/javascript/dist/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);
@@ -255,6 +258,7 @@ 
 
 	/**
 	 * Unsanitise a model class' name from a URL param
+	 * @param string $class
 	 * @return string
 	 */
 	protected function unsanitiseClassName($class) {

core/Extensible.php

Doc Comments +1 added lines, -1 removed lines

@@ -369,7 +369,7 @@
 	 *
 	 * @param string $method the method name to call
 	 * @param mixed $a1
-	 * @param mixed $a2
+	 * @param string $a2
 	 * @param mixed $a3
 	 * @param mixed $a4
 	 * @param mixed $a5

dev/SapphireTest.php

Doc Comments +8 added lines, -6 removed lines

@@ -135,6 +135,7 @@ 
 
 	/**
 	 * Set the manifest to be used to look up test classes by helper functions
+	 * @param SS_ClassManifest $manifest
 	 */
 	public static function set_test_class_manifest($manifest) {
 		self::$test_class_manifest = $manifest;
@@ -418,7 +419,7 @@ 
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
 	 *
 	 * @param string $className
-	 * @return array A map of fixture-identifier => object-id
+	 * @return A A map of fixture-identifier => object-id
 	 */
 	protected function allFixtureIDs($className) {
 		return $this->getFixtureFactory()->getIds($className);
@@ -578,7 +579,7 @@ 
 	/**
 	 * Assert that the matching email was sent since the last call to clearEmails()
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-	 * @param $to
+	 * @param string $to
 	 * @param $from
 	 * @param $subject
 	 * @param $content
@@ -742,7 +743,7 @@ 
 	 * @param string $expectedSQL
 	 * @param string $actualSQL
 	 * @param string $message
-	 * @param float $delta
+	 * @param integer $delta
 	 * @param integer $maxDepth
 	 * @param boolean $canonicalize
 	 * @param boolean $ignoreCase
@@ -971,6 +972,7 @@ 
 	/**
 	 * Create a member and group with the given permission code, and log in with it.
 	 * Returns the member ID.
+	 * @return integer
 	 */
 	public function logInWithPermission($permCode = "ADMIN") {
 		if(!isset($this->cache_generatedMembers[$permCode])) {
@@ -1010,9 +1012,9 @@ 
 	/**
 	 * Test against a theme.
 	 *
-	 * @param $themeBaseDir string - themes directory
-	 * @param $theme string - theme name
-	 * @param $callback Closure
+	 * @param string $themeBaseDir string - themes directory
+	 * @param string $theme string - theme name
+	 * @param Closure $callback Closure
 	 */
 	protected function useTestTheme($themeBaseDir, $theme, $callback) {
 		Config::nest();

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

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`.
 	 */

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