silverstripe / silverstripe-framework

src/ORM/DataExtension.php

Doc Comments +6 added lines

@@ -88,10 +88,16 @@
     {
     }
 
+    /**
+     * @param \SilverStripe\Security\Member|null $member
+     */
     public function canEdit($member)
     {
     }
 
+    /**
+     * @param \SilverStripe\Security\Member|null $member
+     */
     public function canDelete($member)
     {
     }

src/ORM/DataList.php

Doc Comments +10 added lines, -10 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)
@@ -554,7 +554,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)
     {
@@ -667,7 +667,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())
@@ -686,7 +686,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())
@@ -834,7 +834,7 @@ 
      * Return the maximum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function max($fieldName)
     {
@@ -845,7 +845,7 @@ 
      * Return the minimum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function min($fieldName)
     {
@@ -856,7 +856,7 @@ 
      * Return the average value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function avg($fieldName)
     {
@@ -867,7 +867,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)
     {
@@ -926,7 +926,7 @@ 
     /**
      * Restrict the columns to fetch into this DataList
      *
-     * @param array $queriedColumns
+     * @param string[] $queriedColumns
      * @return static
      */
     public function setQueriedColumns($queriedColumns)
@@ -1172,7 +1172,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $key
+     * @param integer $key
      * @return DataObject
      */
     public function offsetGet($key)

src/ORM/DataObject.php

Doc Comments +7 added lines, -6 removed lines

@@ -2470,6 +2470,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2638,7 +2639,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2651,7 +2652,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2664,7 +2665,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2679,7 +2680,7 @@ 
      * @param Member $member
      * @param array $context Additional context-specific data which might
      * affect whether (or where) this object could be created.
-     * @return boolean
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -2789,7 +2790,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)
@@ -2867,7 +2868,7 @@ 
      * @param string $callerClass The class of objects to be returned
      * @param string|array $filter A filter to be inserted into the WHERE clause.
      * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-     * @param string|array $sort A sort expression to be inserted into the ORDER
+     * @param string $sort A sort expression to be inserted into the ORDER
      * BY clause.  If omitted, self::$default_sort will be used.
      * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
      * @param string|array $limit A limit expression to be inserted into the LIMIT clause.

src/ORM/DataQuery.php

Doc Comments +2 added lines, -2 removed lines

@@ -110,7 +110,7 @@ 
     /**
      * Remove a filter from the query
      *
-     * @param string|array $fieldExpression The predicate of the condition to remove
+     * @param string|null $fieldExpression The predicate of the condition to remove
      * (ignoring parameters). The expression will be considered a match if it's
      * contained within any other predicate.
      * @return DataQuery Self reference
@@ -191,7 +191,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)

src/ORM/FieldType/DBClassName.php

Doc Comments +3 added lines

@@ -171,6 +171,9 @@
         return $classNames;
     }
 
+    /**
+     * @param \SilverStripe\ORM\Tests\DBClassNameTest\ObjectSubClass $record
+     */
     public function setValue($value, $record = null, $markChanged = true)
     {
         parent::setValue($value, $record, $markChanged);

src/ORM/FieldType/DBComposite.php

Doc Comments +3 added lines

@@ -220,6 +220,9 @@
         return null;
     }
 
+    /**
+     * @param string $field
+     */
     public function hasField($field)
     {
         $fields = $this->compositeDatabaseFields();

src/ORM/FieldType/DBCurrency.php

Doc Comments +6 added lines

@@ -24,6 +24,9 @@ 
      */
     private static $currency_symbol = '$';
 
+    /**
+     * @param string $name
+     */
     public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0)
     {
         parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
@@ -56,6 +59,9 @@ 
         }
     }
 
+    /**
+     * @param string $value
+     */
     public function setValue($value, $record = null, $markChanged = true)
     {
         $matches = null;

src/ORM/FieldType/DBDecimal.php

Doc Comments +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
      * @param string $name
      * @param int $wholeSize
      * @param int $decimalSize
-     * @param float|int $defaultValue
+     * @param integer $defaultValue
      */
     public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0)
     {
@@ -33,7 +33,7 @@ 
     }
 
     /**
-     * @return float
+     * @return string
      */
     public function Nice()
     {
@@ -41,7 +41,7 @@ 
     }
 
     /**
-     * @return int
+     * @return double
      */
     public function Int()
     {
@@ -88,7 +88,7 @@ 
     }
 
     /**
-     * @return float
+     * @return integer
      */
     public function nullValue()
     {

src/ORM/FieldType/DBField.php

Doc Comments +1 added lines, -1 removed lines

@@ -529,7 +529,7 @@
     }
 
     /**
-     * @param array $value
+     * @param string $value
      * @return $this
      */
     public function setArrayValue($value)