Day.php
2 months ago
Factory.php
2 weeks ago
Month.php
2 months ago
PeriodValidator.php
2 years ago
Range.php
2 months ago
Week.php
2 months ago
Year.php
2 weeks ago
Month.php
108 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Period; |
| 10 | |
| 11 | use Piwik\Date; |
| 12 | use Piwik\Period; |
| 13 | class Month extends Period |
| 14 | { |
| 15 | public const PERIOD_ID = 3; |
| 16 | protected $label = 'month'; |
| 17 | /** |
| 18 | * Returns the current period as a localized short string |
| 19 | * |
| 20 | * @return string |
| 21 | */ |
| 22 | public function getLocalizedShortString() |
| 23 | { |
| 24 | //"Aug 09" |
| 25 | $out = $this->getDateStart()->getLocalized(Date::DATE_FORMAT_MONTH_SHORT); |
| 26 | return $out; |
| 27 | } |
| 28 | /** |
| 29 | * Returns the current period as a localized long string |
| 30 | * |
| 31 | * @return string |
| 32 | */ |
| 33 | public function getLocalizedLongString() |
| 34 | { |
| 35 | //"August 2009" |
| 36 | $out = $this->getDateStart()->getLocalized(Date::DATE_FORMAT_MONTH_LONG); |
| 37 | return $out; |
| 38 | } |
| 39 | /** |
| 40 | * Returns the current period as a string |
| 41 | * |
| 42 | * @return string |
| 43 | */ |
| 44 | public function getPrettyString() |
| 45 | { |
| 46 | $out = $this->getDateStart()->toString('Y-m'); |
| 47 | return $out; |
| 48 | } |
| 49 | /** |
| 50 | * Generates the subperiods (one for each day in the month) |
| 51 | */ |
| 52 | protected function generate() |
| 53 | { |
| 54 | if ($this->subperiodsProcessed) { |
| 55 | return; |
| 56 | } |
| 57 | parent::generate(); |
| 58 | $date = $this->date; |
| 59 | $startMonth = $date->setDay(1)->setTime('00:00:00'); |
| 60 | $endMonth = $startMonth->addPeriod(1, 'month')->setDay(1)->subDay(1); |
| 61 | $this->processOptimalSubperiods($startMonth, $endMonth); |
| 62 | } |
| 63 | /** |
| 64 | * Determine which kind of period is best to use. |
| 65 | * See Range.test.php |
| 66 | * |
| 67 | * @param Date $startDate |
| 68 | * @param Date $endDate |
| 69 | */ |
| 70 | protected function processOptimalSubperiods($startDate, $endDate) |
| 71 | { |
| 72 | while ($startDate->isEarlier($endDate) || $startDate == $endDate) { |
| 73 | $week = new \Piwik\Period\Week($startDate); |
| 74 | $startOfWeek = $week->getDateStart(); |
| 75 | $endOfWeek = $week->getDateEnd(); |
| 76 | if ($endOfWeek->isLater($endDate)) { |
| 77 | $this->fillDayPeriods($startDate, $endDate); |
| 78 | } elseif ($startOfWeek == $startDate) { |
| 79 | $this->addSubperiod($week); |
| 80 | } else { |
| 81 | $this->fillDayPeriods($startDate, $endOfWeek); |
| 82 | } |
| 83 | $startDate = $endOfWeek->addDay(1); |
| 84 | } |
| 85 | } |
| 86 | /** |
| 87 | * Fills the periods from startDate to endDate with days |
| 88 | * |
| 89 | * @param Date $startDate |
| 90 | * @param Date $endDate |
| 91 | */ |
| 92 | private function fillDayPeriods($startDate, $endDate) |
| 93 | { |
| 94 | while ($startDate->isEarlier($endDate) || $startDate == $endDate) { |
| 95 | $this->addSubperiod(new \Piwik\Period\Day($startDate)); |
| 96 | $startDate = $startDate->addDay(1); |
| 97 | } |
| 98 | } |
| 99 | public function getImmediateChildPeriodLabel() |
| 100 | { |
| 101 | return 'week'; |
| 102 | } |
| 103 | public function getParentPeriodLabel() |
| 104 | { |
| 105 | return 'year'; |
| 106 | } |
| 107 | } |
| 108 |