sminnee / silverstripe-framework

model/connect/Database.php

Doc Comments +4 added lines, -1 removed lines

@@ -385,6 +385,7 @@ 
 	 * - minutes
 	 * - seconds
 	 * This includes the singular forms as well
+	 * @param string $date
 	 * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of
 	 *                the addition
 	 */
@@ -398,6 +399,7 @@ 
 	 *                       e.g. '"SiteTree"."Created"'
 	 * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime
 	 *                      like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
+	 * @param string $date1
 	 * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which
 	 *                is the result of the substraction
 	 */
@@ -625,7 +627,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -785,6 +787,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

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");

core/Convert.php

Doc Comments +3 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @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)) {
@@ -181,7 +181,7 @@ 
 	 *
 	 * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title'
 	 * @param string $separator The string that delimits subsequent identifiers
-	 * @return string|array The escaped identifier. E.g. '"SiteTree"."Title"'
+	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
 	 */
 	public static function symbol2sql($identifier, $separator = '.') {
 		if(is_array($identifier)) {
@@ -266,6 +266,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */

core/manifest/ConfigStaticManifest.php

Doc Comments +1 added lines

@@ -323,6 +323,7 @@
 	 *
 	 * Seperated out from parse partially so that we can recurse if there are multiple statics
 	 * being declared in a comma seperated list
+	 * @param string $class
 	 */
 	function parseStatic($access, $class) {
 		$variable = null;

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/File.php

Doc Comments +2 added lines, -1 removed lines

@@ -234,7 +234,7 @@ 
 	 * Find a File object by the given filename.
 	 *
 	 * @param String $filename Matched against the "Name" property.
-	 * @return mixed null if not found, File object of found file
+	 * @return null|DataObject null if not found, File object of found file
 	 */
 	public static function find($filename) {
 		// Get the base file if $filename points to a resampled file
@@ -449,6 +449,7 @@ 
 	 * showing icons on filelinks, etc.
 	 * Possible group values are: "audio", "mov", "zip", "image".
 	 *
+	 * @param string $ext
 	 * @return String
 	 */
 	public static function get_app_category($ext) {

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

filesystem/GD.php

Doc Comments +8 added lines

@@ -150,6 +150,7 @@ 
 	 * successfully, the manipulation's cache key is removed.
 	 *
 	 * @param string $filename
+	 * @param string $manipulation
 	 * @return boolean
 	 */
 	public function failedResample($filename, $manipulation) {
@@ -428,6 +429,10 @@ 
 			return $useAsMinimum ? $this->resizeByWidth( $maxWidth ) : $this->resizeByHeight( $maxHeight );
 	}
 
+	/**
+	 * @param resource $image
+	 * @param string $webColor
+	 */
 	public static function color_web2gd($image, $webColor, $transparencyPercent = 0) {
 		if(substr($webColor,0,1) == "#") $webColor = substr($webColor,1);
 		$r = hexdec(substr($webColor,0,2));
@@ -546,6 +551,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $dirname
+	 */
 	public function makeDir($dirname) {
 		if(!file_exists(dirname($dirname))) $this->makeDir(dirname($dirname));
 		if(!file_exists($dirname)) mkdir($dirname, Config::inst()->get('Filesystem', 'folder_create_mask'));