sminnee / silverstripe-framework

dev/Backtrace.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 	 * @param mixed $returnVal
 	 * @param bool $ignoreAjax
 	 * @param array $ignoredFunctions
-	 * @return mixed
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);

dev/FixtureBlueprint.php

Doc Comments +6 added lines

@@ -264,6 +264,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function invokeCallbacks($type, $args = array()) {
 		foreach($this->callbacks[$type] as $callback) {
 			call_user_func_array($callback, $args);
@@ -303,6 +306,9 @@ 
 		$obj->$name = $this->parseValue($value, $fixtures);
 	}
 
+	/**
+	 * @param string $fieldName
+	 */
 	protected function overrideField($obj, $fieldName, $value, $fixtures = null) {
 		$class = get_class($obj);
 		$table = DataObject::getSchema()->tableForField($class, $fieldName);

filesystem/File.php

Doc Comments +6 added lines, -6 removed lines

@@ -258,7 +258,7 @@ 
 	 *
 	 * @param array $args Array of input shortcode arguments
 	 * @param int $errorCode If the file is not found, or is inaccessible, this will be assigned to a HTTP error code.
-	 * @return File|null The File DataObject, if it can be found.
+	 * @return null|DataObject The File DataObject, if it can be found.
 	 */
 	public static function find_shortcode_record($args, &$errorCode = null) {
 		// Validate shortcode
@@ -387,7 +387,7 @@ 
 	 * Check if this file can be modified
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		if(!$member) {
@@ -407,7 +407,7 @@ 
 	 *
 	 * @param Member $member
 	 * @param array $context
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		if(!$member) {
@@ -426,7 +426,7 @@ 
 	 * Check if this file can be deleted
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		if(!$member) {
@@ -627,7 +627,7 @@ 
 	 *
 	 * @param string $condition The PHP condition to be evaluated.  The page will be called $item
 	 * @param array $collator An array, passed by reference, to collect all of the matching descendants.
-	 * @return true|null
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {
@@ -988,6 +988,7 @@ 
 	 *
 	 * @param String File extension, without dot prefix. Use an asterisk ('*')
 	 * to specify a generic fallback if no mapping is found for an extension.
+	 * @param string $ext
 	 * @return String Classname for a subclass of {@link File}
 	 */
 	public static function get_class_for_file_extension($ext) {
@@ -1125,7 +1126,6 @@ 
 	 * Note that the result will not have a leading slash, and should not be used
 	 * with local file paths.
 	 *
-	 * @param string $part,... Parts
 	 * @return string
 	 */
 	public static function join_paths() {

filesystem/Folder.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
 	 * Find the given folder or create it as a database record
 	 *
 	 * @param string $folderPath Directory path relative to assets root
-	 * @return Folder|null
+	 * @return SilverStripe\Filesystem\Storage\AssetContainer
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes
@@ -149,7 +149,7 @@ 
 	/**
 	 * Returns all children of this folder
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function myChildren() {
 		return File::get()->filter("ParentID", $this->ID);
@@ -200,7 +200,7 @@ 
 	/**
 	 * Get the children of this folder that are also folders.
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function ChildFolders() {
 		return Folder::get()->filter('ParentID', $this->ID);

filesystem/ImageManipulation.php

Doc Comments +1 added lines, -1 removed lines

@@ -513,7 +513,7 @@
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return DBHTMLText
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

Unused Use Statements -2 removed lines

@@ -4,11 +4,9 @@
 
 use Deprecation;
 use SQLExpression;
-
 use InvalidArgumentException;
 use Config;
 use LogicException;
-
 use Injector;
 use SilverStripe\Model\Connect\Database;
 use SilverStripe\Control\Director;

filesystem/storage/DBFile.php

Unused Use Statements -5 removed lines

@@ -4,15 +4,10 @@
 
 use SilverStripe\Filesystem\Thumbnail;
 use SilverStripe\Filesystem\ImageManipulation;
-
-
 use Injector;
 use AssetField;
 use File;
 use Director;
-
-
-
 use SilverStripe\ORM\ValidationResult;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\ORM\FieldType\DBComposite;

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