silverstripe / silverstripe-framework

control/ContentNegotiator.php

Doc Comments +1 added lines

@@ -97,6 +97,7 @@
 	/**
 	 * Returns true if negotation is enabled for the given response.
 	 * By default, negotiation is only enabled for pages that have the xml header.
+	 * @param SS_HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");

control/HTTP.php

Doc Comments +11 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) {
 		if (0 !== strpos($etag, '"')) {
 			$etag = sprintf('"%s"', $etag);

dev/Debug.php

Doc Comments +14 added lines, -7 removed lines

@@ -226,6 +226,12 @@ 
 		set_exception_handler('exceptionHandler');
 	}
 
+	/**
+	 * @param integer $errno
+	 * @param string $errstr
+	 * @param string $errfile
+	 * @param integer $errline
+	 */
 	public static function noticeHandler($errno, $errstr, $errfile, $errline, $errcontext) {
 		if(error_reporting() == 0) return;
 		ini_set('display_errors', 0);
@@ -252,10 +258,10 @@ 
 	/**
 	 * Handle a non-fatal warning error thrown by PHP interpreter.
 	 *
-	 * @param unknown_type $errno
-	 * @param unknown_type $errstr
-	 * @param unknown_type $errfile
-	 * @param unknown_type $errline
+	 * @param integer $errno
+	 * @param string $errstr
+	 * @param string $errfile
+	 * @param integer $errline
 	 * @param unknown_type $errcontext
 	 */
 	public static function warningHandler($errno, $errstr, $errfile, $errline, $errcontext) {
@@ -286,8 +292,8 @@ 
 	 *
 	 * Runtime execution dies immediately once the error is generated.
 	 *
-	 * @param unknown_type $errno
-	 * @param unknown_type $errstr
+	 * @param integer $errno
+	 * @param string $errstr
 	 * @param unknown_type $errfile
 	 * @param unknown_type $errline
 	 * @param unknown_type $errcontext
@@ -327,7 +333,7 @@ 
 	 *                                     or "tech-speak". Used in the HTTP Header and ajax responses.
 	 * @param string $friendlyErrorDetail Detailed user-focused message. Is just used if no {@link ErrorPage} is found
 	 *                                    for this specific status code.
-	 * @return string HTML error message for non-ajax requests, plaintext for ajax-request.
+	 * @return boolean HTML error message for non-ajax requests, plaintext for ajax-request.
 	 */
 	public static function friendlyError($statusCode=500, $friendlyErrorMessage=null, $friendlyErrorDetail=null) {
 		// Ensure the error message complies with the HTTP 1.1 spec
@@ -399,6 +405,7 @@ 
 	 * @param unknown_type $errfile
 	 * @param unknown_type $errline
 	 * @param unknown_type $errcontext
+	 * @param string $errtype
 	 */
 	public static function showError($errno, $errstr, $errfile, $errline, $errcontext, $errtype) {
 		if(!headers_sent()) {

dev/FixtureFactory.php

Doc Comments +5 added lines, -4 removed lines

@@ -117,6 +117,7 @@ 
 	/**
 	 * Return all of the IDs in the fixture of a particular class name.
 	 *
+	 * @param string $class
 	 * @return A map of fixture-identifier => object-id
 	 */
 	public function getIds($class) {
@@ -131,6 +132,7 @@ 
 	 * @param String
 	 * @param String $identifier
 	 * @param Int $databaseId
+	 * @param string $class
 	 */
 	public function setId($class, $identifier, $databaseId) {
 		$this->fixtures[$class][$identifier] = $databaseId;
@@ -140,8 +142,8 @@ 
 	/**
 	 * Get an object from the fixture.
 	 *
-	 * @param $class The data class, as specified in your fixture file.  Parent classes won't work
-	 * @param $identifier The identifier string, as provided in your fixture file
+	 * @param string $class The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $identifier The identifier string, as provided in your fixture file
 	 */
 	public function get($class, $identifier) {
 		$id = $this->getId($class, $identifier);
@@ -161,7 +163,7 @@ 
 	 * or {@link createRaw()}, both from the internal fixture mapping and the database.
 	 * If the $class argument is set, limit clearing to items of this class.
 	 *
-	 * @param String $class
+	 * @param string $limitToClass
 	 */
 	public function clear($limitToClass = null) {
 		$classes = ($limitToClass) ? array($limitToClass) : array_keys($this->fixtures);
@@ -202,7 +204,6 @@ 
 	 * Parse a value from a fixture file.  If it starts with =>
 	 * it will get an ID from the fixture dictionary
 	 *
-	 * @param String $fieldVal
 	 * @return String Fixture database ID, or the original value
 	 */
 	protected function parseValue($value) {

filesystem/Folder.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 *
 	 * @param $folderPath string Absolute or relative path to the file.
 	 *  If path is relative, its interpreted relative to the "assets/" directory.
-	 * @return Folder|null
+	 * @return null|DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// Create assets directory, if it is missing

i18n/i18nTextCollector.php

Doc Comments +6 added lines, -1 removed lines

@@ -709,7 +709,8 @@ 
 	 * Input for langArrayCodeForEntitySpec() should be suitable for insertion
 	 * into single-quoted strings, so needs to be escaped already.
 	 *
-	 * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $locale
 	 */
 	public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) {
 		$php = '';
@@ -772,6 +773,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function getYaml($entities, $locale) {
 		// Use the Zend copy of this script to prevent class conflicts when RailsYaml is included
 		require_once 'thirdparty/zend_translate_railsyaml/library/Translate/Adapter/thirdparty/sfYaml/lib'
@@ -846,6 +850,7 @@ 
 
 	/**
 	 * Parses a template and returns any translatable entities
+	 * @param string $template
 	 */
 	public static function GetTranslatables($template) {
 		self::$entities = array();

model/Aggregate.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,6 +47,7 @@ 
 	/**
 	 * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches.
 	 * {@link $class} is just effective if the cache backend supports tags.
+	 * @param string $class
 	 */
 	public static function flushCache($class=null) {
 		$cache = self::cache();
@@ -85,7 +86,7 @@ 
 	 * Build the SQLSelect to calculate the aggregate
 	 * This is a seperate function so that subtypes of Aggregate can change just this bit
 	 * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)")
-	 * @return SQLSelect
+	 * @return DataList
 	 */
 	protected function query($attr) {
 		$query = DataList::create($this->type)->where($this->filter);

model/DataQuery.php

Doc Comments +10 added lines, -2 removed lines

@@ -44,6 +44,7 @@ 
 	 * Create a new DataQuery.
 	 *
 	 * @param String The name of the DataObject class that you wish to query
+	 * @param string $dataClass
 	 */
 	public function __construct($dataClass) {
 		$this->dataClass = $dataClass;
@@ -166,7 +167,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLQuery The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -664,7 +665,7 @@ 
 	 * mappings to the query object state. This has to be called
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
 	 *
-	 * @param String|array $relation The array/dot-syntax relation to follow
+	 * @param string $relation The array/dot-syntax relation to follow
 	 * @return The model class of the related item
 	 */
 	public function applyRelation($relation) {
@@ -844,6 +845,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -878,6 +880,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -887,6 +892,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

model/fieldtypes/Currency.php

Doc Comments +6 added lines

@@ -23,6 +23,9 @@ 
 	 */
 	private static $currency_symbol = '$';
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
 	}
@@ -46,6 +49,9 @@ 
 		else return $val;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setValue($value, $record = null) {
 		$matches = null;
 		if(is_numeric($value)) {