Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordiosmosis <benakamoorthi@fastmail.fm>2013-12-08 22:12:48 +0400
committerdiosmosis <benakamoorthi@fastmail.fm>2013-12-08 22:13:07 +0400
commit13297a804c38999aa790af93f1d599e3c809dc7d (patch)
treecdf7cb0b4df018853852a1af675041cd23944293 /core/Period/Range.php
parent54bb5200d2567e51ff5a77dcd4dfa89195c169d9 (diff)
Fixes #4200, revised rest of @api classes/methods, closing ticket.
Diffstat (limited to 'core/Period/Range.php')
-rw-r--r--core/Period/Range.php20
1 files changed, 10 insertions, 10 deletions
diff --git a/core/Period/Range.php b/core/Period/Range.php
index 722de00c83..91cf5de435 100644
--- a/core/Period/Range.php
+++ b/core/Period/Range.php
@@ -25,7 +25,7 @@ use Piwik\Piwik;
* date=2007-07-24,2013-11-15).
*
* The range period differs from other periods mainly in that since it is arbitrary,
- * range periods are not archived by the archive.php cron script.
+ * range periods are not pre-archived by the **archive.php** cron script.
*
* @package Piwik
* @subpackage Period
@@ -86,7 +86,7 @@ class Range extends Period
}
/**
- * Returns the start date of the period
+ * Returns the start date of the period.
*
* @return Date
* @throws Exception
@@ -101,7 +101,7 @@ class Range extends Period
}
/**
- * Returns the current period as a string
+ * Returns the current period as a string.
*
* @return string
*/
@@ -134,7 +134,7 @@ class Range extends Period
}
/**
- * Sets the default end date of the period
+ * Sets the default end date of the period.
*
* @param Date $oDate
*/
@@ -218,11 +218,11 @@ class Range extends Period
}
/**
- * Given a date string, returns false if not a date range,
- * or returns the array containing date start, date end
+ * Given a date string, returns `false` if not a date range,
+ * or returns the array containing start and end dates.
*
* @param string $dateString
- * @return mixed array(1 => dateStartString, 2 => dateEndString ) or false if the input was not a date range
+ * @return mixed array(1 => dateStartString, 2 => dateEndString) or `false` if the input was not a date range.
*/
static public function parseDateRange($dateString)
{
@@ -236,7 +236,7 @@ class Range extends Period
protected $endDate = null;
/**
- * Returns the end date of the period
+ * Returns the end date of the period.
*
* @return null|Date
*/
@@ -249,7 +249,7 @@ class Range extends Period
}
/**
- * Determine which kind of period is best to use
+ * Determine which kind of period is best to use.
* See Range.test.php
*
* @param Date $startDate
@@ -400,7 +400,7 @@ class Range extends Period
}
/**
- * Returns a date ragne string given a period type, end date and number of periods
+ * Returns a date range string given a period type, end date and number of periods
* the range spans over.
*
* @param string $period The sub period type, `'day'`, `'week'`, `'month'` and `'year'`.