silverstripe / silverstripe-framework

model/versioning/ChangeSetItem.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,7 +132,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -141,7 +141,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);
@@ -325,7 +325,7 @@ 
 	 * Get the ChangeSetItems that reference a passed DataObject
 	 *
 	 * @param DataObject $object
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object($object) {
 		return ChangeSetItem::get()->filter([
@@ -339,7 +339,7 @@ 
 	 *
 	 * @param int $objectID The ID of the object
 	 * @param string $objectClass The class of the object (or any parent class)
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object_by_id($objectID, $objectClass) {
 		return ChangeSetItem::get()->filter([

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -728,7 +728,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -782,7 +782,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

admin/code/ModelAdmin.php

Doc Comments +3 added lines

@@ -117,6 +117,9 @@
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);

control/ContentNegotiator.php

Doc Comments +4 added lines, -3 removed lines

@@ -119,6 +119,7 @@ 
 	/**
 	 * Returns true if negotiation is enabled for the given response. By default, negotiation is only
 	 * enabled for pages that have the xml header.
+	 * @param HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");
@@ -134,7 +135,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public static function process(HTTPResponse $response) {
 		if(!self::enabled_for($response)) return;
@@ -184,7 +185,7 @@ 
 	 * Replaces a few common tags and entities with their XHTML representations (<br>, <img>, &nbsp;
 	 * <input>, checked, selected).
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 *
 	 * @todo Search for more xhtml replacement
 	 */
@@ -224,7 +225,7 @@ 
 	 * - Replaces all occurrences of "application/xhtml+xml" with "text/html" in the template.
 	 * - Removes "xmlns" attributes and any <?xml> Pragmas.
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function html(HTTPResponse $response) {
 		$encoding = Config::inst()->get('SilverStripe\Control\ContentNegotiator', 'encoding');

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

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