silverstripe / silverstripe-framework

src/ORM/DataList.php

Doc Comments +11 added lines, -11 removed lines

@@ -179,7 +179,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)
@@ -556,7 +556,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)
     {
@@ -669,7 +669,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 static
      */
     public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -688,7 +688,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 static
      */
     public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -815,7 +815,7 @@ 
      * Returns an Iterator for this DataList.
      * This function allows you to use DataLists in foreach loops
      *
-     * @return Generator
+     * @return \Generator
      */
     public function getIterator()
     {
@@ -838,7 +838,7 @@ 
      * Return the maximum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function max($fieldName)
     {
@@ -849,7 +849,7 @@ 
      * Return the minimum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function min($fieldName)
     {
@@ -860,7 +860,7 @@ 
      * Return the average value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function avg($fieldName)
     {
@@ -871,7 +871,7 @@ 
      * Return the sum of the values of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function sum($fieldName)
     {
@@ -930,7 +930,7 @@ 
     /**
      * Restrict the columns to fetch into this DataList
      *
-     * @param array $queriedColumns
+     * @param string[] $queriedColumns
      * @return static
      */
     public function setQueriedColumns($queriedColumns)
@@ -1176,7 +1176,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $key
+     * @param integer $key
      * @return DataObject
      */
     public function offsetGet($key)

src/ORM/ArrayList.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
      * Returns an Iterator for this ArrayList.
      * This function allows you to use ArrayList in foreach loops
      *
-     * @return ArrayIterator
+     * @return \Generator
      */
     public function getIterator()
     {
@@ -746,7 +746,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $offset
+     * @param integer $offset
      * @return DataObject
      */
     public function offsetGet($offset)

src/ORM/Map.php

Doc Comments +5 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
      * Set the key field for this map.
      *
      * @var string $keyField
+     * @param string $keyField
      */
     public function setKeyField($keyField)
     {
@@ -56,6 +57,7 @@ 
      * Set the value field for this map.
      *
      * @var string $valueField
+     * @param string $valueField
      */
     public function setValueField($valueField)
     {
@@ -105,6 +107,7 @@ 
      *
      * @var string $key
      * @var mixed $value
+     * @param string $value
      * @return $this
      */
     public function unshift($key, $value)
@@ -126,6 +129,7 @@ 
      *
      * @var string $key
      * @var mixed $value
+     * @param string $value
      * @return $this
      */
     public function push($key, $value)
@@ -255,7 +259,7 @@ 
      *
      * Satisfies the IteratorAggreagte interface.
      *
-     * @return Map_Iterator
+     * @return \Generator
      */
     public function getIterator()
     {

admin/code/CMSMenu.php

Doc Comments +3 added lines, -3 removed lines

@@ -117,7 +117,7 @@ 
      * @param array $attributes an array of attributes to include on the link.
      * @param string $iconClass
      *
-     * @return boolean The result of the operation.
+     * @return boolean|null The result of the operation.
      */
     public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null, $iconClass = null)
     {
@@ -140,7 +140,7 @@ 
      * @param array $attributes an array of attributes to include on the link.
      * @param string $iconClass
      *
-     * @return bool Success
+     * @return boolean|null Success
      */
     public static function add_menu_item(
         $code,
@@ -322,7 +322,7 @@ 
      * @param array $attributes an array of attributes to include on the link.
      * @param string $iconClass
      *
-     * @return bool Success
+     * @return boolean|null Success
      */
     public static function replace_menu_item(
         $code,

admin/code/LeftAndMain.php

Doc Comments +4 added lines, -4 removed lines

@@ -264,7 +264,7 @@ 
     /**
      * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
      *
-     * @return array
+     * @return string
      *
      * WARNING: Experimental API
      */
@@ -691,7 +691,7 @@ 
      *
      * @param string $url
      * @param int $code
-     * @return HTTPResponse|string
+     * @return string|null
      */
     public function redirect($url, $code = 302)
     {
@@ -1006,7 +1006,7 @@ 
      * {@link SSViewer::get_templates_by_class()}
      *
      * @param string $suffix
-     * @return array
+     * @return string
      */
     public function getTemplatesWithSuffix($suffix)
     {
@@ -2159,7 +2159,7 @@ 
     }
 
     /**
-     * @return String
+     * @return DBField
      */
     public function Locale()
     {

src/Assets/Flysystem/AssetAdapter.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         ]
     );
 
+    /**
+     * @param string $root
+     */
     public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS)
     {
         // Get root path, and ensure that this exists and is safe