silverstripe / silverstripe-framework

tests/php/Security/SecurityTest.php

Doc Comments +4 added lines

@@ -676,6 +676,8 @@ 
     /**
      * Execute a log-in form using Director::test().
      * Helper method for the tests above
+     * @param string $email
+     * @param string $password
      */
     public function doTestLoginForm($email, $password, $backURL = 'test/link')
     {
@@ -697,6 +699,8 @@ 
 
     /**
      * Helper method to execute a change password form
+     * @param string $oldPassword
+     * @param string $newPassword
      */
     public function doTestChangepasswordForm($oldPassword, $newPassword)
     {

tests/php/View/SSViewerCacheBlockTest/VersionedModel.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
         Versioned::class
     );
 
+    /**
+     * @param string $entropy
+     */
     public function setEntropy($entropy)
     {
         $this->entropy = $entropy;

tests/php/View/SSViewerTest.php

Doc Comments +13 added lines

@@ -173,6 +173,10 @@ 
         );
     }
 
+    /**
+     * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
+     * @param string[] $expected
+     */
     private function assertExpectedStrings($result, $expected)
     {
         foreach ($expected as $expectedStr) {
@@ -1088,6 +1092,10 @@ 
         $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
     }
 
+    /**
+     * @param string $a
+     * @param string $b
+     */
     public function assertEqualIgnoringWhitespace($a, $b, $message = '')
     {
         $this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b), $message);
@@ -1819,6 +1827,11 @@ 
             $this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $expected
+     */
     private function _renderWithSourceFileComments($name, $expected)
     {
         $viewer = new SSViewer(array($name));

src/Control/Email/Email.php

Doc Comments +14 added lines, -14 removed lines

@@ -135,12 +135,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(
@@ -226,7 +226,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -238,7 +238,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string
      */
     public function getSender()
     {
@@ -303,7 +303,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -335,7 +335,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -367,7 +367,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -384,7 +384,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -396,7 +396,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -502,7 +502,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
      */
@@ -672,7 +672,7 @@ 
     }
 
     /**
-     * @return array|bool
+     * @return boolean
      */
     public function sendPlain()
     {
@@ -728,7 +728,7 @@ 
     }
 
     /**
-     * @return Swift_MimePart|false
+     * @return \Swift_Mime_MimeEntity
      */
     public function findPlainPart()
     {

src/Forms/GridField/GridFieldAddExistingAutocompleter.php

Doc Comments +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
     /**
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {
@@ -219,7 +219,7 @@ 
      *
      * @param GridField $gridField
      * @param HTTPRequest $request
-     * @return string
+     * @return HTTPResponse
      */
     public function doSearch($gridField, $request)
     {
@@ -299,7 +299,7 @@ 
     }
 
     /**
-     * @param array $fields
+     * @param string[] $fields
      * @return $this
      */
     public function setSearchFields($fields)

src/ORM/ListDecorator.php

Doc Comments +1 added lines

@@ -41,6 +41,7 @@
      * Useful for keeping a decorator/paginated list configuration intact while modifying
      * the underlying list.
      *
+     * @param SS_List $list
      * @return SS_List
      */
     public function setList($list)

src/View/SSViewer_DataPresenter.php

Doc Comments +7 added lines

@@ -33,6 +33,10 @@ 
      */
     protected $underlay;
 
+    /**
+     * @param ViewableData $item
+     * @param ViewableData $inheritedScope
+     */
     public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null)
     {
         parent::__construct($item, $inheritedScope);
@@ -65,6 +69,9 @@ 
         $this->underlay = $underlay ? $underlay : array();
     }
 
+    /**
+     * @param string $variableMethod
+     */
     protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false)
     {
         $implementers = ClassInfo::implementorsOf($interfaceToQuery);

thirdparty/php-peg/Parser.php

Doc Comments +28 added lines

@@ -9,6 +9,10 @@ 
  *  the bracket if a failed match + restore has moved the current position backwards - so we have to check that too.
  */
 class ParserRegexp {
+
+	/**
+	 * @param Parser $parser
+	 */
 	function __construct( $parser, $rx ) {
 		$this->parser = $parser ;
 		$this->rx = $rx . 'Sx' ;
@@ -83,6 +87,9 @@ 
 		return FALSE ;
 	}
 
+ 	/**
+ 	 * @param string $token
+ 	 */
  	function literal( $token ) {
  		/* Debugging: * / print( "Looking for token '$token' @ '" . substr( $this->string, $this->pos ) . "'\n" ) ; /* */
  		$toklen = strlen( $token ) ;
@@ -94,11 +101,17 @@ 
 		return FALSE ;
 	}
 
+	/**
+	 * @param string $rx
+	 */
 	function rx( $rx ) {
 		if ( !isset( $this->regexps[$rx] ) ) $this->regexps[$rx] = new ParserRegexp( $this, $rx ) ;
 		return $this->regexps[$rx]->match() ;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function expression( $result, $stack, $value ) {
 		$stack[] = $result; $rv = false;
 		
@@ -120,14 +133,26 @@ 
 		return is_array($rv) ? $rv['text'] : ($rv ? $rv : '');
 	}
 	
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packhas( $key, $pos ) {
 		return false ;
 	}
 
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packread( $key, $pos ) {
 		throw new \Exception('PackRead after PackHas=>false in Parser.php');
 	}
 
+	/**
+	 * @param string $key
+	 * @param integer $pos
+	 */
 	function packwrite( $key, $pos, $res ) {
 		return $res ;
 	}
@@ -164,6 +189,9 @@ 
 		return $result ;
 	}
 
+	/**
+	 * @param string $storetag
+	 */
 	function store ( &$result, $subres, $storetag = NULL ) {
 		$result['text'] .= $subres['text'] ;
 

src/Core/Core.php

Doc Comments +4 added lines, -7 removed lines

@@ -136,6 +136,9 @@ 
     return Injector::inst()->get($className);
 }
 
+/**
+ * @return string
+ */
 function project()
 {
     global $project;
@@ -152,12 +155,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)
@@ -171,7 +168,7 @@ 
  * Only increases up to the maximum defined in {@link set_increase_memory_limit_max()},
  * and defaults to the 'memory_limit' setting in the PHP configuration.
  *
- * @param string|int $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
+ * @param integer $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
  * @return Boolean TRUE indicates a successful change, FALSE a denied change.
  */
 function increase_memory_limit_to($memoryLimit = -1)