silverstripe / silverstripe-framework

src/Security/Member.php

Doc Comments +4 added lines, -4 removed lines

@@ -749,7 +749,7 @@ 
      * });
      * </code>
      *
-     * @param Member|null|int $member Member or member ID to log in as.
+     * @param null|Member $member Member or member ID to log in as.
      * Set to null or 0 to act as a logged out user.
      * @param callable $callback
      */
@@ -1521,7 +1521,7 @@ 
      * This is likely to be customized for social sites etc. with a looser permission model.
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -1553,7 +1553,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1590,7 +1590,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/Security/RememberLoginHash.php

Doc Comments +6 added lines

@@ -84,11 +84,17 @@
      */
     private $token = null;
 
+    /**
+     * @return string
+     */
     public function getToken()
     {
         return $this->token;
     }
 
+    /**
+     * @param string $token
+     */
     public function setToken($token)
     {
         $this->token = $token;

src/Control/Email/Email.php

Doc Comments +13 added lines, -13 removed lines

@@ -201,12 +201,12 @@ 
 
     /**
      * Email constructor.
-     * @param string|array|null $from
-     * @param string|array|null $to
+     * @param string $from
+     * @param string $to
      * @param string|null $subject
      * @param string|null $body
-     * @param string|array|null $cc
-     * @param string|array|null $bcc
+     * @param string $cc
+     * @param string $bcc
      * @param string|null $returnPath
      */
     public function __construct(
@@ -292,7 +292,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -369,7 +369,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -401,7 +401,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -433,7 +433,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -450,7 +450,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -462,7 +462,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -568,7 +568,7 @@ 
     }
 
     /**
-     * @param string|array $name The data name to add or array to names => value
+     * @param string $name The data name to add or array to names => value
      * @param string|null $value The value of the data to add
      * @return $this
      */
@@ -739,7 +739,7 @@ 
     }
 
     /**
-     * @return array|bool
+     * @return boolean
      */
     public function sendPlain()
     {
@@ -795,7 +795,7 @@ 
     }
 
     /**
-     * @return Swift_MimePart|false
+     * @return \Swift_Mime_MimeEntity
      */
     public function findPlainPart()
     {

src/Core/Startup/ParameterConfirmationToken.php

Doc Comments +4 added lines, -1 removed lines

@@ -47,6 +47,9 @@ 
      */
     protected $token = null;
 
+    /**
+     * @param string $token
+     */
     protected function pathForToken($token)
     {
         return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token);
@@ -222,7 +225,7 @@ 
      * Given a list of token names, suppress all tokens that have not been validated, and
      * return the non-validated token with the highest priority
      *
-     * @param array $keys List of token keys in ascending priority (low to high)
+     * @param string[] $keys List of token keys in ascending priority (low to high)
      * @param HTTPRequest $request
      * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority
      */

src/Dev/BulkLoader.php

Doc Comments +4 added lines

@@ -141,6 +141,10 @@
 	 *
 	 * @return BulkLoader_Result See {@link self::processAll()}
 	 */
+
+    /**
+     * @param string $filepath
+     */
     public function load($filepath)
     {
         Environment::increaseTimeLimitTo(3600);

src/Dev/Install/Installer.php

Doc Comments +3 added lines

@@ -284,6 +284,9 @@
         return $this->errors;
     }
 
+    /**
+     * @param string $filename
+     */
     public function writeToFile($filename, $content)
     {
         $base = $this->getBaseDir();

src/Dev/SapphireTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -775,7 +775,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
@@ -1074,7 +1074,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/includes/functions.php

Doc Comments -6 removed lines

@@ -53,12 +53,6 @@
  * @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-delimeted 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.
  * @return string
  */
 function _t($entity, $arg = null)

src/ORM/DataObject.php

Doc Comments +8 added lines, -7 removed lines

@@ -2397,6 +2397,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2502,7 +2503,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param null|Member $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2525,7 +2526,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2538,7 +2539,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2551,7 +2552,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2566,7 +2567,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())
     {
@@ -2683,7 +2684,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)
@@ -2762,7 +2763,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.