sminnee / silverstripe-framework

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 DBHTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

ORM/Connect/DBSchemaManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -484,7 +484,7 @@
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {

tests/view/SSViewerTest.php

Doc Comments +13 added lines

@@ -128,6 +128,10 @@ 
 		));
 	}
 
+	/**
+	 * @param DBHTMLText $result
+	 * @param string[] $expected
+	 */
 	private function assertExpectedStrings($result, $expected) {
 		foreach ($expected as $expectedStr) {
 			$this->assertTrue(
@@ -787,6 +791,10 @@ 
 		$this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
 	}
 
+	/**
+	 * @param string $a
+	 * @param string $b
+	 */
 	public function assertEqualIgnoringWhitespace($a, $b) {
 		$this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b));
 	}
@@ -1375,6 +1383,11 @@ 
 		Config::inst()->update('SSViewer', 'source_file_comments', false);
 		Config::inst()->update('Director', 'environment_type', $origEnv);
 	}
+
+	/**
+	 * @param string $name
+	 * @param string $expected
+	 */
 	private function _renderWithSourceFileComments($name, $expected) {
 		$viewer = new SSViewer(array($name));
 		$data = new ArrayData(array());

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -370,7 +370,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -444,6 +443,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -843,7 +846,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -873,7 +876,7 @@ 
 	}
 
 	/**
-	 * @param string|array $templateList If passed as a string with .ss extension, used as the "main" template.
+	 * @param string|array $templates If passed as a string with .ss extension, used as the "main" template.
 	 *  If passed as an array, it can be used for template inheritance (first found template "wins").
 	 *  Usually the array values are PHP class names, which directly correlate to template names.
 	 *  <code>
@@ -1226,7 +1229,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBHTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1252,6 +1255,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1281,7 +1287,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1322,6 +1328,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

control/HTTPRequest.php

Doc Comments +3 added lines, -3 removed lines

@@ -385,9 +385,9 @@ 
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
+	 * @param string $mimeType
 	 * @return SS_HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {
@@ -605,7 +605,7 @@ 
 	 * This is used by the request handler to prevent infinite parsing loops.
 	 *
 	 * @param $pattern
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function isEmptyPattern($pattern) {
 		if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {

control/HTTPResponse.php

Doc Comments +7 added lines, -6 removed lines

@@ -109,7 +109,7 @@ 
 	 *  No newlines are allowed in the description.
 	 *  If omitted, will default to the standard HTTP description
 	 *  for the given $code value (see {@link $status_codes}).
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setStatusCode($code, $description = null) {
 		if(isset(self::$status_codes[$code])) $this->statusCode = $code;
@@ -125,7 +125,7 @@ 
 	 * Caution: Will be overwritten by {@link setStatusCode()}.
 	 *
 	 * @param string $description
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setStatusDescription($description) {
 		$this->statusDescription = $description;
@@ -157,7 +157,7 @@ 
 
 	/**
 	 * @param string $body
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setBody($body) {
 		$this->body = $body ? (string) $body : $body; // Don't type-cast false-ish values, eg null is null not ''
@@ -176,7 +176,7 @@ 
 	 *
 	 * @param string $header Example: "Content-Type"
 	 * @param string $value Example: "text/xml"
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function addHeader($header, $value) {
 		$this->headers[$header] = $value;
@@ -206,7 +206,7 @@ 
 	 * e.g. "Content-Type".
 	 *
 	 * @param string $header
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function removeHeader($header) {
 		if(isset($this->headers[$header])) unset($this->headers[$header]);
@@ -216,7 +216,7 @@ 
 	/**
 	 * @param string $dest
 	 * @param int $code
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function redirect($dest, $code=302) {
 		if(!in_array($code, self::$redirect_codes)) $code = 302;
@@ -316,6 +316,7 @@ 
 	 * @param string|SS_HTTPResponse body Either the plaintext content of the error message, or an SS_HTTPResponse
 	 *                                     object representing it.  In either case, the $statusCode and
 	 *                                     $statusDescription will be the HTTP status of the resulting response.
+	 * @param string $statusDescription
 	 * @see SS_HTTPResponse::__construct();
 	 */
 	public function __construct($body = null, $statusCode = null, $statusDescription = null) {

core/manifest/ManifestCache.php

Doc Comments +18 added lines

@@ -7,9 +7,27 @@
  * @subpackage manifest
  */
 interface ManifestCache {
+
+	/**
+	 * @return void
+	 */
 	public function __construct($name);
+
+	/**
+	 * @param string $key
+	 */
 	public function load($key);
+
+	/**
+	 * @param string $key
+	 *
+	 * @return void
+	 */
 	public function save($data, $key);
+
+	/**
+	 * @return void
+	 */
 	public function clear();
 }
 

forms/CompositeField.php

Doc Comments +10 added lines

@@ -214,6 +214,9 @@ 
 
 
 
+	/**
+	 * @param boolean $disabled
+	 */
 	public function setDisabled($disabled) {
 		parent::setDisabled($disabled);
 		foreach($this->getChildren() as $child) {
@@ -222,6 +225,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $readonly
+	 */
 	public function setReadonly($readonly)
 	{
 		parent::setReadonly($readonly);
@@ -367,6 +373,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @return boolean
+	 */
 	public function IsReadonly() {
 		return $this->readonly;
 	}
@@ -376,6 +385,7 @@ 
 	 * the children collection. Doesn't work recursively.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
 	 *             be found.
 	 */

forms/DatetimeField.php

Doc Comments +22 added lines, -4 removed lines

@@ -64,6 +64,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -74,6 +78,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -84,6 +91,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -96,7 +106,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -110,7 +120,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/client/dist/styles/DatetimeField.css');
@@ -223,6 +233,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
 		$this->dateField->setReadonly($bool);
@@ -240,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -265,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -312,7 +327,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -330,7 +345,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -340,6 +355,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);