silverstripe / silverstripe-framework

model/versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1066,7 +1066,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1186,7 +1186,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1219,7 +1219,7 @@ 
 	 * If extended, ensure that both canDelete and canUnpublish are extended also
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function canArchive($member = null) {
 		// Skip if invoked by extendedCan()
@@ -1296,7 +1296,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1918,7 +1918,7 @@ 
 	/**
 	 * Determine if the current user is able to set the given site stage / archive
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param SilverStripe\Control\HTTPRequest $request
 	 * @return bool
 	 */
 	public static function can_choose_site_stage($request) {
@@ -2422,7 +2422,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

security/ChangePasswordForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 	/**
 	 * Constructor
 	 *
-	 * @param Controller $controller The parent controller, necessary to
+	 * @param Controller|null $controller The parent controller, necessary to
 	 *                               create the appropriate form action tag.
 	 * @param string $name The method on the controller that will return this
 	 *                     form object.

tests/filesystem/ProtectedFileControllerTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
 	 *
 	 * @param int $code HTTP code
 	 * @param string $body Body expected for 200 responses
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	protected function assertResponseEquals($code, $body, HTTPResponse $response) {
 		$this->assertEquals($code, $response->getStatusCode());

tests/forms/uploadfield/AssetFieldTest.php

Doc Comments +5 added lines, -3 removed lines

@@ -306,7 +306,6 @@ 
 	 * Simulates a form post to the test controller with the specified file tuple (Filename, Hash, Variant)
 	 *
 	 * @param string $fileField Name of field to assign ids to
-	 * @param array $ids list of file IDs
 	 * @return boolean Array with key 'errors'
 	 */
 	protected function mockUploadFileSave($fileField, $filename, $hash, $variant = null) {
@@ -336,8 +335,8 @@ 
 	 * Simulates a file upload
 	 *
 	 * @param string $fileField Name of the field to mock upload for
-	 * @param array $tmpFileName Name of temporary file to upload
-	 * @return SS_HTTPResponse form response
+	 * @param string $tmpFileName Name of temporary file to upload
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileUpload($fileField, $tmpFileName) {
 		$upload = $this->getUploadFile($tmpFileName);
@@ -368,6 +367,9 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param AssetFieldTest_Controller $controller
+	 */
 	function __construct($controller = null, $name = 'Form') {
 		if(empty($controller)) {
 			$controller = new AssetFieldTest_Controller();

tests/forms/uploadfield/UploadFieldTest.php

Doc Comments +11 added lines, -5 removed lines

@@ -916,8 +916,8 @@ 
 	 * Simulates a file upload
 	 *
 	 * @param string $fileField Name of the field to mock upload for
-	 * @param array $tmpFileName Name of temporary file to upload
-	 * @return SS_HTTPResponse form response
+	 * @param string $tmpFileName Name of temporary file to upload
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileUpload($fileField, $tmpFileName) {
 		$upload = $this->getUploadFile($tmpFileName);
@@ -928,6 +928,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $fileField
+	 */
 	protected function mockFileExists($fileField, $fileName) {
 		return $this->get(
 			"UploadFieldTest_Controller/Form/field/{$fileField}/fileexists?filename=".urlencode($fileName)
@@ -939,7 +942,7 @@ 
 	 *
 	 * @param string $fileField Name of the field
 	 * @param integer $fileID ID of the file to delete
-	 * @return SS_HTTPResponse form response
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileEditForm($fileField, $fileID) {
 		return $this->get(
@@ -953,7 +956,7 @@ 
 	 * @param string $fileField Name of the field
 	 * @param integer $fileID ID of the file to delete
 	 * @param array $fields Fields to update
-	 * @return SS_HTTPResponse form response
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileEdit($fileField, $fileID, $fields = array()) {
 		return $this->post(
@@ -967,7 +970,7 @@ 
 	 *
 	 * @param string $fileField Name of the field
 	 * @param integer $fileID ID of the file to delete
-	 * @return SS_HTTPResponse form response
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileDelete($fileField, $fileID) {
 		return $this->post(
@@ -1084,6 +1087,9 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param UploadFieldTest_Controller $controller
+	 */
 	function __construct($controller = null, $name = 'Form') {
 		if(empty($controller)) {
 			$controller = new UploadFieldTest_Controller();

tests/security/SecurityTest.php

Doc Comments +5 added lines, -1 removed lines

@@ -132,7 +132,7 @@ 
 	 *
 	 * @param string $url
 	 * @param int $limit Max number of requests
-	 * @return SS_HTTPResponse
+	 * @return SilverStripe\Control\SS_HTTPResponse|null
 	 */
 	protected function getRecursive($url, $limit = 10) {
 		$this->cssParser = null;
@@ -589,6 +589,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') {
 		$this->get(Config::inst()->get('Security', 'logout_url'));
@@ -609,6 +611,8 @@ 
 
 	/**
 	 * Helper method to execute a change password form
+	 * @param string $oldPassword
+	 * @param string $newPassword
 	 */
 	public function doTestChangepasswordForm($oldPassword, $newPassword) {
 		return $this->submitForm(

view/Requirements.php

Doc Comments +5 added lines, -3 removed lines

@@ -68,6 +68,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->setSuffixRequirements($var);
@@ -276,7 +277,7 @@ 
 	 * Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given
 	 * HTTP Response
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public static function include_in_response(HTTPResponse $response) {
 		self::backend()->includeInResponse($response);
@@ -339,7 +340,7 @@ 
 	 * </code>
 	 *
 	 * @param string $combinedFileName Filename of the combined file relative to docroot
-	 * @param array  $files            Array of filenames relative to docroot
+	 * @param string[]  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
 	 * @return bool|void
@@ -764,6 +765,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 * @return $this
 	 */
 	public function setForceJSToBottom($var) {
@@ -1263,7 +1265,7 @@ 
 	 * Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given
 	 * HTTP Response
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function includeInResponse(HTTPResponse $response) {
 		$this->processCombinedFiles();