Day.php
2 years ago
Factory.php
3 months ago
Month.php
2 years ago
PeriodValidator.php
2 years ago
Range.php
3 months ago
Week.php
1 year ago
Year.php
2 years ago
Day.php
98 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 Exception; |
| 12 | use Piwik\Date; |
| 13 | use Piwik\Period; |
| 14 | /** |
| 15 | */ |
| 16 | class Day extends Period |
| 17 | { |
| 18 | public const PERIOD_ID = 1; |
| 19 | protected $label = 'day'; |
| 20 | /** |
| 21 | * Returns the day of the period as a string |
| 22 | * |
| 23 | * @return string |
| 24 | */ |
| 25 | public function getPrettyString() |
| 26 | { |
| 27 | $out = $this->getDateStart()->toString(); |
| 28 | return $out; |
| 29 | } |
| 30 | /** |
| 31 | * Returns the day of the period as a localized short string |
| 32 | * |
| 33 | * @return string |
| 34 | */ |
| 35 | public function getLocalizedShortString() |
| 36 | { |
| 37 | //"Mon 15 Aug" |
| 38 | $date = $this->getDateStart(); |
| 39 | $out = $date->getLocalized(Date::DATE_FORMAT_DAY_MONTH); |
| 40 | return $out; |
| 41 | } |
| 42 | /** |
| 43 | * Returns the day of the period as a localized long string |
| 44 | * |
| 45 | * @return string |
| 46 | */ |
| 47 | public function getLocalizedLongString() |
| 48 | { |
| 49 | //"Mon 15 Aug" |
| 50 | $date = $this->getDateStart(); |
| 51 | $out = $date->getLocalized(Date::DATE_FORMAT_LONG); |
| 52 | return $out; |
| 53 | } |
| 54 | /** |
| 55 | * Returns the number of subperiods |
| 56 | * Always 0, in that case |
| 57 | * |
| 58 | * @return int |
| 59 | */ |
| 60 | public function getNumberOfSubperiods() |
| 61 | { |
| 62 | return 0; |
| 63 | } |
| 64 | /** |
| 65 | * Adds a subperiod |
| 66 | * Not supported for day periods |
| 67 | * |
| 68 | * @param $date |
| 69 | * @throws Exception |
| 70 | */ |
| 71 | public function addSubperiod($date) |
| 72 | { |
| 73 | throw new Exception("Adding a subperiod is not supported for Day"); |
| 74 | } |
| 75 | /** |
| 76 | * Returns the day of the period in the given format |
| 77 | * |
| 78 | * @param string $format |
| 79 | * @return string |
| 80 | */ |
| 81 | public function toString($format = "Y-m-d") |
| 82 | { |
| 83 | return $this->date->toString($format); |
| 84 | } |
| 85 | public function __toString() |
| 86 | { |
| 87 | return $this->toString(); |
| 88 | } |
| 89 | public function getImmediateChildPeriodLabel() |
| 90 | { |
| 91 | return null; |
| 92 | } |
| 93 | public function getParentPeriodLabel() |
| 94 | { |
| 95 | return 'week'; |
| 96 | } |
| 97 | } |
| 98 |