sminnee / silverstripe-framework

src/Dev/Deprecation.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace SilverStripe\Dev;
 
 use SilverStripe\Control\Director;
-use SilverStripe\Core\Manifest\ClassLoader;
 use SilverStripe\Core\Manifest\Module;
 use SilverStripe\Core\Manifest\ModuleLoader;
 

Doc Comments +3 added lines, -3 removed lines

@@ -77,9 +77,9 @@ 
      * greater than or equal to this version, a message will be raised
      *
      * @static
-     * @param $ver string -
+     * @param string $ver string -
      *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
-     * @param null $forModule string -
+     * @param string $forModule string -
      *    The name of a module. The passed version will be used as the check value for
      *    calls directly from this module rather than the global value
      * @return void
@@ -143,7 +143,7 @@ 
     /**
      * Determine if deprecation notices should be displayed
      *
-     * @return bool
+     * @return boolean|string
      */
     public static function get_enabled()
     {

src/Forms/HTMLEditor/HTMLEditorConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
      * Get the current value of an option
      *
      * @param string $key The key of the option to get
-     * @return mixed The value of the specified option
+     * @return string The value of the specified option
      */
     abstract public function getOption($key);
 

src/Forms/LiteralField.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 
     /**
      * @param string $name
-     * @param string|FormField $content
+     * @param string $content
      */
     public function __construct($name, $content)
     {

src/i18n/i18n.php

Doc Comments +1 added lines, -6 removed lines

@@ -141,12 +141,7 @@
      * @param string $entity Entity that identifies the string. It must be in the form
      * "Namespace.Entity" where Namespace will be usually the class name where this
      * string is used and Entity identifies the string inside the namespace.
-     * @param mixed $arg,... Additional arguments are parsed as such:
-     *  - Next string argument is a default. Pass in a `|` pipe-delimited value with `{count}`
-     *    to do pluralisation.
-     *  - Any other string argument after default is context for i18nTextCollector
-     *  - Any array argument in any order is an injection parameter list. Pass in a `count`
-     *    injection parameter to pluralise.
+     * @param string $arg
      * @return string
      */
     public static function _t($entity, $arg = null)

src/ORM/DataList.php

Doc Comments +9 added lines, -9 removed lines

@@ -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())
@@ -836,7 +836,7 @@ 
      * Return the maximum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function max($fieldName)
     {
@@ -847,7 +847,7 @@ 
      * Return the minimum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function min($fieldName)
     {
@@ -858,7 +858,7 @@ 
      * Return the average value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function avg($fieldName)
     {
@@ -869,7 +869,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)
     {
@@ -928,7 +928,7 @@ 
     /**
      * Restrict the columns to fetch into this DataList
      *
-     * @param array $queriedColumns
+     * @param string[] $queriedColumns
      * @return static
      */
     public function setQueriedColumns($queriedColumns)
@@ -1174,7 +1174,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $key
+     * @param integer $key
      * @return DataObject
      */
     public function offsetGet($key)

src/ORM/FieldType/DBDatetime.php

Doc Comments +2 added lines, -2 removed lines

@@ -85,7 +85,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 null|string | string A time and date pair formatted as per user-defined settings.
      */
     public function FormatFromSettings($member = null)
     {
@@ -190,7 +190,7 @@ 
      * Use {@link clear_mock_now()} to revert to the current system date.
      * Caution: This sets a fixed date that doesn't increment with time.
      *
-     * @param DBDatetime|string $datetime Either in object format, or as a DBDatetime compatible string.
+     * @param string $datetime Either in object format, or as a DBDatetime compatible string.
      * @throws Exception
      */
     public static function set_mock_now($datetime)

src/ORM/Filters/SearchFilter.php

Doc Comments +3 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
      *  column. Can contain a relation name in dot notation, which will automatically join
      *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
      *  search the "Name" column when applying this filter to a SiteTree class).
-     * @param mixed $value
+     * @param string $value
      * @param array $modifiers
      */
     public function __construct($fullName = null, $value = false, array $modifiers = array())
@@ -188,7 +188,7 @@ 
     /**
      * Gets supported modifiers for this filter
      *
-     * @return array
+     * @return string[]
      */
     public function getSupportedModifiers()
     {
@@ -428,7 +428,7 @@ 
     /**
      * Determines case sensitivity based on {@link getModifiers()}.
      *
-     * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+     * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
      */
     protected function getCaseSensitive()
     {

src/ORM/ManyManyThroughList.php

Doc Comments +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
     }
 
     /**
-     * @param mixed $item
+     * @param Tests\ManyManyThroughListTest\Item $item
      * @param array $extraFields
      */
     public function add($item, $extraFields = [])

src/Forms/TreeDropdownField.php

Doc Comments +2 added lines, -2 removed lines

@@ -313,7 +313,7 @@ 
 
     /**
      * @param array $properties
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function Field($properties = array())
     {
@@ -479,7 +479,7 @@ 
 
     /**
      * Marking a specific node in the tree as disabled
-     * @param $node
+     * @param DataObject $node
      * @return boolean
      */
     public function nodeIsDisabled($node)