silverstripe / silverstripe-framework

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/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/Control/HTTPRequest.php

Doc Comments +3 added lines, -3 removed lines

@@ -349,7 +349,7 @@ 
      * Remove an existing HTTP header
      *
      * @param string $header
-     * @return mixed
+     * @return string
      */
     public function getHeader($header)
     {
@@ -458,9 +458,9 @@ 
      * it's only advisable to send small files through this method.
      *
      * @static
-     * @param $fileData
+     * @param string $fileData
      * @param $fileName
-     * @param null $mimeType
+     * @param string $mimeType
      * @return HTTPResponse
      */
     public static function send_file($fileData, $fileName, $mimeType = null)

src/Forms/Form.php

Doc Comments +2 added lines, -1 removed lines

@@ -596,6 +596,7 @@ 
      * Set actions that are exempt from validation
      *
      * @param array
+     * @param string[] $actions
      * @return $this
      */
     public function setValidationExemptActions($actions)
@@ -1043,7 +1044,7 @@ 
      * If set to false (the default), then the form method is only used to construct the default
      * form.
      *
-     * @param $bool boolean
+     * @param boolean $bool boolean
      * @return $this
      */
     public function setStrictFormMethodCheck($bool)

src/Control/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -249,7 +249,7 @@ 
      *
      * @param string $url The URL to visit.
      * @param array $postVars The $_POST & $_FILES variables.
-     * @param array|Session $session The {@link Session} object representing the current session.
+     * @param Session|null $session The {@link Session} object representing the current session.
      * By passing the same object to multiple  calls of Director::test(), you can simulate a persisted
      * session.
      * @param string $httpMethod The HTTP method, such as GET or POST.  It will default to POST if
@@ -928,7 +928,7 @@ 
     /**
      * Returns true if the given file exists. Filename should be relative to the site root.
      *
-     * @param $file
+     * @param string $file
      *
      * @return bool
      */
@@ -1156,7 +1156,7 @@ 
      * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
      * {@link Director::isLive()}.
      *
-     * @return bool
+     * @return string
      */
     public static function get_environment_type()
     {

src/Dev/SapphireTest.php

Doc Comments +8 added lines, -5 removed lines

@@ -184,6 +184,9 @@ 
         return self::$is_running_test;
     }
 
+    /**
+     * @param boolean $bool
+     */
     public static function set_is_running_test($bool)
     {
         self::$is_running_test = $bool;
@@ -662,10 +665,10 @@ 
     /**
      * Assert that the matching email was sent since the last call to clearEmails()
      * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-     * @param $to
+     * @param string $to
      * @param $from
-     * @param $subject
-     * @param $content
+     * @param string $subject
+     * @param string $content
      * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
      *               'customHeaders', 'htmlContent', inlineImages'
      */
@@ -898,7 +901,7 @@ 
      * @param string $expectedSQL
      * @param string $actualSQL
      * @param string $message
-     * @param float|int $delta
+     * @param integer $delta
      * @param integer $maxDepth
      * @param boolean $canonicalize
      * @param boolean $ignoreCase
@@ -1186,7 +1189,7 @@ 
      * Create a member and group with the given permission code, and log in with it.
      * Returns the member ID.
      *
-     * @param string|array $permCode Either a permission, or list of permissions
+     * @param string $permCode Either a permission, or list of permissions
      * @return int Member ID
      */
     public function logInWithPermission($permCode = "ADMIN")

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)