silverstripe / silverstripe-framework

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;

control/PjaxResponseNegotiator.php

Doc Comments +2 added lines, -4 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,11 +70,10 @@ 
 	 * 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 HTTPResponse
 	 */
 	public function respond(HTTPRequest $request, $extraCallbacks = array()) {
@@ -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();

dev/FunctionalTest.php

Doc Comments +4 added lines, -4 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();
@@ -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);

forms/AssetField.php

Doc Comments +5 added lines, -2 removed lines

@@ -151,7 +151,6 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The field label.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null) {
 		$this->addExtraClass('ss-upload'); // class, used by js
@@ -263,6 +262,10 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param null|DataObject $value
+	 * @param DataObject $record
+	 */
 	public function setValue($value, $record = null) {
 		// Extract value from underlying record
 		if(empty($value) && $this->getName() && $record instanceof DataObject) {
@@ -700,7 +703,7 @@ 
 	/**
 	 * Action to handle upload of a single file
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return HTTPResponse
 	 */
 	public function upload(HTTPRequest $request) {

forms/UploadField.php

Doc Comments +10 added lines, -11 removed lines

@@ -223,7 +223,6 @@ 
 	 * @param string $title The field label.
 	 * @param SS_List $items If no items are defined, the field will try to auto-detect an existing relation on
 	 *                       @link $record}, with the same name as the field name.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null, SS_List $items = null) {
 
@@ -1073,7 +1072,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return UploadField_ItemHandler
 	 */
 	public function handleItem(HTTPRequest $request) {
@@ -1089,8 +1088,8 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @param HTTPRequest $request
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1212,7 +1211,7 @@ 
 	/**
 	 * Action to handle upload of a single file
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return HTTPResponse
 	 * @return HTTPResponse
 	 */
@@ -1255,7 +1254,7 @@ 
 	 * Retrieves details for files that this field wishes to attache to the
 	 * client-side form
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return HTTPResponse
 	 */
 	public function attach(HTTPRequest $request) {
@@ -1297,7 +1296,7 @@ 
 	/**
 	 * Determines if a specified file exists
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 */
 	public function fileexists(HTTPRequest $request) {
 		// Assert that requested filename doesn't attempt to escape the directory
@@ -1425,7 +1424,7 @@ 
 	/**
 	 * Action to handle deleting of a single file
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return HTTPResponse
 	 */
 	public function delete(HTTPRequest $request) {
@@ -1451,8 +1450,8 @@ 
 	/**
 	 * Action to handle editing of a single file
 	 *
-	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @param HTTPRequest $request
+	 * @return DBField
 	 */
 	public function edit(HTTPRequest $request) {
 		// Check form field state
@@ -1500,7 +1499,7 @@ 
 	/**
 	 * @param array $data
 	 * @param Form $form
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 */
 	public function doEdit(array $data, Form $form, HTTPRequest $request) {
 		// Check form field state

model/versioning/VersionedGridFieldItemRequest.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      *
      * @param array $data
      * @param Form $form
-	 * @return HTTPResponse
+	 * @return SilverStripe\Control\HTTPResponse
      */
 	public function doArchive($data, $form) {
 		$record = $this->getRecord();

forms/htmleditor/HtmlEditorField.php

Doc Comments +13 added lines, -6 removed lines

@@ -66,7 +66,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HtmlEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -80,7 +80,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HtmlEditorConfig identifier to be used. Default to the active one.
 	 */
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -121,6 +121,9 @@ 
 		$record->{$this->name} = $htmlValue->getContent();
 	}
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value) {
 		// Regenerate links prior to preview, so that the editor can see them.
 		$value = Image::regenerate_html_links($value);
@@ -188,6 +191,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -206,7 +213,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -491,7 +498,7 @@ 
 	 *
 	 * @param string $message
 	 * @param int $code
-	 * @return SS_HTTPResponse_Exception
+	 * @return HTTPResponse_Exception
 	 */
 	protected function getErrorFor($message, $code = 400) {
 		$exception = new HTTPResponse_Exception($message, $code);
@@ -586,7 +593,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 * @throws SS_HTTPResponse_Exception
 	 */
 	public function getanchors() {
@@ -1145,7 +1152,7 @@ 
 	/**
 	 * Get OEmbed type
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getType() {
 		return $this->oembed->type;