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

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

security/Security.php

Doc Comments +4 added lines, -5 removed lines

@@ -466,7 +466,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -646,7 +646,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken = urldecode($autologinToken);
@@ -737,7 +736,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -921,7 +920,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1076,7 +1075,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

model/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -764,7 +764,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -838,7 +838,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -904,7 +904,7 @@ 
 	/**
 	 * Get the latest published version of this object.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1028,7 +1028,7 @@ 
 	 * @param string $limit
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1042,7 +1042,7 @@ 
 	 * @param  string $limit
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param  string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1360,7 +1360,7 @@ 
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|int $limit          A limit on the number of records returned from the database.
+	 * @param integer $limit          A limit on the number of records returned from the database.
 	 * @param string     $containerClass The container class for the result set (default is DataList)
 	 *
 	 * @return DataList A modified DataList designated to the specified stage

email/Email.php

Doc Comments +10 added lines, -2 removed lines

@@ -197,6 +197,10 @@ 
 		Deprecation::notice('4.0', 'Use "emailbouncehandler" module');
 	}
 
+	/**
+	 * @param string $filename
+	 * @param string $mimetype
+	 */
 	public function attachFile($filename, $attachedFilename = null, $mimetype = null) {
 		if(!$attachedFilename) $attachedFilename = basename($filename);
 		$absoluteFileName = Director::getAbsFile($filename);
@@ -372,6 +376,9 @@ 
 		return $this->ss_template;
 	}
 
+	/**
+	 * @return ViewableData
+	 */
 	protected function templateData() {
 		if($this->template_data) {
 			return $this->template_data->customise(array(
@@ -454,6 +461,7 @@ 
 
 	/**
 	 * Validates the email address. Returns true of false
+	 * @param string $address
 	 * @return mixed
 	 */
 	public static function validEmailAddress($address) {
@@ -676,8 +684,8 @@ 
 	/**
 	 * Checks for RFC822-valid email format.
 	 *
-	 * @param string $str
-	 * @return boolean
+	 * @param string $email
+	 * @return integer
 	 *
 	 * @copyright Cal Henderson <cal@iamcal.com>
 	 * 	This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License

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