silverstripe / silverstripe-framework

forms/HtmlEditorField.php

Doc Comments +10 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
 	 */
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -169,6 +169,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -197,7 +201,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -563,7 +567,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -607,6 +611,7 @@ 
 	 * not the "master record" in the database - hence there's no form or saving logic.
 	 *
 	 * @param String Relative or absolute URL to file
+	 * @param HtmlEditorField_File $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForFile($url, $file) {
@@ -628,6 +633,7 @@ 
 	}
 
 	/**
+	 * @param HtmlEditorField_Embed $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForOembed($url, $file) {
@@ -837,6 +843,7 @@ 
 
 	/**
 	 * @param Int
+	 * @param integer $parentID
 	 * @return DataList
 	 */
 	protected function getFiles($parentID = null) {

forms/PhoneNumberField.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function joinPhoneNumber( $value ) {
 		if( is_array( $value ) ) {
 			$completeNumber = '';

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

model/Image.php

Doc Comments +4 added lines, -4 removed lines

@@ -589,7 +589,7 @@ 
 	/**
 	 * Resize this image for the CMS. Use in templates with $CMSThumbnail
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function CMSThumbnail() {
 		return $this->Pad($this->stat('cms_thumbnail_width'),$this->stat('cms_thumbnail_height'));
@@ -631,7 +631,7 @@ 
 	/**
 	 * Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function StripThumbnail() {
 		return $this->Fill($this->stat('strip_thumbnail_width'),$this->stat('strip_thumbnail_height'));
@@ -868,7 +868,7 @@ 
 	/**
 	 * Generate patterns that will help to match filenames of cached images
 	 * @param string $filename Filename of source image
-	 * @return array
+	 * @return string
 	 */
 	private function getFilenamePatterns($filename) {
 		$methodNames = $this->allMethodNames(true);
@@ -1024,7 +1024,7 @@ 
 
 	/**
 	 * Get the orientation of this image.
-	 * @return ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
+	 * @return integer | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
 	 */
 	public function getOrientation() {
 		$width = $this->getWidth();

oembed/Oembed.php

Doc Comments +6 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 	 *
 	 * @param $url Human-readable URL.
 	 * @returns string/bool URL of an endpoint, or false if no matching provider exists.
+	 * @return string
 	 */
 	protected static function find_endpoint($url) {
 		foreach(self::get_providers() as $scheme=>$endpoint) {
@@ -117,7 +118,7 @@ 
 	 * Given a response body, determine if there is an autodiscover url
 	 *
 	 * @param string $body
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function autodiscover_from_body($body) {
 		// Look within the body for an oembed link.
@@ -259,6 +260,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getOembedURL() {
 		return $this->url;
 	}
@@ -343,6 +347,7 @@ 
 
 	/**
 	 * Wrap the check for looking into Oembed JSON within $this->data.
+	 * @param string $field
 	 */
 	public function hasField($field) {
 		$this->loadData();

thirdparty/Zend/Cache/Backend/Xcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
      * @param  string $mode clean mode
      * @param  array  $tags array of tags
      * @throws Zend_Cache_Exception
-     * @return boolean true if no problem
+     * @return boolean|null true if no problem
      */
     public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
     {

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