silverstripe / silverstripe-framework

control/RequestHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -240,6 +240,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -273,7 +276,7 @@ 
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */
@@ -386,6 +389,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);
@@ -495,6 +499,7 @@ 
 	 * or {@link handleRequest()}, but in some based we want to set it manually.
 	 *
 	 * @param SS_HTTPRequest
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$this->request = $request;

forms/FormField.php

Doc Comments +3 added lines, -2 removed lines

@@ -633,6 +633,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -744,7 +745,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1225,6 +1225,7 @@ 
 	 * @todo Make this abstract.
 	 *
 	 * @param Validator
+	 * @param RequiredFields $validator
 	 *
 	 * @return bool
 	 */
@@ -1479,7 +1480,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`.

forms/HtmlEditorSanitiser.php

Doc Comments +3 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -182,6 +182,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {
@@ -245,7 +246,7 @@ 
 	 * Given an SS_HTMLValue instance, will remove and elements and attributes that are
 	 * not explicitly included in the whitelist passed to __construct on instance creation
 	 *
-	 * @param SS_HTMLValue $html - The HTMLValue to remove any non-whitelisted elements & attributes from
+	 * @param HTMLValue $html - The HTMLValue to remove any non-whitelisted elements & attributes from
 	 */
 	public function sanitise (HTMLValue $html) {
 		if(!$this->elements && !$this->elementPatterns) return;

model/ArrayList.php

Doc Comments +4 added lines, -4 removed lines

@@ -466,6 +466,7 @@ 
 	 * Returns true if the given column can be used to filter the records.
 	 *
 	 * It works by checking the fields available in the first record of the list.
+	 * @param string $by
 	 */
 	public function canFilterBy($by) {
 		$firstRecord = $this->first();
@@ -596,6 +597,9 @@ 
 		return $this->filter('ID', $ids);
 	}
 
+	/**
+	 * @param integer $id
+	 */
 	public function byID($id) {
 		$firstElement = $this->filter("ID", $id)->first();
 
@@ -680,7 +684,6 @@ 
 	/**
 	 * Returns whether an item with $key exists
 	 *
-	 * @param mixed $key
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
@@ -690,7 +693,6 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {
@@ -700,7 +702,6 @@ 
 	/**
 	 * Set an item with the key in $key
 	 *
-	 * @param mixed $key
 	 * @param mixed $value
 	 */
 	public function offsetSet($offset, $value) {
@@ -714,7 +715,6 @@ 
 	/**
 	 * Unset an item with the key in $key
 	 *
-	 * @param mixed $key
 	 */
 	public function offsetUnset($offset) {
 		unset($this->items[$offset]);

model/connect/Database.php

Doc Comments +2 added lines, -2 removed lines

@@ -694,7 +694,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -729,7 +729,7 @@ 
 	/**
 	 * Returns the name of the currently selected database
 	 *
-	 * @return string|null Name of the selected database, or null if none selected
+	 * @return string Name of the selected database, or null if none selected
 	 */
 	public function getSelectedDatabase() {
 		return $this->connector->getSelectedDatabase();

model/connect/DBSchemaManager.php

Doc Comments +2 added lines, -3 removed lines

@@ -46,7 +46,6 @@ 
 	/**
 	 * Injector injection point for database controller
 	 *
-	 * @param SS_Database $connector
 	 */
 	public function setDatabase(SS_Database $database) {
 		$this->database = $database;
@@ -483,7 +482,7 @@ 
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {
@@ -551,7 +550,7 @@ 
 	/**
 	 * Returns true if the given table is exists in the current database
 	 *
-	 * @param string $table Name of table to check
+	 * @param string $tableName Name of table to check
 	 * @return boolean Flag indicating existence of table
 	 */
 	abstract public function hasTable($tableName);

model/connect/PDOConnector.php

Doc Comments +1 added lines, -1 removed lines

@@ -324,7 +324,7 @@
 	 * @param int $errorLevel
 	 * @param string $sql
 	 * @param array $parameters
-	 * @return \PDOQuery
+	 * @return PDOQuery|null
 	 */
 	protected function prepareResults($statement, $errorLevel, $sql, $parameters = array()) {
 

model/DataExtension.php

Doc Comments +6 added lines

@@ -79,9 +79,15 @@
 	public function can($member) {
 	}
 
+	/**
+	 * @param \Member $member
+	 */
 	public function canEdit($member) {
 	}
 
+	/**
+	 * @param \Member $member
+	 */
 	public function canDelete($member) {
 	}
 

model/DataList.php

Doc Comments +6 added lines, -6 removed lines

@@ -172,7 +172,7 @@ 
 	 * Returns a new DataList instance with the specified query parameter assigned
 	 *
 	 * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
-	 * @param mixed $val If $keyOrArray is not an array, this is the value to set
+	 * @param string $val If $keyOrArray is not an array, this is the value to set
 	 * @return static
 	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
@@ -535,7 +535,7 @@ 
 	 * Check if the given field specification could be interpreted as an unquoted relation name
 	 *
 	 * @param string $field
-	 * @return bool
+	 * @return integer
 	 */
 	protected function isValidRelationName($field) {
 		return preg_match('/^[A-Z0-9._]+$/i', $field);
@@ -650,7 +650,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -668,7 +668,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -884,7 +884,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1159,7 +1159,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {