Utilities > Date > update descriptions of methods

This commit is contained in:
Meritoo
2018-10-19 22:54:11 +02:00
parent 97c6112919
commit ca9c3bd8f1
2 changed files with 10 additions and 6 deletions

View File

@@ -5,6 +5,7 @@ Common and useful classes, methods, exceptions etc.
# 0.1.4 # 0.1.4
1. Phing > update configuration 1. Phing > update configuration
2. Utilities > Date > update descriptions of methods
# 0.1.3 # 0.1.3

View File

@@ -64,8 +64,7 @@ class Date
const DATE_DIFFERENCE_UNIT_YEARS = 'years'; const DATE_DIFFERENCE_UNIT_YEARS = 'years';
/** /**
* Returns start and end date for given period. * Returns date's period (that contains start and end date) for given period
* The dates are returned in an array with indexes 'start' and 'end'.
* *
* @param int $period The period, type of period. One of DatePeriod class constants, e.g. DatePeriod::LAST_WEEK. * @param int $period The period, type of period. One of DatePeriod class constants, e.g. DatePeriod::LAST_WEEK.
* @throws Exception * @throws Exception
@@ -531,11 +530,15 @@ class Date
/** /**
* Returns random date based on given start date * Returns random date based on given start date
* *
* @param DateTime $startDate The start date. Start of the random date. * @param DateTime $startDate (optional) Beginning of the random date. If not provided, current date will
* @param int $start (optional) Start of random partition * be used (default behaviour).
* @param int $end (optional) End of random partition * @param int $start (optional) Start of random partition. If not provided, 1 will be used
* (default behaviour).
* @param int $end (optional) End of random partition. If not provided, 100 will be used
* (default behaviour).
* @param string $intervalTemplate (optional) Template used to build date interval. The placeholder is replaced * @param string $intervalTemplate (optional) Template used to build date interval. The placeholder is replaced
* with next, iterated value. * with next, iterated value. If not provided, "P%sD" will be used (default
* behaviour).
* @throws Exception * @throws Exception
* @return DateTime * @return DateTime
*/ */