silverstripe / silverstripe-framework

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;

forms/UploadField.php

Doc Comments +13 added lines, -14 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,9 +1211,9 @@ 
 	/**
 	 * Action to handle upload of a single file
 	 *
-	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
-	 * @return SS_HTTPResponse
+	 * @param HTTPRequest $request
+	 * @return HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function upload(HTTPRequest $request) {
 		if($this->isDisabled() || $this->isReadonly() || !$this->canUpload()) {
@@ -1255,8 +1254,8 @@ 
 	 * Retrieves details for files that this field wishes to attache to the
 	 * client-side form
 	 *
-	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @param HTTPRequest $request
+	 * @return HTTPResponse
 	 */
 	public function attach(HTTPRequest $request) {
 		if(!$request->isPOST()) return $this->httpError(403);
@@ -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 SS_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/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());

tests/forms/uploadfield/AssetFieldTest.php

Doc Comments +5 added lines, -3 removed lines

@@ -306,7 +306,6 @@ 
 	 * Simulates a form post to the test controller with the specified file tuple (Filename, Hash, Variant)
 	 *
 	 * @param string $fileField Name of field to assign ids to
-	 * @param array $ids list of file IDs
 	 * @return boolean Array with key 'errors'
 	 */
 	protected function mockUploadFileSave($fileField, $filename, $hash, $variant = null) {
@@ -336,8 +335,8 @@ 
 	 * Simulates a file upload
 	 *
 	 * @param string $fileField Name of the field to mock upload for
-	 * @param array $tmpFileName Name of temporary file to upload
-	 * @return SS_HTTPResponse form response
+	 * @param string $tmpFileName Name of temporary file to upload
+	 * @return SilverStripe\Control\SS_HTTPResponse|null form response
 	 */
 	protected function mockFileUpload($fileField, $tmpFileName) {
 		$upload = $this->getUploadFile($tmpFileName);
@@ -368,6 +367,9 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param AssetFieldTest_Controller $controller
+	 */
 	function __construct($controller = null, $name = 'Form') {
 		if(empty($controller)) {
 			$controller = new AssetFieldTest_Controller();