Permalink
Browse files

Tweak docblocks

  • Loading branch information...
1 parent ebf3049 commit a96de9938867175207ea9df98788172d93884092 @ADmad ADmad committed Apr 17, 2012
Showing with 17 additions and 17 deletions.
  1. +17 −17 lib/Cake/Utility/CakeTime.php
@@ -228,7 +228,7 @@ public static function serverOffset() {
* Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
*
* @param string $dateString Datetime string
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Parsed timestamp
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -263,7 +263,7 @@ public static function fromString($dateString, $timezone = null) {
* using locale strings.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @param string $format The format to use. If null, `TimeHelper::$niceFormat` is used
* @return string Formatted date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
@@ -290,7 +290,7 @@ public static function nice($dateString = null, $timezone = null, $format = null
* include mention of the year.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Described, relative date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -317,7 +317,7 @@ public static function niceShort($dateString = null, $timezone = null) {
* @param string $begin Datetime string or Unix timestamp
* @param string $end Datetime string or Unix timestamp
* @param string $fieldName Name of database field to compare with
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Partial SQL string.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -336,7 +336,7 @@ public static function daysAsSql($begin, $end, $fieldName, $timezone = null) {
*
* @param string $dateString Datetime string or Unix timestamp
* @param string $fieldName Name of database field to compare with
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Partial SQL string.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -348,7 +348,7 @@ public static function dayAsSql($dateString, $fieldName, $timezone = null) {
* Returns true if given datetime string is today.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string is today
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -361,7 +361,7 @@ public static function isToday($dateString, $timezone = null) {
* Returns true if given datetime string is within this week.
*
* @param string $dateString
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string is within current week
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -373,7 +373,7 @@ public static function isThisWeek($dateString, $timezone = null) {
/**
* Returns true if given datetime string is within this month
* @param string $dateString
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string is within current month
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -386,7 +386,7 @@ public static function isThisMonth($dateString, $timezone = null) {
* Returns true if given datetime string is within current year.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string is within current year
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -399,7 +399,7 @@ public static function isThisYear($dateString, $timezone = null) {
* Returns true if given datetime string was yesterday.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string was yesterday
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*
@@ -413,7 +413,7 @@ public static function wasYesterday($dateString, $timezone = null) {
* Returns true if given datetime string is tomorrow.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean True if datetime string was yesterday
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -463,7 +463,7 @@ public static function toQuarter($dateString, $range = false) {
* Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().
*
* @param string $dateString Datetime string to be represented as a Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return integer Unix timestamp
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -475,7 +475,7 @@ public static function toUnix($dateString, $timezone = null) {
* Returns a date formatted for Atom RSS feeds.
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Formatted date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -488,7 +488,7 @@ public static function toAtom($dateString, $timezone = null) {
* Formats date for RSS feeds
*
* @param string $dateString Datetime string or Unix timestamp
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Formatted date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -703,7 +703,7 @@ public static function timeAgoInWords($dateTime, $options = array()) {
* @param mixed $timeInterval the numeric value with space then time type.
* Example of valid types: 6 hours, 2 days, 1 minute.
* @param mixed $dateString the datestring or unix timestamp to compare
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return boolean
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time
*/
@@ -754,7 +754,7 @@ public static function gmt($string = null) {
* @param string $format date format string (or a DateTime string)
* @param string $date Datetime string (or a date format string)
* @param boolean $invalid flag to ignore results of fromString == false
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Formatted date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/
@@ -779,7 +779,7 @@ public static function format($format, $date = null, $invalid = false, $timezone
* @param string $date Datetime string
* @param string $format strftime format string.
* @param boolean $invalid flag to ignore results of fromString == false
- * @param mixed $timezone Timezone string or DateTimezone object
+ * @param mixed $timezone Timezone string or DateTimeZone object
* @return string Formatted and translated date string
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
*/

0 comments on commit a96de99

Please sign in to comment.