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());

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();

admin/code/CampaignAdmin.php

Doc Comments +5 added lines, -5 removed lines

@@ -194,7 +194,7 @@ 
 	/**
 	 * REST endpoint to get a list of campaigns.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -335,7 +335,7 @@ 
 	/**
 	 * Gets viewable list of campaigns
 	 *
-	 * @return SS_List
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	protected function getListItems() {
 		return ChangeSet::get()
@@ -349,7 +349,7 @@ 
 	/**
 	 * REST endpoint to get a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -382,7 +382,7 @@ 
 	/**
 	 * REST endpoint to delete a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -409,7 +409,7 @@ 
 	/**
 	 * REST endpoint to publish a {@link ChangeSet} and all of its items.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */

control/Controller.php

Doc Comments +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
 	 * $this->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create
 	 * weird session errors.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param DataModel $model
 	 *
 	 * @return HTTPResponse
@@ -281,7 +281,7 @@ 
 	/**
 	 * Sets the SS_HTTPResponse object that this controller is building up.
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 *
 	 * @return $this
 	 */
@@ -322,7 +322,7 @@ 
 	 *
 	 * @param string $action
 	 *
-	 * @return HTMLText
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function defaultAction($action) {
 		return $this->getViewer($action)->process($this);
@@ -458,7 +458,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -623,7 +623,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

control/Director.php

Doc Comments +5 added lines, -5 removed lines

@@ -278,7 +278,7 @@ 
 	 * @param array|Cookie_Backend $cookies to populate $_COOKIE.
 	 * @param HTTP_Request $request The {@see HTTP_Request} object generated as a part of this request.
 	 *
-	 * @return SilverStripe\Control\HTTPResponse
+	 * @return HTTPResponse
 	 *
 	 * @throws SilverStripe\Control\HTTPResponse_Exception
 	 */
@@ -414,7 +414,7 @@ 
 	/**
 	 * Handle an HTTP request, defined with a SS_HTTPRequest object.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param Session $session
 	 * @param DataModel $model
 	 *
@@ -560,7 +560,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('SilverStripe\Control\Director', 'alternate_base_url');
@@ -893,7 +893,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1111,7 +1111,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if (Director::isLive()) {

control/HTTPRequest.php

Doc Comments +10 added lines, -10 removed lines

@@ -131,7 +131,7 @@ 
 	 *
 	 * @param string The new URL
 	 *
-	 * @return SS_HTTPRequest The updated request
+	 * @return HTTPRequest The updated request
 	 */
 	public function setUrl($url) {
 		$this->url = $url;
@@ -187,7 +187,7 @@ 
 
 	/**
 	 * @param string $body
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPRequest $this
 	 */
 	public function setBody($body) {
 		$this->body = $body;
@@ -195,7 +195,7 @@ 
 	}
 
 	/**
-	 * @return null|string
+	 * @return string
 	 */
 	public function getBody() {
 		return $this->body;
@@ -244,7 +244,7 @@ 
 
 	/**
 	 * @param string $name
-	 * @return mixed
+	 * @return string
 	 */
 	public function requestVar($name) {
 		if(isset($this->postVars[$name])) return $this->postVars[$name];
@@ -297,7 +297,7 @@ 
 	 * Remove an existing HTTP header
 	 *
 	 * @param string $header
-	 * @return mixed
+	 * @return string
 	 */
 	public function getHeader($header) {
 		return (isset($this->headers[$header])) ? $this->headers[$header] : null;
@@ -308,7 +308,7 @@ 
 	 * e.g. "Content-Type".
 	 *
 	 * @param string $header
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPRequest $this
 	 */
 	public function removeHeader($header) {
 		if(isset($this->headers[$header])) unset($this->headers[$header]);
@@ -394,9 +394,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) {
@@ -571,7 +571,7 @@ 
 
 	/**
 	 * @param $params
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPRequest $this
 	 */
 	public function setRouteParams($params) {
 		$this->routeParams = $params;
@@ -614,7 +614,7 @@ 
 	 * This is used by the request handler to prevent infinite parsing loops.
 	 *
 	 * @param $pattern
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function isEmptyPattern($pattern) {
 		if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {

control/HTTPResponse.php

Doc Comments +9 added lines, -8 removed lines

@@ -120,7 +120,7 @@ 
 	 *  No newlines are allowed in the description.
 	 *  If omitted, will default to the standard HTTP description
 	 *  for the given $code value (see {@link $status_codes}).
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function setStatusCode($code, $description = null) {
 		if(isset(self::$status_codes[$code])) $this->statusCode = $code;
@@ -136,7 +136,7 @@ 
 	 * Caution: Will be overwritten by {@link setStatusCode()}.
 	 *
 	 * @param string $description
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function setStatusDescription($description) {
 		$this->statusDescription = $description;
@@ -168,7 +168,7 @@ 
 
 	/**
 	 * @param string $body
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function setBody($body) {
 		$this->body = $body ? (string) $body : $body; // Don't type-cast false-ish values, eg null is null not ''
@@ -176,7 +176,7 @@ 
 	}
 
 	/**
-	 * @return null|string
+	 * @return string
 	 */
 	public function getBody() {
 		return $this->body;
@@ -187,7 +187,7 @@ 
 	 *
 	 * @param string $header Example: "Content-Type"
 	 * @param string $value Example: "text/xml"
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function addHeader($header, $value) {
 		$this->headers[$header] = $value;
@@ -217,7 +217,7 @@ 
 	 * e.g. "Content-Type".
 	 *
 	 * @param string $header
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function removeHeader($header) {
 		if(isset($this->headers[$header])) unset($this->headers[$header]);
@@ -227,7 +227,7 @@ 
 	/**
 	 * @param string $dest
 	 * @param int $code
-	 * @return SS_HTTPRequest $this
+	 * @return HTTPResponse $this
 	 */
 	public function redirect($dest, $code=302) {
 		if(!in_array($code, self::$redirect_codes)) $code = 302;
@@ -327,6 +327,7 @@ 
 	 * @param string|SS_HTTPResponse body Either the plaintext content of the error message, or an SS_HTTPResponse
 	 *                                     object representing it.  In either case, the $statusCode and
 	 *                                     $statusDescription will be the HTTP status of the resulting response.
+	 * @param string $statusDescription
 	 * @see SS_HTTPResponse::__construct();
 	 */
 	public function __construct($body = null, $statusCode = null, $statusDescription = null) {
@@ -356,7 +357,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function setResponse(HTTPResponse $response) {
 		$this->response = $response;