sminnee / silverstripe-framework

tests/view/ContentNegotiatorTest.php

Doc Comments +1 added lines

@@ -5,6 +5,7 @@
 	/**
 	 * Small helper to render templates from strings
 	 * Cloned from SSViewerTest
+	 * @param string $templateString
 	 */
 	private function render($templateString, $data = null) {
 		$t = SSViewer::fromString($templateString);

tests/view/SSViewerCacheBlockTest.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
 		"Versioned('Stage', 'Live')"
 	);
 
+	/**
+	 * @param string $entropy
+	 */
 	public function setEntropy($entropy) {
 		$this->entropy = $entropy;
 	}
@@ -53,6 +56,9 @@ 
 		SS_Cache::set_cache_lifetime('cacheblock', $cacheOn ? 600 : -1);
 	}
 
+	/**
+	 * @param string $template
+	 */
 	protected function _runtemplate($template, $data = null) {
 		if ($data === null) $data = $this->data;
 		if (is_array($data)) $data = $this->data->customise($data);

view/ArrayData.php

Doc Comments +4 added lines, -10 removed lines

@@ -50,14 +50,7 @@ 
 	/**
 	 * Gets a field from this object.
 	 *
-	 * @param string $field
-	 *
-	 * If the value is an object but not an instance of
-	 * ViewableData, it will be converted recursively to an
-	 * ArrayData.
-	 *
-	 * If the value is an associative array, it will likewise be
-	 * converted recursively to an ArrayData.
+	 * @param string $f
 	 */
 	public function getField($f) {
 		$value = $this->array[$f];
@@ -73,7 +66,7 @@ 
 	* Add or set a field on this object.
 	*
 	* @param string $field
-	* @param mixed $value
+	* @param string $value
 	*/
 	public function setField($field, $value) {
 		$this->array[$field] = $value;
@@ -83,6 +76,7 @@ 
 	 * Check array to see if field isset
 	 *
 	 * @param string Field Key
+	 * @param string $f
 	 * @return bool
 	 */
 	public function hasField($f) {
@@ -93,7 +87,7 @@ 
 	 * Converts an associative array to a simple object
 	 *
 	 * @param array
-	 * @return obj $obj
+	 * @return stdClass $obj
 	 */
 	public static function array_to_object($arr = null) {
 		$obj = new stdClass();

view/SSTemplateParser.php

Doc Comments +9 added lines, -5 removed lines

@@ -111,6 +111,8 @@ 
 
 	/**
 	 * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+	 * @param string $matchrule
+	 * @param string $name
 	 */
 	function construct($matchrule, $name, $arguments = null) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -172,9 +174,9 @@ 
 
 	/**
 	 * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-	 * @param $name
-	 * @param $callable
-	 * @param $type
+	 * @param string $name
+	 * @param callable $callable
+	 * @param string $type
 	 * @throws InvalidArgumentException
 	 */
 	protected function validateExtensionBlock($name, $callable, $type) {
@@ -737,6 +739,7 @@ 
 	 * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
 	 * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
 	 * depending on the context the lookup is used in.
+	 * @param string $method
 	 */
 	function Lookup_AddLookupStep(&$res, $sub, $method) {
 		$res['LookupSteps'][] = $sub;
@@ -4691,8 +4694,8 @@ 
 	 * Compiles some passed template source code into the php code that will execute as per the template source.
 	 *
 	 * @throws SSTemplateParseException
-	 * @param  $string The source of the template
-	 * @param string $templateName The name of the template, normally the filename the template source was loaded from
+	 * @param  string $string The source of the template
+	 * @param string string The name of the template, normally the filename the template source was loaded from
 	 * @param bool $includeDebuggingComments True is debugging comments should be included in the output
 	 * @param bool $topTemplate True if this is a top template, false if it's just a template
 	 * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source
@@ -4732,6 +4735,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

admin/code/CMSForm.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;

control/Controller.php

Doc Comments +5 added lines, -2 removed lines

@@ -322,6 +322,9 @@ 
 		return new SSViewer($templates);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function hasAction($action) {
 		return parent::hasAction($action) || $this->hasActionTemplate($action);
 	}
@@ -385,7 +388,7 @@ 
 	 * by {@link getViewer()}.
 	 *
 	 * @param array $params Key-value array for custom template variables (Optional)
-	 * @return string Parsed template content
+	 * @return HTMLText Parsed template content
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -540,7 +543,7 @@ 
 
 	/**
 	 * Tests whether a redirection has been requested.
-	 * @return string If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
+	 * @return boolean If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
 	 * return null;
 	 */
 	public function redirectedTo() {

control/Director.php

Doc Comments +2 added lines, -3 removed lines

@@ -463,7 +463,7 @@ 
 	/**
 	 * Returns the part of the URL, 'http://www.mysite.com'.
 	 *
-	 * @return boolean|string The domain from the PHP environment. Returns FALSE is this environment variable isn't
+	 * @return string|false The domain from the PHP environment. Returns FALSE is this environment variable isn't
 	 *                        set.
 	 */
 	public static function protocolAndHost() {
@@ -747,7 +747,6 @@ 
 	/**
 	 * Takes a $_SERVER data array and extracts HTTP request headers.
 	 *
-	 * @param  array $data
 	 * @return array
 	 */
 	public static function extract_request_headers(array $server) {
@@ -780,7 +779,7 @@ 
 
 	/**
 	 * Returns true if the given file exists.
-	 * @param $file Filename specified relative to the site root
+	 * @param string $file Filename specified relative to the site root
 	 */
 	public static function fileExists($file) {
 		// replace any appended query-strings, e.g. /path/to/foo.php?bar=1 to /path/to/foo.php

core/ClassInfo.php

Doc Comments +4 added lines

@@ -219,6 +219,7 @@ 
 
 	/**
 	 * Returns true if the given class implements the given interface
+	 * @param string $interfaceName
 	 */
 	public static function classImplements($className, $interfaceName) {
 		return in_array($className, self::implementorsOf($interfaceName));
@@ -269,6 +270,9 @@ 
 
 	private static $method_from_cache = array();
 
+	/**
+	 * @param string $method
+	 */
 	public static function has_method_from($class, $method, $compclass) {
 		$lClass = strtolower($class);
 		$lMethod = strtolower($method);

dev/Deprecation.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	 * greater than or equal to this version, a message will be raised
 	 *
 	 * @static
-	 * @param $ver string -
+	 * @param string|null $ver string -
 	 *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
 	 * @param null $forModule string -
 	 *    The name of a module. The passed version will be used as the check value for