silverstripe / silverstripe-framework

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

filesystem/storage/ProtectedFileController.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	/**
 	 * Provide a response for the given file request
 	 *
-	 * @param \SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return \SS_HTTPResponse
 	 */
 	public function handleFile(HTTPRequest $request) {
@@ -77,7 +77,7 @@ 
 	/**
 	 * Get the file component from the request
 	 *
-	 * @param \SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return string
 	 */
 	protected function parseFilename(HTTPRequest $request) {

forms/AssetField.php

Doc Comments +6 added lines, -3 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,8 +703,8 @@ 
 	/**
 	 * Action to handle upload of a single file
 	 *
-	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @param HTTPRequest $request
+	 * @return HTTPResponse
 	 */
 	public function upload(HTTPRequest $request) {
 		if($this->isDisabled() || $this->isReadonly() || !$this->canUpload()) {

forms/gridfield/GridField.php

Doc Comments +6 added lines, -6 removed lines

@@ -198,7 +198,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	public function getComponents() {
 		return $this->config->getComponents();
@@ -209,7 +209,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -296,7 +296,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -610,7 +610,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$this->extend('onBeforeRender', $this);
@@ -849,7 +849,7 @@ 
 	 *
 	 * @param array $data
 	 * @param Form $form
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return string
 	 */
@@ -943,7 +943,7 @@ 
 	 *
 	 * @todo copy less code from RequestHandler.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param DataModel $model
 	 *
 	 * @return array|RequestHandler|SS_HTTPResponse|string|void

forms/gridfield/GridFieldDetailForm.php

Doc Comments +10 added lines

@@ -192,6 +192,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -299,6 +300,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -524,6 +528,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink(){
 		// TODO Coupling with CMS
 		$backlink = '';
@@ -625,6 +632,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null) {
 		$controller = $this->getToplevelController();
 		return $controller->httpError($errorCode, $errorMessage);

forms/TreeDropdownField.php

Doc Comments +4 added lines, -5 removed lines

@@ -80,7 +80,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -208,7 +208,7 @@ 
 	}
 
 	/**
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -262,7 +262,7 @@ 
 	/**
 	 * Get the whole tree of a part of the tree via an AJAX request.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return string
 	 */
 	public function tree(HTTPRequest $request) {
@@ -389,7 +389,7 @@ 
 	 * If a filter function has been set, that will be called. And if search text is set,
 	 * filter on that too. Return true if all applicable conditions are true, false otherwise.
 	 * @param $node
-	 * @return unknown_type
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
@@ -440,7 +440,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;