silverstripe / silverstripe-framework

src/Core/Config/Config.php

Doc Comments +7 added lines, -1 removed lines

@@ -521,12 +521,18 @@ 
 
     protected $extraConfigSources = array();
 
+    /**
+     * @param string $class
+     */
     public function extraConfigSourcesChanged($class)
     {
         unset($this->extraConfigSources[$class]);
         $this->cache->clean("__{$class}");
     }
 
+    /**
+     * @param integer $sourceOptions
+     */
     protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags)
     {
         $tags[] = "__{$class}";
@@ -627,7 +633,7 @@ 
      * caching heavily here.
      *
      * @param $class string - The name of the class to get the value for
-     * @param $name string - The property to get the value for
+     * @param string $name string - The property to get the value for
      * @param int $sourceOptions Bitmask which can be set to some combintain of Config::UNINHERITED,
      *                           Config::FIRST_SET, and Config::EXCLUDE_EXTENSIONS.
      *

src/Core/Convert.php

Doc Comments +5 added lines, -4 removed lines

@@ -57,9 +57,9 @@ 
      *
      * @see http://www.w3.org/TR/REC-html40/types.html#type-cdata
      *
-     * @param array|string $val String to escape, or array of strings
+     * @param string $val String to escape, or array of strings
      *
-     * @return array|string
+     * @return string
      */
     public static function raw2htmlname($val)
     {
@@ -200,7 +200,7 @@ 
      * table, or column name. Supports encoding of multi identfiers separated by
      * a delimiter (e.g. ".")
      *
-     * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
+     * @param string $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
      * to be joined via the separator.
      * @param string $separator The string that delimits subsequent identifiers
      * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
@@ -301,6 +301,7 @@ 
      * call this function directly, Please use {@link Convert::xml2array()}
      *
      * @param SimpleXMLElement
+     * @param SimpleXMLElement $xml
      *
      * @return mixed
      */
@@ -514,7 +515,7 @@ 
      * - IDField => idField
      * - iDField => iDField
      *
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function upperCamelToLowerCamel($str)

src/Core/CustomMethods.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
     /**
      * Get meta-data details on a named method
      *
-     * @param array $method
+     * @param string $method
      * @return array List of custom method details, if defined for this method
      */
     protected function getExtraMethodConfig($method)

src/Core/Injector/Injector.php

Doc Comments +2 added lines, -2 removed lines

@@ -368,7 +368,7 @@ 
      *
      * @param string $property
      *                the name of the property
-     * @param object $object
+     * @param string $object
      *                the object to be set
      * @return $this
      */
@@ -463,7 +463,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

src/Core/Manifest/ClassManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -259,7 +259,7 @@
      * Returns an array containing all the descendants (direct and indirect)
      * of a class.
      *
-     * @param  string|object $class
+     * @param  string $class
      * @return array
      */
     public function getDescendantsOf($class)

src/Core/Manifest/ConfigManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -539,7 +539,7 @@
      * Returns false if the prefilterable parts of the rule aren't met, and true if they are
      *
      * @param  $rules array - A hash of rules as allowed in the only or except portion of a config fragment header
-     * @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an
+     * @return boolean|string - True if the rules are met, false if not. (Note that depending on whether we were passed an
      *                only or an except rule,
      * which values means accept or reject a fragment
      */

src/Core/Startup/ErrorControlChain.php

Doc Comments +2 added lines, -2 removed lines

@@ -106,7 +106,7 @@ 
     /**
      * Get value of display_errors ini value
      *
-     * @return mixed
+     * @return string
      */
     protected function getDisplayErrors()
     {
@@ -117,7 +117,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
      */

src/Core/Startup/ParameterConfirmationToken.php

Doc Comments +4 added lines, -1 removed lines

@@ -38,6 +38,9 @@ 
      */
     protected $token = null;
 
+    /**
+     * @param string $token
+     */
     protected function pathForToken($token)
     {
         return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token);
@@ -247,7 +250,7 @@ 
      * Given a list of token names, suppress all tokens that have not been validated, and
      * return the non-validated token with the highest priority
      *
-     * @param array $keys List of token keys in ascending priority (low to high)
+     * @param string[] $keys List of token keys in ascending priority (low to high)
      * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority
      */
     public static function prepare_tokens($keys)

src/Dev/Backtrace.php

Doc Comments +1 added lines, -1 removed lines

@@ -132,7 +132,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)
     {