@@ -7,27 +7,27 @@ |
||
| 7 | 7 | |
| 8 | 8 | class DatedUpdateHolderControllerTest extends FunctionalTest |
| 9 | 9 | { |
| 10 | - protected static $fixture_file = 'EventHolderTest.yml'; |
|
| 10 | + protected static $fixture_file = 'EventHolderTest.yml'; |
|
| 11 | 11 | |
| 12 | - protected static $use_draft_site = true; |
|
| 12 | + protected static $use_draft_site = true; |
|
| 13 | 13 | |
| 14 | - public function testSettingDateFiltersInReverseOrderShowsMessage() |
|
| 15 | - { |
|
| 16 | - /** @var EventHolder $holder */ |
|
| 17 | - $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 14 | + public function testSettingDateFiltersInReverseOrderShowsMessage() |
|
| 15 | + { |
|
| 16 | + /** @var EventHolder $holder */ |
|
| 17 | + $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 18 | 18 | |
| 19 | - $result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01'); |
|
| 19 | + $result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01'); |
|
| 20 | 20 | |
| 21 | - $this->assertContains('Filter has been applied with the dates reversed', $result->getBody()); |
|
| 22 | - } |
|
| 21 | + $this->assertContains('Filter has been applied with the dates reversed', $result->getBody()); |
|
| 22 | + } |
|
| 23 | 23 | |
| 24 | - public function testSettingFromButNotToDateShowsMessage() |
|
| 25 | - { |
|
| 26 | - /** @var EventHolder $holder */ |
|
| 27 | - $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 24 | + public function testSettingFromButNotToDateShowsMessage() |
|
| 25 | + { |
|
| 26 | + /** @var EventHolder $holder */ |
|
| 27 | + $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 28 | 28 | |
| 29 | - $result = $this->get($holder->Link() . '?from=2018-01-10'); |
|
| 29 | + $result = $this->get($holder->Link() . '?from=2018-01-10'); |
|
| 30 | 30 | |
| 31 | - $this->assertContains('Filtered by a single date', $result->getBody()); |
|
| 32 | - } |
|
| 31 | + $this->assertContains('Filtered by a single date', $result->getBody()); |
|
| 32 | + } |
|
| 33 | 33 | } |
@@ -19,53 +19,53 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | class EventHolderController extends DatedUpdateHolderController |
| 21 | 21 | { |
| 22 | - public function getUpdateName() |
|
| 23 | - { |
|
| 24 | - $params = $this->parseParams(); |
|
| 25 | - if ($params['upcomingOnly']) { |
|
| 26 | - return _t(__CLASS__ . '.Upcoming', 'Upcoming events'); |
|
| 27 | - } |
|
| 22 | + public function getUpdateName() |
|
| 23 | + { |
|
| 24 | + $params = $this->parseParams(); |
|
| 25 | + if ($params['upcomingOnly']) { |
|
| 26 | + return _t(__CLASS__ . '.Upcoming', 'Upcoming events'); |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | - return _t(__CLASS__ . '.Events', 'Events'); |
|
| 30 | - } |
|
| 29 | + return _t(__CLASS__ . '.Events', 'Events'); |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Parse URL parameters. |
|
| 34 | - * |
|
| 35 | - * @param boolean $produceErrorMessages Set to false to omit session messages. |
|
| 36 | - */ |
|
| 37 | - public function parseParams($produceErrorMessages = true) |
|
| 38 | - { |
|
| 39 | - $params = parent::parseParams($produceErrorMessages); |
|
| 32 | + /** |
|
| 33 | + * Parse URL parameters. |
|
| 34 | + * |
|
| 35 | + * @param boolean $produceErrorMessages Set to false to omit session messages. |
|
| 36 | + */ |
|
| 37 | + public function parseParams($produceErrorMessages = true) |
|
| 38 | + { |
|
| 39 | + $params = parent::parseParams($produceErrorMessages); |
|
| 40 | 40 | |
| 41 | - // We need to set whether or not we're supposed to be displaying only upcoming events or all events. |
|
| 42 | - $params['upcomingOnly'] = !($params['from'] || $params['to'] || $params['year'] || $params['month']); |
|
| 41 | + // We need to set whether or not we're supposed to be displaying only upcoming events or all events. |
|
| 42 | + $params['upcomingOnly'] = !($params['from'] || $params['to'] || $params['year'] || $params['month']); |
|
| 43 | 43 | |
| 44 | - return $params; |
|
| 45 | - } |
|
| 44 | + return $params; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Get the events based on the current query. |
|
| 49 | - */ |
|
| 50 | - public function FilteredUpdates($pageSize = 20) |
|
| 51 | - { |
|
| 52 | - $params = $this->parseParams(); |
|
| 47 | + /** |
|
| 48 | + * Get the events based on the current query. |
|
| 49 | + */ |
|
| 50 | + public function FilteredUpdates($pageSize = 20) |
|
| 51 | + { |
|
| 52 | + $params = $this->parseParams(); |
|
| 53 | 53 | |
| 54 | - $items = $this->Updates( |
|
| 55 | - $params['tag'], |
|
| 56 | - $params['from'], |
|
| 57 | - $params['to'], |
|
| 58 | - $params['year'], |
|
| 59 | - $params['month'] |
|
| 60 | - ); |
|
| 54 | + $items = $this->Updates( |
|
| 55 | + $params['tag'], |
|
| 56 | + $params['from'], |
|
| 57 | + $params['to'], |
|
| 58 | + $params['year'], |
|
| 59 | + $params['month'] |
|
| 60 | + ); |
|
| 61 | 61 | |
| 62 | - if ($params['upcomingOnly']) { |
|
| 63 | - $items = $items->filter(['Date:LessThan:Not' => DBDatetime::now()->Format('y-MM-dd')]); |
|
| 64 | - } |
|
| 62 | + if ($params['upcomingOnly']) { |
|
| 63 | + $items = $items->filter(['Date:LessThan:Not' => DBDatetime::now()->Format('y-MM-dd')]); |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - // Apply pagination |
|
| 67 | - $list = PaginatedList::create($items, $this->getRequest()); |
|
| 68 | - $list->setPageLength($pageSize); |
|
| 69 | - return $list; |
|
| 70 | - } |
|
| 66 | + // Apply pagination |
|
| 67 | + $list = PaginatedList::create($items, $this->getRequest()); |
|
| 68 | + $list->setPageLength($pageSize); |
|
| 69 | + return $list; |
|
| 70 | + } |
|
| 71 | 71 | } |
@@ -34,360 +34,360 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | class DatedUpdateHolderController extends PageController |
| 36 | 36 | { |
| 37 | - private static $allowed_actions = [ |
|
| 38 | - 'rss', |
|
| 39 | - 'atom', |
|
| 40 | - 'DateRangeForm', |
|
| 41 | - ]; |
|
| 42 | - |
|
| 43 | - private static $casting = [ |
|
| 44 | - 'MetaTitle' => 'Text', |
|
| 45 | - 'FilterDescription' => 'Text', |
|
| 46 | - ]; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * The session key for storing temporary form messages |
|
| 50 | - * |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 53 | - const TEMP_FORM_MESSAGE = __CLASS__ . '.TempFormMessage'; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * Get the meta title for the current action |
|
| 57 | - * |
|
| 58 | - * @return string |
|
| 59 | - */ |
|
| 60 | - public function getMetaTitle() |
|
| 61 | - { |
|
| 62 | - $title = $this->data()->getTitle(); |
|
| 63 | - $filter = $this->FilterDescription(); |
|
| 64 | - if ($filter) { |
|
| 65 | - $title = "{$title} - {$filter}"; |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $this->extend('updateMetaTitle', $title); |
|
| 69 | - return $title; |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * Returns a description of the current filter |
|
| 74 | - * |
|
| 75 | - * @return string |
|
| 76 | - */ |
|
| 77 | - public function FilterDescription() |
|
| 78 | - { |
|
| 79 | - $params = $this->parseParams(); |
|
| 80 | - |
|
| 81 | - $filters = array(); |
|
| 82 | - if ($params['tag']) { |
|
| 83 | - $term = TaxonomyTerm::get_by_id(TaxonomyTerm::class, $params['tag']); |
|
| 84 | - if ($term) { |
|
| 85 | - $filters[] = _t( |
|
| 86 | - 'CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_WITHIN', |
|
| 87 | - 'within' |
|
| 88 | - ) . ' "' . $term->Name . '"'; |
|
| 89 | - } |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - if ($params['from'] || $params['to']) { |
|
| 93 | - if ($params['from']) { |
|
| 94 | - $from = strtotime($params['from']); |
|
| 95 | - if ($params['to']) { |
|
| 96 | - $to = strtotime($params['to']); |
|
| 97 | - $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_BETWEEN', 'between') . ' ' |
|
| 98 | - . date('j/m/Y', $from) . ' and ' . date('j/m/Y', $to); |
|
| 99 | - } else { |
|
| 100 | - $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on') |
|
| 101 | - . ' ' . date('j/m/Y', $from); |
|
| 102 | - } |
|
| 103 | - } else { |
|
| 104 | - $to = strtotime($params['to']); |
|
| 105 | - $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on') |
|
| 106 | - . ' ' . date('j/m/Y', $to); |
|
| 107 | - } |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - if ($params['year'] && $params['month']) { |
|
| 111 | - $timestamp = mktime(1, 1, 1, $params['month'], 1, $params['year']); |
|
| 112 | - $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_IN', 'in') |
|
| 113 | - . ' ' . date('F', $timestamp) . ' ' . $params['year']; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - if ($filters) { |
|
| 117 | - return $this->getUpdateName() . ' ' . implode(' ', $filters); |
|
| 118 | - } |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - public function getUpdateName() |
|
| 122 | - { |
|
| 123 | - return Config::inst()->get($this->data()->ClassName, 'update_name'); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - protected function init() |
|
| 127 | - { |
|
| 128 | - parent::init(); |
|
| 129 | - RSSFeed::linkToFeed($this->Link() . 'rss', $this->getSubscriptionTitle()); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Parse URL parameters. |
|
| 134 | - * |
|
| 135 | - * @param bool $produceErrorMessages Set to false to omit session messages. |
|
| 136 | - */ |
|
| 137 | - public function parseParams($produceErrorMessages = true) |
|
| 138 | - { |
|
| 139 | - $tag = $this->request->getVar('tag'); |
|
| 140 | - $from = $this->request->getVar('from'); |
|
| 141 | - $to = $this->request->getVar('to'); |
|
| 142 | - $year = $this->request->getVar('year'); |
|
| 143 | - $month = $this->request->getVar('month'); |
|
| 144 | - |
|
| 145 | - if ($tag == '') { |
|
| 146 | - $tag = null; |
|
| 147 | - } |
|
| 148 | - if ($from == '') { |
|
| 149 | - $from = null; |
|
| 150 | - } |
|
| 151 | - if ($to == '') { |
|
| 152 | - $to = null; |
|
| 153 | - } |
|
| 154 | - if ($year == '') { |
|
| 155 | - $year = null; |
|
| 156 | - } |
|
| 157 | - if ($month == '') { |
|
| 158 | - $month = null; |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - if (isset($tag)) { |
|
| 162 | - $tag = (int)$tag; |
|
| 163 | - } |
|
| 164 | - if (isset($from)) { |
|
| 165 | - $from = urldecode($from); |
|
| 166 | - $parser = DBDatetime::create(); |
|
| 167 | - $parser->setValue($from); |
|
| 168 | - $from = $parser->Format('y-MM-dd'); |
|
| 169 | - } |
|
| 170 | - if (isset($to)) { |
|
| 171 | - $to = urldecode($to); |
|
| 172 | - $parser = DBDatetime::create(); |
|
| 173 | - $parser->setValue($to); |
|
| 174 | - $to = $parser->Format('y-MM-dd'); |
|
| 175 | - } |
|
| 176 | - if (isset($year)) { |
|
| 177 | - $year = (int)$year; |
|
| 178 | - } |
|
| 179 | - if (isset($month)) { |
|
| 180 | - $month = (int)$month; |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - // If only "To" has been provided filter by single date. Normalise by swapping with "From". |
|
| 184 | - if (isset($to) && !isset($from)) { |
|
| 185 | - list($to, $from) = [$from, $to]; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - // Flip the dates if the order is wrong. |
|
| 189 | - if (isset($to) && isset($from) && strtotime($from) > strtotime($to)) { |
|
| 190 | - list($to, $from) = [$from, $to]; |
|
| 191 | - |
|
| 192 | - if ($produceErrorMessages) { |
|
| 193 | - $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t( |
|
| 194 | - __CLASS__ . '.FilterAppliedMessage', |
|
| 195 | - 'Filter has been applied with the dates reversed.' |
|
| 196 | - )); |
|
| 197 | - } |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - // Notify the user that filtering by single date is taking place. |
|
| 201 | - if (isset($from) && !isset($to)) { |
|
| 202 | - if ($produceErrorMessages) { |
|
| 203 | - $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t( |
|
| 204 | - __CLASS__ . '.DateRangeFilterMessage', 'Filtered by a single date.' |
|
| 205 | - )); |
|
| 206 | - } |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - return [ |
|
| 210 | - 'tag' => $tag, |
|
| 211 | - 'from' => $from, |
|
| 212 | - 'to' => $to, |
|
| 213 | - 'year' => $year, |
|
| 214 | - 'month' => $month, |
|
| 215 | - ]; |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Build the link - keep the date range, reset the rest. |
|
| 220 | - */ |
|
| 221 | - public function AllTagsLink() |
|
| 222 | - { |
|
| 223 | - $link = HTTP::setGetVar('tag', null, null, '&'); |
|
| 224 | - $link = HTTP::setGetVar('month', null, $link, '&'); |
|
| 225 | - $link = HTTP::setGetVar('year', null, $link, '&'); |
|
| 226 | - $link = HTTP::setGetVar('start', null, $link, '&'); |
|
| 227 | - |
|
| 228 | - return $link; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * List tags and attach links. |
|
| 233 | - */ |
|
| 234 | - public function UpdateTagsWithLinks() |
|
| 235 | - { |
|
| 236 | - $tags = $this->UpdateTags(); |
|
| 237 | - |
|
| 238 | - $processed = ArrayList::create(); |
|
| 239 | - |
|
| 240 | - foreach ($tags as $tag) { |
|
| 241 | - // Build the link - keep the tag, and date range, but reset month, year and pagination. |
|
| 242 | - $link = HTTP::setGetVar('tag', $tag->ID, null, '&'); |
|
| 243 | - $link = HTTP::setGetVar('month', null, $link, '&'); |
|
| 244 | - $link = HTTP::setGetVar('year', null, $link, '&'); |
|
| 245 | - $link = HTTP::setGetVar('start', null, $link, '&'); |
|
| 246 | - |
|
| 247 | - $tag->Link = $link; |
|
| 248 | - $processed->push($tag); |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - return $processed; |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - /** |
|
| 255 | - * Get the TaxonomyTerm related to the current tag GET parameter. |
|
| 256 | - */ |
|
| 257 | - public function CurrentTag() |
|
| 258 | - { |
|
| 259 | - $tagID = $this->request->getVar('tag'); |
|
| 260 | - |
|
| 261 | - if (isset($tagID)) { |
|
| 262 | - return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID); |
|
| 263 | - } |
|
| 264 | - } |
|
| 265 | - |
|
| 266 | - /** |
|
| 267 | - * Extract the available months based on the current query. |
|
| 268 | - * Only tag is respected. Pagination and months are ignored. |
|
| 269 | - */ |
|
| 270 | - public function AvailableMonths() |
|
| 271 | - { |
|
| 272 | - $params = $this->parseParams(); |
|
| 273 | - |
|
| 274 | - return DatedUpdateHolder::ExtractMonths( |
|
| 275 | - $this->Updates($params['tag'], $params['from'], $params['to']), |
|
| 276 | - Director::makeRelative($_SERVER['REQUEST_URI']), |
|
| 277 | - $params['year'], |
|
| 278 | - $params['month'] |
|
| 279 | - ); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /** |
|
| 283 | - * Get the updates based on the current query. |
|
| 284 | - */ |
|
| 285 | - public function FilteredUpdates($pageSize = 20) |
|
| 286 | - { |
|
| 287 | - $params = $this->parseParams(); |
|
| 288 | - |
|
| 289 | - $items = $this->Updates( |
|
| 290 | - $params['tag'], |
|
| 291 | - $params['from'], |
|
| 292 | - $params['to'], |
|
| 293 | - $params['year'], |
|
| 294 | - $params['month'] |
|
| 295 | - ); |
|
| 296 | - |
|
| 297 | - // Apply pagination |
|
| 298 | - $list = PaginatedList::create($items, $this->getRequest()); |
|
| 299 | - $list->setPageLength($pageSize); |
|
| 300 | - return $list; |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - /** |
|
| 304 | - * @return Form |
|
| 305 | - */ |
|
| 306 | - public function DateRangeForm() |
|
| 307 | - { |
|
| 308 | - $dateFromTitle = DBField::create_field('HTMLText', sprintf( |
|
| 309 | - '%s <span class="field-note">%s</span>', |
|
| 310 | - _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FROM_DATE', 'From date'), |
|
| 311 | - _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 2017/12/30)') |
|
| 312 | - )); |
|
| 313 | - $dateToTitle = DBField::create_field('HTMLText', sprintf( |
|
| 314 | - '%s <span class="field-note">%s</span>', |
|
| 315 | - _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.TO_DATE', 'To date'), |
|
| 316 | - _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 2017/12/30)') |
|
| 317 | - )); |
|
| 318 | - |
|
| 319 | - $fields = FieldList::create( |
|
| 320 | - DateField::create('from', $dateFromTitle), |
|
| 321 | - DateField::create('to', $dateToTitle), |
|
| 322 | - HiddenField::create('tag') |
|
| 323 | - ); |
|
| 324 | - |
|
| 325 | - $actions = FieldList::create( |
|
| 326 | - FormAction::create("doDateFilter") |
|
| 327 | - ->setTitle(_t(__CLASS__ . '.Filter', 'Filter')) |
|
| 328 | - ->addExtraClass('btn btn-primary primary'), |
|
| 329 | - FormAction::create("doDateReset") |
|
| 330 | - ->setTitle(_t(__CLASS__ . '.Clear', 'Clear')) |
|
| 331 | - ->addExtraClass('btn') |
|
| 332 | - ); |
|
| 333 | - |
|
| 334 | - $form = Form::create($this, 'DateRangeForm', $fields, $actions); |
|
| 335 | - $form->loadDataFrom($this->request->getVars()); |
|
| 336 | - $form->setFormMethod('get'); |
|
| 337 | - |
|
| 338 | - // Add any locally stored form messages before returning |
|
| 339 | - if ($formMessage = $this->getRequest()->getSession()->get(self::TEMP_FORM_MESSAGE)) { |
|
| 340 | - $form->setMessage($formMessage, ValidationResult::TYPE_WARNING); |
|
| 341 | - $this->getRequest()->getSession()->clear(self::TEMP_FORM_MESSAGE); |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - return $form; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - public function doDateFilter() |
|
| 348 | - { |
|
| 349 | - $params = $this->parseParams(); |
|
| 350 | - |
|
| 351 | - // Build the link - keep the tag, but reset month, year and pagination. |
|
| 352 | - $link = HTTP::setGetVar('from', $params['from'], $this->AbsoluteLink(), '&'); |
|
| 353 | - $link = HTTP::setGetVar('to', $params['to'], $link, '&'); |
|
| 354 | - if (isset($params['tag'])) { |
|
| 355 | - $link = HTTP::setGetVar('tag', $params['tag'], $link, '&'); |
|
| 356 | - } |
|
| 357 | - |
|
| 358 | - $this->redirect($link); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - public function doDateReset() |
|
| 362 | - { |
|
| 363 | - $params = $this->parseParams(false); |
|
| 364 | - |
|
| 365 | - // Reset the link - only include the tag. |
|
| 366 | - $link = $this->AbsoluteLink(); |
|
| 367 | - if (isset($params['tag'])) { |
|
| 368 | - $link = HTTP::setGetVar('tag', $params['tag'], $link, '&'); |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - $this->redirect($link); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - public function rss() |
|
| 375 | - { |
|
| 376 | - $rss = RSSFeed::create( |
|
| 377 | - $this->Updates()->sort('Created DESC')->limit(20), |
|
| 378 | - $this->Link('rss'), |
|
| 379 | - $this->getSubscriptionTitle() |
|
| 380 | - ); |
|
| 381 | - return $rss->outputToBrowser(); |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - public function atom() |
|
| 385 | - { |
|
| 386 | - $atom = CwpAtomFeed::create( |
|
| 387 | - $this->Updates()->sort('Created DESC')->limit(20), |
|
| 388 | - $this->Link('atom'), |
|
| 389 | - $this->getSubscriptionTitle() |
|
| 390 | - ); |
|
| 391 | - return $atom->outputToBrowser(); |
|
| 392 | - } |
|
| 37 | + private static $allowed_actions = [ |
|
| 38 | + 'rss', |
|
| 39 | + 'atom', |
|
| 40 | + 'DateRangeForm', |
|
| 41 | + ]; |
|
| 42 | + |
|
| 43 | + private static $casting = [ |
|
| 44 | + 'MetaTitle' => 'Text', |
|
| 45 | + 'FilterDescription' => 'Text', |
|
| 46 | + ]; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * The session key for storing temporary form messages |
|
| 50 | + * |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | + const TEMP_FORM_MESSAGE = __CLASS__ . '.TempFormMessage'; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * Get the meta title for the current action |
|
| 57 | + * |
|
| 58 | + * @return string |
|
| 59 | + */ |
|
| 60 | + public function getMetaTitle() |
|
| 61 | + { |
|
| 62 | + $title = $this->data()->getTitle(); |
|
| 63 | + $filter = $this->FilterDescription(); |
|
| 64 | + if ($filter) { |
|
| 65 | + $title = "{$title} - {$filter}"; |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $this->extend('updateMetaTitle', $title); |
|
| 69 | + return $title; |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * Returns a description of the current filter |
|
| 74 | + * |
|
| 75 | + * @return string |
|
| 76 | + */ |
|
| 77 | + public function FilterDescription() |
|
| 78 | + { |
|
| 79 | + $params = $this->parseParams(); |
|
| 80 | + |
|
| 81 | + $filters = array(); |
|
| 82 | + if ($params['tag']) { |
|
| 83 | + $term = TaxonomyTerm::get_by_id(TaxonomyTerm::class, $params['tag']); |
|
| 84 | + if ($term) { |
|
| 85 | + $filters[] = _t( |
|
| 86 | + 'CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_WITHIN', |
|
| 87 | + 'within' |
|
| 88 | + ) . ' "' . $term->Name . '"'; |
|
| 89 | + } |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + if ($params['from'] || $params['to']) { |
|
| 93 | + if ($params['from']) { |
|
| 94 | + $from = strtotime($params['from']); |
|
| 95 | + if ($params['to']) { |
|
| 96 | + $to = strtotime($params['to']); |
|
| 97 | + $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_BETWEEN', 'between') . ' ' |
|
| 98 | + . date('j/m/Y', $from) . ' and ' . date('j/m/Y', $to); |
|
| 99 | + } else { |
|
| 100 | + $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on') |
|
| 101 | + . ' ' . date('j/m/Y', $from); |
|
| 102 | + } |
|
| 103 | + } else { |
|
| 104 | + $to = strtotime($params['to']); |
|
| 105 | + $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on') |
|
| 106 | + . ' ' . date('j/m/Y', $to); |
|
| 107 | + } |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + if ($params['year'] && $params['month']) { |
|
| 111 | + $timestamp = mktime(1, 1, 1, $params['month'], 1, $params['year']); |
|
| 112 | + $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_IN', 'in') |
|
| 113 | + . ' ' . date('F', $timestamp) . ' ' . $params['year']; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + if ($filters) { |
|
| 117 | + return $this->getUpdateName() . ' ' . implode(' ', $filters); |
|
| 118 | + } |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + public function getUpdateName() |
|
| 122 | + { |
|
| 123 | + return Config::inst()->get($this->data()->ClassName, 'update_name'); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + protected function init() |
|
| 127 | + { |
|
| 128 | + parent::init(); |
|
| 129 | + RSSFeed::linkToFeed($this->Link() . 'rss', $this->getSubscriptionTitle()); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Parse URL parameters. |
|
| 134 | + * |
|
| 135 | + * @param bool $produceErrorMessages Set to false to omit session messages. |
|
| 136 | + */ |
|
| 137 | + public function parseParams($produceErrorMessages = true) |
|
| 138 | + { |
|
| 139 | + $tag = $this->request->getVar('tag'); |
|
| 140 | + $from = $this->request->getVar('from'); |
|
| 141 | + $to = $this->request->getVar('to'); |
|
| 142 | + $year = $this->request->getVar('year'); |
|
| 143 | + $month = $this->request->getVar('month'); |
|
| 144 | + |
|
| 145 | + if ($tag == '') { |
|
| 146 | + $tag = null; |
|
| 147 | + } |
|
| 148 | + if ($from == '') { |
|
| 149 | + $from = null; |
|
| 150 | + } |
|
| 151 | + if ($to == '') { |
|
| 152 | + $to = null; |
|
| 153 | + } |
|
| 154 | + if ($year == '') { |
|
| 155 | + $year = null; |
|
| 156 | + } |
|
| 157 | + if ($month == '') { |
|
| 158 | + $month = null; |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + if (isset($tag)) { |
|
| 162 | + $tag = (int)$tag; |
|
| 163 | + } |
|
| 164 | + if (isset($from)) { |
|
| 165 | + $from = urldecode($from); |
|
| 166 | + $parser = DBDatetime::create(); |
|
| 167 | + $parser->setValue($from); |
|
| 168 | + $from = $parser->Format('y-MM-dd'); |
|
| 169 | + } |
|
| 170 | + if (isset($to)) { |
|
| 171 | + $to = urldecode($to); |
|
| 172 | + $parser = DBDatetime::create(); |
|
| 173 | + $parser->setValue($to); |
|
| 174 | + $to = $parser->Format('y-MM-dd'); |
|
| 175 | + } |
|
| 176 | + if (isset($year)) { |
|
| 177 | + $year = (int)$year; |
|
| 178 | + } |
|
| 179 | + if (isset($month)) { |
|
| 180 | + $month = (int)$month; |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + // If only "To" has been provided filter by single date. Normalise by swapping with "From". |
|
| 184 | + if (isset($to) && !isset($from)) { |
|
| 185 | + list($to, $from) = [$from, $to]; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + // Flip the dates if the order is wrong. |
|
| 189 | + if (isset($to) && isset($from) && strtotime($from) > strtotime($to)) { |
|
| 190 | + list($to, $from) = [$from, $to]; |
|
| 191 | + |
|
| 192 | + if ($produceErrorMessages) { |
|
| 193 | + $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t( |
|
| 194 | + __CLASS__ . '.FilterAppliedMessage', |
|
| 195 | + 'Filter has been applied with the dates reversed.' |
|
| 196 | + )); |
|
| 197 | + } |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + // Notify the user that filtering by single date is taking place. |
|
| 201 | + if (isset($from) && !isset($to)) { |
|
| 202 | + if ($produceErrorMessages) { |
|
| 203 | + $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t( |
|
| 204 | + __CLASS__ . '.DateRangeFilterMessage', 'Filtered by a single date.' |
|
| 205 | + )); |
|
| 206 | + } |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + return [ |
|
| 210 | + 'tag' => $tag, |
|
| 211 | + 'from' => $from, |
|
| 212 | + 'to' => $to, |
|
| 213 | + 'year' => $year, |
|
| 214 | + 'month' => $month, |
|
| 215 | + ]; |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Build the link - keep the date range, reset the rest. |
|
| 220 | + */ |
|
| 221 | + public function AllTagsLink() |
|
| 222 | + { |
|
| 223 | + $link = HTTP::setGetVar('tag', null, null, '&'); |
|
| 224 | + $link = HTTP::setGetVar('month', null, $link, '&'); |
|
| 225 | + $link = HTTP::setGetVar('year', null, $link, '&'); |
|
| 226 | + $link = HTTP::setGetVar('start', null, $link, '&'); |
|
| 227 | + |
|
| 228 | + return $link; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * List tags and attach links. |
|
| 233 | + */ |
|
| 234 | + public function UpdateTagsWithLinks() |
|
| 235 | + { |
|
| 236 | + $tags = $this->UpdateTags(); |
|
| 237 | + |
|
| 238 | + $processed = ArrayList::create(); |
|
| 239 | + |
|
| 240 | + foreach ($tags as $tag) { |
|
| 241 | + // Build the link - keep the tag, and date range, but reset month, year and pagination. |
|
| 242 | + $link = HTTP::setGetVar('tag', $tag->ID, null, '&'); |
|
| 243 | + $link = HTTP::setGetVar('month', null, $link, '&'); |
|
| 244 | + $link = HTTP::setGetVar('year', null, $link, '&'); |
|
| 245 | + $link = HTTP::setGetVar('start', null, $link, '&'); |
|
| 246 | + |
|
| 247 | + $tag->Link = $link; |
|
| 248 | + $processed->push($tag); |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + return $processed; |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Get the TaxonomyTerm related to the current tag GET parameter. |
|
| 256 | + */ |
|
| 257 | + public function CurrentTag() |
|
| 258 | + { |
|
| 259 | + $tagID = $this->request->getVar('tag'); |
|
| 260 | + |
|
| 261 | + if (isset($tagID)) { |
|
| 262 | + return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID); |
|
| 263 | + } |
|
| 264 | + } |
|
| 265 | + |
|
| 266 | + /** |
|
| 267 | + * Extract the available months based on the current query. |
|
| 268 | + * Only tag is respected. Pagination and months are ignored. |
|
| 269 | + */ |
|
| 270 | + public function AvailableMonths() |
|
| 271 | + { |
|
| 272 | + $params = $this->parseParams(); |
|
| 273 | + |
|
| 274 | + return DatedUpdateHolder::ExtractMonths( |
|
| 275 | + $this->Updates($params['tag'], $params['from'], $params['to']), |
|
| 276 | + Director::makeRelative($_SERVER['REQUEST_URI']), |
|
| 277 | + $params['year'], |
|
| 278 | + $params['month'] |
|
| 279 | + ); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /** |
|
| 283 | + * Get the updates based on the current query. |
|
| 284 | + */ |
|
| 285 | + public function FilteredUpdates($pageSize = 20) |
|
| 286 | + { |
|
| 287 | + $params = $this->parseParams(); |
|
| 288 | + |
|
| 289 | + $items = $this->Updates( |
|
| 290 | + $params['tag'], |
|
| 291 | + $params['from'], |
|
| 292 | + $params['to'], |
|
| 293 | + $params['year'], |
|
| 294 | + $params['month'] |
|
| 295 | + ); |
|
| 296 | + |
|
| 297 | + // Apply pagination |
|
| 298 | + $list = PaginatedList::create($items, $this->getRequest()); |
|
| 299 | + $list->setPageLength($pageSize); |
|
| 300 | + return $list; |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + /** |
|
| 304 | + * @return Form |
|
| 305 | + */ |
|
| 306 | + public function DateRangeForm() |
|
| 307 | + { |
|
| 308 | + $dateFromTitle = DBField::create_field('HTMLText', sprintf( |
|
| 309 | + '%s <span class="field-note">%s</span>', |
|
| 310 | + _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FROM_DATE', 'From date'), |
|
| 311 | + _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 2017/12/30)') |
|
| 312 | + )); |
|
| 313 | + $dateToTitle = DBField::create_field('HTMLText', sprintf( |
|
| 314 | + '%s <span class="field-note">%s</span>', |
|
| 315 | + _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.TO_DATE', 'To date'), |
|
| 316 | + _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 2017/12/30)') |
|
| 317 | + )); |
|
| 318 | + |
|
| 319 | + $fields = FieldList::create( |
|
| 320 | + DateField::create('from', $dateFromTitle), |
|
| 321 | + DateField::create('to', $dateToTitle), |
|
| 322 | + HiddenField::create('tag') |
|
| 323 | + ); |
|
| 324 | + |
|
| 325 | + $actions = FieldList::create( |
|
| 326 | + FormAction::create("doDateFilter") |
|
| 327 | + ->setTitle(_t(__CLASS__ . '.Filter', 'Filter')) |
|
| 328 | + ->addExtraClass('btn btn-primary primary'), |
|
| 329 | + FormAction::create("doDateReset") |
|
| 330 | + ->setTitle(_t(__CLASS__ . '.Clear', 'Clear')) |
|
| 331 | + ->addExtraClass('btn') |
|
| 332 | + ); |
|
| 333 | + |
|
| 334 | + $form = Form::create($this, 'DateRangeForm', $fields, $actions); |
|
| 335 | + $form->loadDataFrom($this->request->getVars()); |
|
| 336 | + $form->setFormMethod('get'); |
|
| 337 | + |
|
| 338 | + // Add any locally stored form messages before returning |
|
| 339 | + if ($formMessage = $this->getRequest()->getSession()->get(self::TEMP_FORM_MESSAGE)) { |
|
| 340 | + $form->setMessage($formMessage, ValidationResult::TYPE_WARNING); |
|
| 341 | + $this->getRequest()->getSession()->clear(self::TEMP_FORM_MESSAGE); |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + return $form; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + public function doDateFilter() |
|
| 348 | + { |
|
| 349 | + $params = $this->parseParams(); |
|
| 350 | + |
|
| 351 | + // Build the link - keep the tag, but reset month, year and pagination. |
|
| 352 | + $link = HTTP::setGetVar('from', $params['from'], $this->AbsoluteLink(), '&'); |
|
| 353 | + $link = HTTP::setGetVar('to', $params['to'], $link, '&'); |
|
| 354 | + if (isset($params['tag'])) { |
|
| 355 | + $link = HTTP::setGetVar('tag', $params['tag'], $link, '&'); |
|
| 356 | + } |
|
| 357 | + |
|
| 358 | + $this->redirect($link); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + public function doDateReset() |
|
| 362 | + { |
|
| 363 | + $params = $this->parseParams(false); |
|
| 364 | + |
|
| 365 | + // Reset the link - only include the tag. |
|
| 366 | + $link = $this->AbsoluteLink(); |
|
| 367 | + if (isset($params['tag'])) { |
|
| 368 | + $link = HTTP::setGetVar('tag', $params['tag'], $link, '&'); |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + $this->redirect($link); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + public function rss() |
|
| 375 | + { |
|
| 376 | + $rss = RSSFeed::create( |
|
| 377 | + $this->Updates()->sort('Created DESC')->limit(20), |
|
| 378 | + $this->Link('rss'), |
|
| 379 | + $this->getSubscriptionTitle() |
|
| 380 | + ); |
|
| 381 | + return $rss->outputToBrowser(); |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + public function atom() |
|
| 385 | + { |
|
| 386 | + $atom = CwpAtomFeed::create( |
|
| 387 | + $this->Updates()->sort('Created DESC')->limit(20), |
|
| 388 | + $this->Link('atom'), |
|
| 389 | + $this->getSubscriptionTitle() |
|
| 390 | + ); |
|
| 391 | + return $atom->outputToBrowser(); |
|
| 392 | + } |
|
| 393 | 393 | } |
@@ -159,7 +159,7 @@ discard block |
||
| 159 | 159 | } |
| 160 | 160 | |
| 161 | 161 | if (isset($tag)) { |
| 162 | - $tag = (int)$tag; |
|
| 162 | + $tag = (int) $tag; |
|
| 163 | 163 | } |
| 164 | 164 | if (isset($from)) { |
| 165 | 165 | $from = urldecode($from); |
@@ -174,10 +174,10 @@ discard block |
||
| 174 | 174 | $to = $parser->Format('y-MM-dd'); |
| 175 | 175 | } |
| 176 | 176 | if (isset($year)) { |
| 177 | - $year = (int)$year; |
|
| 177 | + $year = (int) $year; |
|
| 178 | 178 | } |
| 179 | 179 | if (isset($month)) { |
| 180 | - $month = (int)$month; |
|
| 180 | + $month = (int) $month; |
|
| 181 | 181 | } |
| 182 | 182 | |
| 183 | 183 | // If only "To" has been provided filter by single date. Normalise by swapping with "From". |
@@ -259,7 +259,7 @@ discard block |
||
| 259 | 259 | $tagID = $this->request->getVar('tag'); |
| 260 | 260 | |
| 261 | 261 | if (isset($tagID)) { |
| 262 | - return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID); |
|
| 262 | + return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int) $tagID); |
|
| 263 | 263 | } |
| 264 | 264 | } |
| 265 | 265 | |