silverstripe / silverstripe-framework

src/ORM/DataObject.php

Doc Comments +9 added lines, -8 removed lines

@@ -2165,7 +2165,7 @@ 
      * Called by {@link __get()} and any getFieldName() methods you might create.
      *
      * @param string $field The name of the field
-     * @return mixed The field value
+     * @return string|null The field value
      */
     public function getField($field)
     {
@@ -2447,6 +2447,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2552,7 +2553,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param Member|null $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2575,7 +2576,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2588,7 +2589,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2601,7 +2602,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2616,7 +2617,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())
     {
@@ -2731,7 +2732,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)
@@ -2809,7 +2810,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/Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -49,6 +49,9 @@ 
         return parent::login($request, Authenticator::CMS_LOGIN);
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         /** @skipUpgrade */
@@ -79,6 +82,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $title
+     */
     public function getResponseController($title)
     {
         // Use $this to prevent use of Page to render underlying templates

src/Security/Security.php

Doc Comments +3 added lines, -2 removed lines

@@ -601,7 +601,7 @@ 
      * Combine the given forms into a formset with a tabbed interface
      *
      * @param $forms
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     protected function generateLoginFormSet($forms)
     {
@@ -1241,6 +1241,7 @@ 
 
     /**
      * For the database_is_ready call to return a certain value - used for testing
+     * @param boolean $isReady
      */
     public static function force_database_is_ready($isReady)
     {
@@ -1284,7 +1285,7 @@ 
     /**
      * Set to true to ignore access to disallowed actions, rather than returning permission failure
      * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-     * @param $flag True or false
+     * @param boolean $flag True or false
      */
     public static function set_ignore_disallowed_actions($flag)
     {

src/Dev/FunctionalTest.php

Doc Comments +5 added lines, -2 removed lines

@@ -230,7 +230,7 @@ 
      * Find an attribute in a SimpleXMLElement object by name.
      * @param SimpleXMLElement $object
      * @param string $attribute Name of attribute to find
-     * @return SimpleXMLElement object of the attribute
+     * @return boolean object of the attribute
      */
     public function findAttribute($object, $attribute)
     {
@@ -264,7 +264,7 @@ 
      * Note:   characters are stripped from the content; make sure that your assertions take this into account.
      *
      * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
-     * @param array|string $expectedMatches The content of at least one of the matched tags
+     * @param string[] $expectedMatches The content of at least one of the matched tags
      * @param string $message
      * @throws PHPUnit_Framework_AssertionFailedError
      */
@@ -424,6 +424,9 @@ 
         Security::setCurrentUser(null);
     }
 
+    /**
+     * @param DataObject|null $member
+     */
     public function logIn($member)
     {
         Security::setCurrentUser($member);

src/Security/MemberAuthenticator/LostPasswordHandler.php

Doc Comments +1 added lines

@@ -58,6 +58,7 @@
     /**
      * Return a link to this request handler.
      * The link returned is supplied in the constructor
+     * @param string $action
      * @return string
      */
     public function link($action = null)

src/Security/MemberAuthenticator/MemberAuthenticator.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
      * @param array $data Form submitted data
      * @param ValidationResult $result
      * @param Member|null This third parameter is used in the CMSAuthenticator(s)
+     * @param Member $member
      * @return Member Found member, regardless of successful login
      */
     protected function authenticateMember($data, &$result, $member = null)