silverstripe / silverstripe-framework

model/DataQuery.php

Doc Comments +10 added lines, -3 removed lines

@@ -166,7 +166,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,10 +641,10 @@ 
 	 * 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
+	 * @return string model class of the related item
 	 */
 	public function applyRelation($relation, $linearOnly = false) {
 		// NO-OP
@@ -917,6 +917,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 +950,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -958,6 +962,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

thirdparty/Zend/Cache/Backend/File.php

Doc Comments +4 added lines

@@ -732,6 +732,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $mode
+     */
     protected function _get($dir, $mode, $tags = array())
     {
         if (!is_dir($dir)) {
@@ -819,6 +822,7 @@ 
     /**
      * Compute & return the expire time
      *
+     * @param integer $lifetime
      * @return int expire time (unix timestamp)
      */
     protected function _expireTime($lifetime)

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 HTMLText
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(

model/UnsavedRelationList.php

Doc Comments +2 added lines, -1 removed lines

@@ -52,6 +52,7 @@ 
 	 * Create a new UnsavedRelationList
 	 *
 	 * @param string $dataClass The DataObject class used in the relation
+	 * @param string $relationName
 	 */
 	public function __construct($baseClass, $relationName, $dataClass) {
 		$this->baseClass = $baseClass;
@@ -144,7 +145,7 @@ 
 	 * Add a number of items to the relation.
 	 *
 	 * @param array $items Items to add, as either DataObjects or IDs.
-	 * @return DataList
+	 * @return UnsavedRelationList
 	 */
 	public function addMany($items) {
 		foreach($items as $item) {

view/ArrayData.php

Doc Comments +3 added lines, -9 removed lines

@@ -50,14 +50,7 @@ 
 	/**
 	 * Gets a field from this object.
 	 *
-	 * @param string $field
-	 *
-	 * If the value is an object but not an instance of
-	 * ViewableData, it will be converted recursively to an
-	 * ArrayData.
-	 *
-	 * If the value is an associative array, it will likewise be
-	 * converted recursively to an ArrayData.
+	 * @param string $f
 	 */
 	public function getField($f) {
 		$value = $this->array[$f];
@@ -83,6 +76,7 @@ 
 	 * Check array to see if field isset
 	 *
 	 * @param string Field Key
+	 * @param string $f
 	 * @return bool
 	 */
 	public function hasField($f) {
@@ -93,7 +87,7 @@ 
 	 * Converts an associative array to a simple object
 	 *
 	 * @param array
-	 * @return obj $obj
+	 * @return stdClass $obj
 	 */
 	public static function array_to_object($arr = null) {
 		$obj = new stdClass();

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

@@ -37,6 +37,9 @@ 
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);
@@ -117,7 +120,7 @@ 
 	 * Render server configuration file from a template file
 	 *
 	 * @param string $template
-	 * @return \HTMLText Rendered results
+	 * @return string Rendered results
 	 */
 	protected function renderTemplate($template) {
 		// Build allowed extensions

filesystem/flysystem/ProtectedAssetAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      * Provide secure downloadable
      *
      * @param string $path
-     * @return string|null
+     * @return string
      */
     public function getProtectedUrl($path) {
         // Public URLs are handled via a request handler within /assets.

model/ValidationResult.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 	/**
 	 * Create a new ValidationResult.
 	 * By default, it is a successful result.	Call $this->error() to record errors.
+	 * @param string $message
 	 */
 	public function __construct($valid = true, $message = null) {
 		$this->isValid = $valid;

tests/filesystem/AssetStoreTest.php

Doc Comments +6 added lines

@@ -625,6 +625,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fileID
+	 */
 	public function getOriginalFilename($fileID) {
 		return parent::getOriginalFilename($fileID);
 	}
@@ -633,6 +636,9 @@ 
 		return parent::removeVariant($fileID);
 	}
 
+	/**
+	 * @param null|string $variant
+	 */
 	public function getDefaultConflictResolution($variant) {
 		return parent::getDefaultConflictResolution($variant);
 	}