sminnee / silverstripe-framework

search/filters/SearchFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param boolean|string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName, $value = false, array $modifiers = array()) {
@@ -287,7 +287,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

security/Security.php

Doc Comments +5 added lines, -6 removed lines

@@ -465,7 +465,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -645,7 +645,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken = urldecode($autologinToken);
@@ -736,7 +735,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -746,7 +745,7 @@ 
 	 * Gets the template for an include used for security.
 	 * For use in any subclass.
 	 *
-	 * @return string|array Returns the template(s) for rendering
+	 * @return string[] Returns the template(s) for rendering
 	 */
 	public function getIncludeTemplate($name) {
 		return array('Security_' . $name);
@@ -920,7 +919,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1075,7 +1074,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

tests/filesystem/UploadTest.php

Doc Comments +4 added lines

@@ -304,6 +304,10 @@
 	// Delete files in the default uploads directory that match the name pattern.
 	// @param String $namePattern	A regular expression applied to files in the directory. If the name matches
 	// the pattern, it is deleted. Directories, . and .. are excluded.
+
+	/**
+	 * @param string $namePattern
+	 */
 	public function deleteTestUploadFiles($namePattern) {
 		$tmpFolder = ASSETS_PATH . "/" . Config::inst()->get('Upload', 'uploads_folder');
 		$files = scandir($tmpFolder);

tests/forms/HtmlEditorFieldToolbarTest.php

Doc Comments +6 added lines

@@ -5,10 +5,16 @@
 		return parent::viewfile_getLocalFileByID($id);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getLocalFileByURL($fileUrl) {
 		return parent::viewfile_getLocalFileByURL($fileUrl);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getRemoteFileByURL($fileUrl) {
 		return parent::viewfile_getRemoteFileByURL($fileUrl);
 	}

tests/forms/RequirementsTest.php

Doc Comments +14 added lines

@@ -51,6 +51,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedRequirements($backend) {
 		$basePath = $this->getCurrentRelativePath();
 
@@ -76,6 +79,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedNonrequiredRequirements($backend) {
 			$basePath = $this->getCurrentRelativePath();
 
@@ -452,6 +458,10 @@ 
 		$this->assertNotRegexp('/RequirementsTest_b\.css\?m=[\d]*&foo=bar&bla=blubb"/', $html);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch (strtolower($type)) {
@@ -496,6 +506,10 @@ 
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch ($type) {

tests/view/SSViewerTest.php

Doc Comments +13 added lines

@@ -119,6 +119,10 @@ 
 		));
 	}
 
+	/**
+	 * @param HTMLText $result
+	 * @param string[] $expected
+	 */
 	private function assertExpectedStrings($result, $expected) {
 		foreach ($expected as $expectedStr) {
 			$this->assertTrue(
@@ -739,6 +743,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));
 	}
@@ -1353,6 +1361,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/Requirements.php

Doc Comments +6 added lines, -4 removed lines

@@ -49,6 +49,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->set_suffix_requirements($var);
@@ -109,7 +110,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_custom_scripts() {
 		return self::backend()->get_custom_scripts();
@@ -517,7 +518,7 @@ 
 	/**
 	 * Enable or disable the combination of CSS and JavaScript files
 	 *
-	 * @param $enable
+	 * @param boolean $enable
 	 */
 	public function set_combined_files_enabled($enable) {
 		$this->combined_files_enabled = (bool) $enable;
@@ -585,6 +586,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public function set_force_js_to_bottom($var) {
 		$this->force_js_to_bottom = $var;
@@ -624,7 +626,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function get_custom_scripts() {
 		$requirements = "";
@@ -1037,7 +1039,7 @@ 
 	 * @param array  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function combine_files($combinedFileName, $files, $media = null) {
 		// duplicate check

view/SSViewer.php

Doc Comments +13 added lines, -4 removed lines

@@ -336,7 +336,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
 	 */
@@ -410,6 +409,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) {
@@ -751,7 +754,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1156,7 +1159,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return HTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1182,6 +1185,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1210,7 +1216,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) {
@@ -1251,6 +1257,9 @@ 
 	 */
 	protected $cacheTemplate;
 	
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

view/ViewableData.php

Doc Comments +5 added lines, -5 removed lines

@@ -141,7 +141,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -208,8 +208,6 @@ 
 	/**
 	 * Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
 	 *
-	 * @param string $field
-	 * @param array $arguments
 	 * @param string $identifier an optional custom cache identifier
 	 * @return unknown
 	 */
@@ -271,7 +269,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -523,6 +521,7 @@ 
 
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -530,6 +529,7 @@ 
 
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -537,6 +537,7 @@ 
 
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -547,7 +548,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {