Day.php
6 years ago
Factory.php
6 years ago
Month.php
6 years ago
PeriodValidator.php
6 years ago
Range.php
6 years ago
Week.php
6 years ago
Year.php
6 years ago
Year.php
103 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Piwik - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * |
| 8 | */ |
| 9 | namespace Piwik\Period; |
| 10 | |
| 11 | use Piwik\Date; |
| 12 | use Piwik\Period; |
| 13 | |
| 14 | /** |
| 15 | */ |
| 16 | class Year extends Period |
| 17 | { |
| 18 | const PERIOD_ID = 4; |
| 19 | |
| 20 | protected $label = 'year'; |
| 21 | |
| 22 | /** |
| 23 | * Returns the current period as a localized short string |
| 24 | * |
| 25 | * @return string |
| 26 | */ |
| 27 | public function getLocalizedShortString() |
| 28 | { |
| 29 | return $this->getLocalizedLongString(); |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Returns the current period as a localized long string |
| 34 | * |
| 35 | * @return string |
| 36 | */ |
| 37 | public function getLocalizedLongString() |
| 38 | { |
| 39 | //"2009" |
| 40 | $out = $this->getDateStart()->getLocalized(Date::DATE_FORMAT_YEAR); |
| 41 | return $out; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Returns the current period as a string |
| 46 | * |
| 47 | * @return string |
| 48 | */ |
| 49 | public function getPrettyString() |
| 50 | { |
| 51 | $out = $this->getDateStart()->toString('Y'); |
| 52 | return $out; |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Generates the subperiods (one for each month of the year) |
| 57 | */ |
| 58 | protected function generate() |
| 59 | { |
| 60 | if ($this->subperiodsProcessed) { |
| 61 | return; |
| 62 | } |
| 63 | |
| 64 | parent::generate(); |
| 65 | |
| 66 | $year = $this->date->toString("Y"); |
| 67 | for ($i = 1; $i <= 12; $i++) { |
| 68 | $this->addSubperiod(new Month( |
| 69 | Date::factory("$year-$i-01") |
| 70 | ) |
| 71 | ); |
| 72 | } |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Returns the current period as a string |
| 77 | * |
| 78 | * @param string $format |
| 79 | * @return array |
| 80 | */ |
| 81 | public function toString($format = 'ignored') |
| 82 | { |
| 83 | $this->generate(); |
| 84 | |
| 85 | $stringMonth = array(); |
| 86 | foreach ($this->subperiods as $month) { |
| 87 | $stringMonth[] = $month->getDateStart()->toString("Y") . "-" . $month->getDateStart()->toString("m") . "-01"; |
| 88 | } |
| 89 | |
| 90 | return $stringMonth; |
| 91 | } |
| 92 | |
| 93 | public function getImmediateChildPeriodLabel() |
| 94 | { |
| 95 | return 'month'; |
| 96 | } |
| 97 | |
| 98 | public function getParentPeriodLabel() |
| 99 | { |
| 100 | return null; |
| 101 | } |
| 102 | } |
| 103 |