silverstripe / silverstripe-framework

control/Director.php

Doc Comments +4 added lines, -4 removed lines

@@ -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 +11 added lines, -11 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,10 +394,10 @@ 
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
-	 * @return SS_HTTPResponse
+	 * @param string $mimeType
+	 * @return HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {
 		if(!$mimeType) {
@@ -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 +10 added lines, -9 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) {
@@ -349,14 +350,14 @@ 
 	}
 
 	/**
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function getResponse() {
 		return $this->response;
 	}
 
 	/**
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function setResponse(HTTPResponse $response) {
 		$this->response = $response;

control/PjaxResponseNegotiator.php

Doc Comments +3 added lines, -5 removed lines

@@ -49,7 +49,6 @@ 
 	protected $fragmentOverride = null;
 
 	/**
-	 * @param RequestHandler $controller
 	 * @param SS_HTTPResponse An existing response to reuse (optional)
 	 * @param Array $callbacks
 	 */
@@ -71,12 +70,11 @@ 
 	 * Out of the box, the handler "CurrentForm" value, which will return the rendered form.
 	 * Non-Ajax calls will redirect back.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param array $extraCallbacks List of anonymous functions or callables returning either a string
 	 * or SS_HTTPResponse, keyed by their fragment identifier. The 'default' key can
 	 * be used as a fallback for non-ajax responses.
-	 * @param array $fragmentOverride Change the response fragments.
-	 * @return SS_HTTPResponse
+	 * @return string
 	 */
 	public function respond(HTTPRequest $request, $extraCallbacks = array()) {
 		// Prepare the default options and combine with the others
@@ -123,7 +121,7 @@ 
 	/**
 	 * Set up fragment overriding - will completely replace the incoming fragments.
 	 *
-	 * @param array $fragments Fragments to insert.
+	 * @param string[] $fragments Fragments to insert.
 	 */
 	public function setFragmentOverride($fragments) {
 		if (!is_array($fragments)) throw new InvalidArgumentException();

control/RequestHandler.php

Doc Comments +6 added lines

@@ -142,6 +142,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -259,6 +260,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -405,6 +409,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);
@@ -514,6 +519,7 @@ 
 	 * or {@link handleRequest()}, but in some based we want to set it manually.
 	 *
 	 * @param SS_HTTPRequest
+	 * @param HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$this->request = $request;

control/Session.php

Doc Comments +3 added lines, -1 removed lines

@@ -280,7 +280,6 @@ 
 	 *
 	 * @deprecated 4.0 Use the "Session.timeout_ips" config setting instead
 	 *
-	 * @param array $session_ips Array of IPv4 rules.
 	 */
 	public static function set_timeout_ips($ips) {
 		Deprecation::notice('4.0', 'Use the "Session.timeout_ips" config setting instead');
@@ -417,6 +416,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_set($name, $val) {
 		// Quicker execution path for "."-free names
 		if(strpos($name, '.') === false) {

dev/FunctionalTest.php

Doc Comments +7 added lines, -7 removed lines

@@ -68,7 +68,7 @@ 
 	/**
 	 * Returns the {@link Session} object for this test
 	 *
-	 * @return Session
+	 * @return Session|null
 	 */
 	public function session() {
 		return $this->mainSession->session();
@@ -144,7 +144,7 @@ 
 	 * @param Session $session
 	 * @param array $headers
 	 * @param array $cookies
-	 * @return SS_HTTPResponse
+	 * @return SilverStripe\Control\SS_HTTPResponse|null
 	 */
 	public function get($url, $session = null, $headers = null, $cookies = null) {
 		$this->cssParser = null;
@@ -165,7 +165,7 @@ 
 	 * @param Session $session
 	 * @param string $body
 	 * @param array $cookies
-	 * @return SS_HTTPResponse
+	 * @return SilverStripe\Control\SS_HTTPResponse|null
 	 */
 	public function post($url, $data, $headers = null, $session = null, $body = null, $cookies = null) {
 		$this->cssParser = null;
@@ -193,7 +193,7 @@ 
 	 * @param string $formID HTML 'id' attribute of a form (loaded through a previous response)
 	 * @param string $button HTML 'name' attribute of the button (NOT the 'id' attribute)
 	 * @param array $data Map of GET/POST data.
-	 * @return SS_HTTPResponse
+	 * @return SilverStripe\Control\SS_HTTPResponse|null
 	 */
 	public function submitForm($formID, $button = null, $data = array()) {
 		$this->cssParser = null;
@@ -217,7 +217,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) {
 		$found = false;
@@ -247,7 +247,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
 	 * @throws PHPUnit_Framework_AssertionFailedError
 	 * @return boolean
 	 */
@@ -344,7 +344,7 @@ 
 	 * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
 	 * @param array|string $expectedMatches The content of *all* matched tags as an array
 	 * @throws PHPUnit_Framework_AssertionFailedError
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function assertExactHTMLMatchBySelector($selector, $expectedMatches) {
 		$items = $this->cssParser()->getBySelector($selector);

dev/TestSession.php

Doc Comments +2 added lines, -2 removed lines

@@ -132,7 +132,7 @@ 
 	 * @param string $formID HTML 'id' attribute of a form (loaded through a previous response)
 	 * @param string $button HTML 'name' attribute of the button (NOT the 'id' attribute)
 	 * @param array $data Map of GET/POST data.
-	 * @return SS_HTTPResponse
+	 * @return SilverStripe\Control\SS_HTTPResponse|null
 	 */
 	public function submitForm($formID, $button = null, $data = array()) {
 		$page = $this->lastPage();
@@ -168,7 +168,7 @@ 
 	/**
 	 * If the last request was a 3xx response, then follow the redirection
 	 *
-	 * @return SS_HTTPResponse The response given, or null if no redirect occurred
+	 * @return SilverStripe\Control\SS_HTTPResponse|null The response given, or null if no redirect occurred
 	 */
 	public function followRedirection() {
 		if($this->lastResponse->getHeader('Location')) {

filesystem/flysystem/FlysystemAssetStore.php

Doc Comments +4 added lines, -4 removed lines

@@ -812,7 +812,7 @@ 
 	 * Generate an {@see SS_HTTPResponse} for the given file from the source filesystem
 	 * @param FilesystemInterface $flysystem
 	 * @param string $fileID
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	protected function createResponseFor(FilesystemInterface $flysystem, $fileID) {
 		// Build response body
@@ -833,7 +833,7 @@ 
 	/**
 	 * Generate a response for requests to a denied protected file
 	 *
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	protected function createDeniedResponse() {
 		$code = (int)Config::inst()->get(get_class($this), 'denied_response_code');
@@ -843,7 +843,7 @@ 
 	/**
 	 * Generate a response for missing file requests
 	 *
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	protected function createMissingResponse() {
 		$code = (int)Config::inst()->get(get_class($this), 'missing_response_code');
@@ -854,7 +854,7 @@ 
 	 * Create a response with the given error code
 	 *
 	 * @param int $code
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	protected function createErrorResponse($code) {
 		$response = new HTTPResponse('', $code);