silverstripe / silverstripe-framework

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/DataObjectSchema.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
     /**
      * Get location of all editor.css files
      *
-     * @return array
+     * @return string[]
      */
     protected function getEditorCSS() {
         $editor = array();

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/DBDate.php

Doc Comments +4 added lines, -1 removed lines

@@ -36,6 +36,9 @@ 
      */
     private static $nice_format = 'd/m/Y';
 
+    /**
+     * @param string|null $value
+     */
     public function setValue($value, $record = null, $markChanged = true)
     {
         if ($value === false || $value === null || (is_string($value) && !strlen($value))) {
@@ -205,7 +208,7 @@ 
      * Return a date formatted as per a CMS user's settings.
      *
      * @param Member $member
-     * @return boolean | string A date formatted as per user-defined settings.
+     * @return false|string | string A date formatted as per user-defined settings.
      */
     public function FormatFromSettings($member = null)
     {

src/ORM/FieldType/DBDatetime.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
      * Return a date and time formatted as per a CMS user's settings.
      *
      * @param Member $member
-     * @return boolean | string A time and date pair formatted as per user-defined settings.
+     * @return false|string | string A time and date pair formatted as per user-defined settings.
      */
     public function FormatFromSettings($member = 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()
     {