sminnee / silverstripe-framework

forms/HTMLEditorSanitiser.php

Doc Comments +2 added lines, -1 removed lines

@@ -39,7 +39,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -180,6 +180,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {

view/SSTemplateParser.php.inc

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) {

core/startup/ErrorControlChain.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 	/**
 	 * Get value of display_errors ini value
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	protected function getDisplayErrors() {
 		return ini_get('display_errors');
@@ -110,7 +110,7 @@ 
 	 * Add this callback to the chain of callbacks to call along with the state
 	 * that $error must be in this point in the chain for the callback to be called
 	 *
-	 * @param $callback - The callback to call
+	 * @param callable $callback - The callback to call
 	 * @param $onErrorState - false if only call if no errors yet, true if only call if already errors, null for either
 	 * @return $this
 	 */

tests/core/startup/ErrorControlChainTest.php

Doc Comments +5 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	/**
 	 * Modify method visibility to public for testing
 	 *
-	 * @param mixed $errors
+	 * @param string $errors
 	 */
 	public function setDisplayErrors($errors)
 	{
@@ -33,6 +33,10 @@ 
 	}
 
 	// Change function visibility to be testable directly
+
+	/**
+	 * @param string $memstring
+	 */
 	public function translateMemstring($memstring) {
 		return parent::translateMemstring($memstring);
 	}

dev/BulkLoader.php

Doc Comments +6 added lines, -6 removed lines

@@ -211,7 +211,7 @@ 
 	 *
 	 * @todo Mix in custom column mappings
 	 *
-	 * @return array
+	 * @return string
 	 **/
 	public function getImportSpec() {
 		$spec = array();
@@ -237,7 +237,7 @@ 
 	 * so this is mainly a customization method.
 	 *
 	 * @param mixed $val
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
 	 * @return boolean
 	 */
 	protected function isNullValue($val, $fieldName = null) {
@@ -361,7 +361,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addCreated($obj, $message = null) {
 		$this->created[] = $this->lastChange = array(
@@ -374,7 +374,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addUpdated($obj, $message = null) {
 		$this->updated[] = $this->lastChange = array(
@@ -386,8 +386,8 @@ 
 	}
 
 	/**
-	 * @param $obj DataObject
-	 * @param $message string
+	 * @param DataObject|null $obj DataObject
+	 * @param string $message string
 	 */
 	public function addDeleted($obj, $message = null) {
 		$data = $obj->toMap();

admin/code/CMSMenu.php

Doc Comments +3 added lines, -3 removed lines

@@ -99,7 +99,7 @@ 
 	 *                          left.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean The result of the operation.
+	 * @return boolean|null The result of the operation.
 	 */
 	public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes);
@@ -119,7 +119,7 @@ 
 	 *                    have the rights to access some other part of the admin area.
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 											$attributes = null) {
@@ -250,7 +250,7 @@ 
 	 *                    have the rights to access some other part of the admin area.
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 												$attributes = null) {

control/injector/Injector.php

Doc Comments +3 added lines, -5 removed lines

@@ -356,7 +356,7 @@ 
 	 *
 	 * @param string $property
 	 *				the name of the property
-	 * @param object $object
+	 * @param string $object
 	 *				the object to be set
 	 */
 	public function addAutoProperty($property, $object) {
@@ -450,7 +450,7 @@ 
 	 *				The name of the service to update the definition for
 	 * @param string $property
 	 *				The name of the property to update.
-	 * @param mixed $value
+	 * @param string $value
 	 *				The value to set
 	 * @param boolean $append
 	 *				Whether to append (the default) when the property is an array
@@ -755,6 +755,7 @@ 
 	 *
 	 * Will recursively call hasService for each depth of dotting
 	 *
+	 * @param string $name
 	 * @return string
 	 *				The name of the service (as it might be different from the one passed in)
 	 */
@@ -918,7 +919,6 @@ 
 	 * Additional parameters are passed through as
 	 *
 	 * @param string $name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return mixed A new instance of the specified object
 	 */
 	public function create($name) {
@@ -932,8 +932,6 @@ 
 	 *
 	 * @param string $name
 	 *				Name of the class to create an object of
-	 * @param array $args
-	 *				Arguments to pass to the constructor
 	 * @return mixed
 	 */
 	public function createWithArgs($name, $constructorArgs) {

control/RequestHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -282,7 +282,7 @@
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */

core/ClassInfo.php

Doc Comments +6 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 
 	/**
 	 * @todo Move this to SS_Database or DB
+	 * @param string $class
 	 */
 	public static function hasTable($class) {
 		// Cache the list of all table names to reduce on DB traffic
@@ -83,7 +84,7 @@ 
 	 *
 	 * @todo Move this into {@see DataObjectSchema}
 	 *
-	 * @param string|object $class
+	 * @param string $class
 	 * @return array
 	 */
 	public static function dataClassesFor($class) {
@@ -206,6 +207,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));
@@ -256,6 +258,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);