silverstripe / silverstripe-framework

tests/view/ContentNegotiatorTest.php

Doc Comments +1 added lines

@@ -5,6 +5,7 @@
 	/**
 	 * Small helper to render templates from strings
 	 * Cloned from SSViewerTest
+	 * @param string $templateString
 	 */
 	private function render($templateString, $data = null) {
 		$t = SSViewer::fromString($templateString);

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

model/DataObject.php

Doc Comments +7 added lines, -3 removed lines

@@ -588,8 +588,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) {
@@ -987,6 +987,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) {
@@ -2272,6 +2273,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -3081,7 +3083,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) {
@@ -3360,6 +3362,7 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3367,6 +3370,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

model/HTMLValue.php

Doc Comments +2 added lines, -2 removed lines

@@ -152,8 +152,8 @@
 	/**
 	 * Make an xpath query against this HTML
 	 *
-	 * @param $query string - The xpath query string
-	 * @return DOMNodeList
+	 * @param string $query string - The xpath query string
+	 * @return \DOMNodeList
 	 */
 	public function query($query) {
 		$xp = new DOMXPath($this->getDocument());

model/ManyManyList.php

Doc Comments +2 added lines, -2 removed lines

@@ -115,7 +115,7 @@ 
 	 * Create a DataObject from the given SQL row.
 	 *
 	 * @param array $row
-	 * @return DataObject
+	 * @return SilverStripe\Model\DataObject
 	 */
 	protected function createDataObject($row) {
 		// remove any composed fields
@@ -265,7 +265,7 @@ 
 	 * Note that for a ManyManyList, the item is never actually deleted, only
 	 * the join table is affected.
 	 *
-	 * @param DataObject $item
+	 * @param SilverStripe\Model\DataObject $item
 	 */
 	public function remove($item) {
 		if(!($item instanceof $this->dataClass)) {