silverstripe / silverstripe-framework

forms/AssetField.php

Doc Comments +6 added lines, -2 removed lines

@@ -195,7 +195,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) {
@@ -264,6 +264,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) {
@@ -370,7 +374,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) {

forms/ConfirmedPasswordField.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,7 +144,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return DBHTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
@@ -494,7 +494,7 @@ 
 	 *
 	 * @param DataObjectInterface $record
 	 *
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		if(!$this->isSaveable()) {

forms/Form.php

Doc Comments +8 added lines, -4 removed lines

@@ -507,7 +507,7 @@ 
 	 * The callback can opt out of handling specific responses by returning NULL,
 	 * in which case the default form behaviour will kick in.
 	 *
-	 * @param $callback
+	 * @param Closure $callback
 	 * @return self
 	 */
 	public function setValidationResponseCallback($callback) {
@@ -567,7 +567,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -706,6 +706,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 * @return $this
 	 */
 	public function setValidationExemptActions($actions) {
@@ -1104,7 +1105,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1662,7 +1663,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return DBHTMLText
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1923,6 +1924,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/gridfield/GridFieldPrintButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');

forms/TreeDropdownField.php

Doc Comments +2 added lines, -2 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
@@ -398,7 +398,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 object $node
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;

forms/UploadField.php

Doc Comments +5 added lines, -5 removed lines

@@ -285,7 +285,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) return false;
@@ -638,7 +638,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) return false;
@@ -662,7 +662,7 @@ 
 	 * Determine if the user has permission to attach existing files
 	 * By default returns true if the user has the CMS_ACCESS_AssetAdmin permission
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canAttachExisting() {
 		if(!$this->isActive()) return false;
@@ -1094,7 +1094,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1457,7 +1457,7 @@ 
 	 * Action to handle editing of a single file
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return DBField
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

ORM/DataExtension.php

Doc Comments +6 added lines

@@ -78,9 +78,15 @@
 	public function can($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canEdit($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canDelete($member) {
 	}
 

ORM/DataObject.php

Doc Comments +8 added lines, -7 removed lines

@@ -2197,7 +2197,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
-	 * @param $class
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2677,6 +2677,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -2880,7 +2881,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canView($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2892,7 +2893,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2904,7 +2905,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2918,7 +2919,7 @@ 
 	 * @param Member $member
 	 * @param array $context Additional context-specific data which might
 	 * affect whether (or where) this object could be created.
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
@@ -3018,7 +3019,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3088,7 +3089,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.

ORM/Versioning/ChangeSetItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -127,7 +127,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);
@@ -136,7 +136,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);