silverstripe / silverstripe-framework

view/ViewableData.php

Doc Comments +4 added lines, -2 removed lines

@@ -233,7 +233,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');
@@ -485,6 +485,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));
@@ -492,6 +493,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));
@@ -499,6 +501,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));
@@ -509,7 +512,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) {

api/RestfulService.php

Doc Comments +5 added lines, -4 removed lines

@@ -334,8 +334,8 @@ 
 	/**
 	 * Extracts the response body and headers from a full curl response
 	 *
-	 * @param curl_handle $ch The curl handle for the request
-	 * @param string $rawResponse The raw response text
+	 * @param resource $ch The curl handle for the request
+	 * @param string $rawHeaders
 	 *
 	 * @return RestfulService_Response The response object
 	 */
@@ -391,7 +391,8 @@ 
 
 	/** 
 	 * Returns a full request url
-	 * @param string 
+	 * @param string
+	 * @param string $subURL 
 	 */ 
 	public function getAbsoluteRequestURL($subURL) {
 		$url = $this->baseURL . $subURL; // Url for the request
@@ -631,7 +632,7 @@ 
 	 * get the cached response object. This allows you to access the cached
 	 * eaders, not just the cached body.
 	 *
-	 * @return RestfulSerivice_Response The cached response object
+	 * @return boolean The cached response object
 	 */
 	public function getCachedResponse() {
 		return $this->cachedResponse;

control/Controller.php

Doc Comments +6 added lines, -2 removed lines

@@ -300,6 +300,9 @@ 
 		return new SSViewer($templates);
 	}
 	
+	/**
+	 * @param string $action
+	 */
 	public function hasAction($action) {
 		return parent::hasAction($action) || $this->hasActionTemplate($action);
 	}
@@ -363,7 +366,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());
@@ -388,6 +391,7 @@ 
 	/**
 	 * Returns the current controller
 	 * @returns Controller
+	 * @return Controller
 	 */
 	public static function curr() {
 		if(Controller::$controller_stack) {
@@ -519,7 +523,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/HTTP.php

Doc Comments +12 added lines, -1 removed lines

@@ -99,7 +99,7 @@ 
 	 * @param string|callable $code Either a string that can evaluate to an expression
 	 * to rewrite links (depreciated), or a callable that takes a single 
 	 * parameter and returns the rewritten URL
-	 * @return The content with all links rewritten as per the logic specified in $code
+	 * @return string content with all links rewritten as per the logic specified in $code
 	 */
 	public static function urlRewriter($content, $code) {
 		if(!is_callable($code)) {
@@ -243,6 +243,9 @@ 
 		return count($result) ? $result : null;
 	}
 	
+	/**
+	 * @param string $content
+	 */
 	public static function getLinksIn($content) {
 		return self::findByTagAndAttribute($content, array("a" => "href"));
 	}
@@ -285,6 +288,7 @@ 
 
 	/**
 	 * Set the maximum age of this page in web caches, in seconds
+	 * @param integer $age
 	 */
 	public static function set_cache_age($age) {
 		self::$cache_age = $age;
@@ -296,11 +300,17 @@ 
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 */
 	public static function register_modification_timestamp($timestamp) {
 		if($timestamp > self::$modification_date)
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param string $etag
+	 */
 	public static function register_etag($etag) {
 		self::$etag = $etag;
 	}
@@ -313,6 +323,7 @@ 
 	 *
 	 * @param SS_HTTPResponse The SS_HTTPResponse object to augment.  Omitted the argument or passing a string is
 	 *                            deprecated; in these cases, the headers are output directly.
+	 * @param SS_HTTPResponse $body
 	 */
 	public static function add_cache_headers($body = null) {
 		$cacheAge = self::$cache_age;

control/injector/Injector.php

Doc Comments +8 added lines, -8 removed lines

@@ -331,14 +331,13 @@ 
 	 * of a particular type is injected, and what items should be injected
 	 * for those properties / methods.
 	 *
-	 * @param type $class
+	 * @param string $class
 	 *					The class to set a mapping for
-	 * @param type $property
+	 * @param string $property
 	 *					The property to set the mapping for
-	 * @param type $injectType
-	 *					The registered type that will be injected
 	 * @param string $injectVia
 	 *					Whether to inject by setting a property or calling a setter
+	 * @param string $toInject
 	 */
 	public function setInjectMapping($class, $property, $toInject, $injectVia = 'property') {
 		$mapping = isset($this->injectMap[$class]) ? $this->injectMap[$class] : array();
@@ -358,7 +357,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) {
@@ -452,7 +451,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
@@ -720,6 +719,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)
 	 */
@@ -764,6 +764,8 @@ 
 	 * Register a service with an explicit name
 	 *
 	 * @deprecated since 3.1.1
+	 * @param string $name
+	 * @param stdClass $service
 	 */
 	public function registerNamedService($name, $service) {
 		return $this->registerService($service, $name);
@@ -895,8 +897,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 +5 added lines

@@ -121,6 +121,7 @@ 
 	
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -384,6 +388,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);

core/Config.php

Doc Comments +13 added lines

@@ -475,6 +475,9 @@ 
 		$this->cache->clean("__{$class}");
 	}
 
+	/**
+	 * @param integer $sourceOptions
+	 */
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
 		$tags[] = "__{$class}";
 		$tags[] = "__{$class}__{$name}";
@@ -732,6 +735,10 @@ 
 		$this->cache = $cloned;
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		// Find an index to set at
 		$replacing = null;
@@ -767,6 +774,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		if (isset($this->indexing[$key])) {
 			$this->hit++;
@@ -780,6 +790,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {

core/Convert.php

Doc Comments +2 added lines, -1 removed lines

@@ -51,7 +51,7 @@ 
 	 * @see http://www.w3.org/TR/REC-html40/types.html#type-cdata
 	 * @uses Convert::raw2att()
 	 * @param array|string $val String to escape, or array of strings
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -200,6 +200,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 * 
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 * 
 	 * @return mixed
 	 */

core/Object.php

Doc Comments +8 added lines, -10 removed lines

@@ -55,7 +55,7 @@ 
 
 	/**
 	 * Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
-	 * @return Config_ForClass|null
+	 * @return Config_ForClass
 	 */
 	static public function config() {
 		return Config::inst()->forClass(get_called_class());
@@ -125,8 +125,6 @@ 
 	 *    $list = DataList::create('SiteTree');
 	 *	  $list = SiteTree::get();
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function create() {
@@ -277,8 +275,6 @@ 
 	 * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to
 	 * TRUE when using {@link Object::useCustomClass()}
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function strong_create() {
@@ -330,8 +326,8 @@ 
 	 * without any inheritance, merging or parent lookup if it doesn't exist on the given class.
 	 *
 	 * @static
-	 * @param $class - The class to get the static from
-	 * @param $name - The property to get from the class
+	 * @param string $class - The class to get the static from
+	 * @param string $name - The property to get from the class
 	 * @param null $default - The value to return if property doesn't exist on class
 	 * @return any - The value of the static property $name on class $class, or $default if that property is not
 	 *               defined
@@ -516,7 +512,6 @@ 
 	 * instances, not existing ones (including all instances created through {@link singleton()}).
 	 *
 	 * @see http://doc.silverstripe.org/framework/en/trunk/reference/dataextension
-	 * @param string $class Class that should be extended - has to be a subclass of {@link Object}
 	 * @param string $extension Subclass of {@link Extension} with optional parameters 
 	 *  as a string, e.g. "Versioned" or "Translatable('Param')"
 	 */
@@ -895,6 +890,7 @@ 
 	
 	/**
 	 * @see Object::get_static()
+	 * @param string $name
 	 */
 	public function stat($name, $uncached = false) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET);
@@ -902,6 +898,8 @@ 
 	
 	/**
 	 * @see Object::set_static()
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function set_stat($name, $value) {
 		Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value);
@@ -909,6 +907,7 @@ 
 	
 	/**
 	 * @see Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -959,7 +958,7 @@ 
 	 * all results into an array
 	 *
 	 * @param string $method the method name to call
-	 * @param mixed $argument a single argument to pass
+	 * @param string $argument a single argument to pass
 	 * @return mixed
 	 * @todo integrate inheritance rules
 	 */
@@ -982,7 +981,6 @@ 
 	 * The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
 	 * 
 	 * @param string $method the name of the method to call on each extension
-	 * @param mixed $a1,... up to 7 arguments to be passed to the method
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {