silverstripe / cwp

src/PageTypes/EventHolder.php

Indentation +53 added lines, -53 removed lines

@@ -7,57 +7,57 @@
 
 class EventHolder extends DatedUpdateHolder
 {
-    private static $description = 'Container page for Event Pages, provides event filtering and pagination';
-
-    private static $allowed_children = [
-        EventPage::class,
-    ];
-
-    private static $default_child = EventPage::class;
-
-    private static $update_name = 'Events';
-
-    private static $update_class = EventPage::class;
-
-    private static $icon_class = 'font-icon-p-event-alt';
-
-    private static $singular_name = 'Event Holder';
-
-    private static $plural_name = 'Event Holders';
-
-    private static $table_name = 'EventHolder';
-
-    /**
-     * Find all site's news items, based on some filters.
-     * Omitting parameters will prevent relevant filters from being applied. The filters are ANDed together.
-     *
-     * @param string $className The name of the class to fetch.
-     * @param int $parentID The ID of the holder to extract the news items from.
-     * @param int $tagID The ID of the tag to filter the news items by.
-     * @param string $dateFrom The beginning of a date filter range.
-     * @param string $dateTo The end of the date filter range. If empty, only one day will be searched for.
-     * @param int $year Numeric value of the year to show.
-     * @param int $monthNumber Numeric value of the month to show.
-     *
-     * @returns DataList|PaginatedList
-     */
-    public static function AllUpdates(
-        $className = 'Events',
-        $parentID = null,
-        $tagID = null,
-        $dateFrom = null,
-        $dateTo = null,
-        $year = null,
-        $monthNumber = null
-    ) {
-        return parent::AllUpdates(
-            $className,
-            $parentID,
-            $tagID,
-            $dateFrom,
-            $dateTo,
-            $year,
-            $monthNumber
-        )->Sort('Date', 'ASC');
-    }
+	private static $description = 'Container page for Event Pages, provides event filtering and pagination';
+
+	private static $allowed_children = [
+		EventPage::class,
+	];
+
+	private static $default_child = EventPage::class;
+
+	private static $update_name = 'Events';
+
+	private static $update_class = EventPage::class;
+
+	private static $icon_class = 'font-icon-p-event-alt';
+
+	private static $singular_name = 'Event Holder';
+
+	private static $plural_name = 'Event Holders';
+
+	private static $table_name = 'EventHolder';
+
+	/**
+	 * Find all site's news items, based on some filters.
+	 * Omitting parameters will prevent relevant filters from being applied. The filters are ANDed together.
+	 *
+	 * @param string $className The name of the class to fetch.
+	 * @param int $parentID The ID of the holder to extract the news items from.
+	 * @param int $tagID The ID of the tag to filter the news items by.
+	 * @param string $dateFrom The beginning of a date filter range.
+	 * @param string $dateTo The end of the date filter range. If empty, only one day will be searched for.
+	 * @param int $year Numeric value of the year to show.
+	 * @param int $monthNumber Numeric value of the month to show.
+	 *
+	 * @returns DataList|PaginatedList
+	 */
+	public static function AllUpdates(
+		$className = 'Events',
+		$parentID = null,
+		$tagID = null,
+		$dateFrom = null,
+		$dateTo = null,
+		$year = null,
+		$monthNumber = null
+	) {
+		return parent::AllUpdates(
+			$className,
+			$parentID,
+			$tagID,
+			$dateFrom,
+			$dateTo,
+			$year,
+			$monthNumber
+		)->Sort('Date', 'ASC');
+	}
 }

src/Model/Quicklink.php

Indentation +117 added lines, -117 removed lines

@@ -15,121 +15,121 @@
  */
 class Quicklink extends DataObject
 {
-    private static $db = [
-        'Name' => 'Varchar(255)',
-        'ExternalLink' => 'Varchar(255)',
-        'SortOrder' => 'Int',
-    ];
-
-    private static $has_one = [
-        'Parent' => BaseHomePage::class,
-        'InternalLink' => SiteTree::class,
-    ];
-
-    private static $summary_fields = [
-        'Name' => 'Name',
-        'InternalLink.Title' => 'Internal Link',
-        'ExternalLink' => 'External Link',
-    ];
-
-    private static $table_name = 'Quicklink';
-
-    public function fieldLabels($includerelations = true)
-    {
-        $labels = parent::fieldLabels($includerelations);
-        $labels['Name'] = _t(__CLASS__ . '.NameLabel', 'Name');
-        $labels['ExternalLink'] = _t(__CLASS__ . '.ExternalLinkLabel', 'External Link');
-        $labels['SortOrder'] = _t(__CLASS__ . '.SortOrderLabel', 'Sort Order');
-        $labels['ParentID'] = _t(__CLASS__ . '.ParentRelationLabel', 'Parent');
-        $labels['InternalLinkID'] = _t(__CLASS__ . '.InternalLinkLabel', 'Internal Link');
-
-        return $labels;
-    }
-
-    public function getLink()
-    {
-        if ($this->ExternalLink) {
-            $url = parse_url($this->ExternalLink);
-
-            // if no scheme set in the link, default to http
-            if (!isset($url['scheme'])) {
-                return 'http://' . $this->ExternalLink;
-            }
-
-            return $this->ExternalLink;
-        }
-
-        if ($this->InternalLinkID) {
-            return $this->InternalLink()->Link();
-        }
-    }
-
-    public function canCreate($member = null, $context = [])
-    {
-        // Creating quick links should not be the same permission level as creating parent pages for them, they're
-        // essentially content in the context of the page, so use the edit permission instead.
-        return $this->canEdit($member);
-    }
-
-    public function canEdit($member = null)
-    {
-        return $this->Parent()->canEdit($member);
-    }
-
-    public function canDelete($member = null)
-    {
-        return $this->Parent()->canDelete($member);
-    }
-
-    public function canView($member = null)
-    {
-        return $this->Parent()->canView($member);
-    }
-
-    public function getCMSFields()
-    {
-        $fields = parent::getCMSFields();
-
-        $fields->removeByName('ParentID');
-
-        $externalLinkField = $fields->fieldByName('Root.Main.ExternalLink');
-
-        $fields->removeByName('ExternalLink');
-        $fields->removeByName('InternalLinkID');
-        $fields->removeByName('SortOrder');
-        $externalLinkField->addExtraClass('noBorder');
-
-        $fields->addFieldToTab('Root.Main', CompositeField::create(
-            array(
-                TreeDropdownField::create(
-                    'InternalLinkID',
-                    $this->fieldLabel('InternalLinkID'),
-                    SiteTree::class
-                ),
-                $externalLinkField,
-                $wrap = CompositeField::create(
-                    $extraLabel = LiteralField::create(
-                        'NoteOverride',
-                        sprintf('<div class="message good notice">%s</div>', _t(
-                            __CLASS__ . '.Note',
-                            'Note: If you specify an External Link, the Internal Link will be ignored.'
-                        ))
-                    )
-                )
-            )
-        ));
-        $fields->insertBefore(
-            'Name',
-            LiteralField::create(
-                'Note',
-                sprintf('<p>%s</p>', _t(
-                    __CLASS__ . '.Note2',
-                    'Use this to specify a link to a page either on this site '
-                        . '(Internal Link) or another site (External Link).'
-                ))
-            )
-        );
-
-        return $fields;
-    }
+	private static $db = [
+		'Name' => 'Varchar(255)',
+		'ExternalLink' => 'Varchar(255)',
+		'SortOrder' => 'Int',
+	];
+
+	private static $has_one = [
+		'Parent' => BaseHomePage::class,
+		'InternalLink' => SiteTree::class,
+	];
+
+	private static $summary_fields = [
+		'Name' => 'Name',
+		'InternalLink.Title' => 'Internal Link',
+		'ExternalLink' => 'External Link',
+	];
+
+	private static $table_name = 'Quicklink';
+
+	public function fieldLabels($includerelations = true)
+	{
+		$labels = parent::fieldLabels($includerelations);
+		$labels['Name'] = _t(__CLASS__ . '.NameLabel', 'Name');
+		$labels['ExternalLink'] = _t(__CLASS__ . '.ExternalLinkLabel', 'External Link');
+		$labels['SortOrder'] = _t(__CLASS__ . '.SortOrderLabel', 'Sort Order');
+		$labels['ParentID'] = _t(__CLASS__ . '.ParentRelationLabel', 'Parent');
+		$labels['InternalLinkID'] = _t(__CLASS__ . '.InternalLinkLabel', 'Internal Link');
+
+		return $labels;
+	}
+
+	public function getLink()
+	{
+		if ($this->ExternalLink) {
+			$url = parse_url($this->ExternalLink);
+
+			// if no scheme set in the link, default to http
+			if (!isset($url['scheme'])) {
+				return 'http://' . $this->ExternalLink;
+			}
+
+			return $this->ExternalLink;
+		}
+
+		if ($this->InternalLinkID) {
+			return $this->InternalLink()->Link();
+		}
+	}
+
+	public function canCreate($member = null, $context = [])
+	{
+		// Creating quick links should not be the same permission level as creating parent pages for them, they're
+		// essentially content in the context of the page, so use the edit permission instead.
+		return $this->canEdit($member);
+	}
+
+	public function canEdit($member = null)
+	{
+		return $this->Parent()->canEdit($member);
+	}
+
+	public function canDelete($member = null)
+	{
+		return $this->Parent()->canDelete($member);
+	}
+
+	public function canView($member = null)
+	{
+		return $this->Parent()->canView($member);
+	}
+
+	public function getCMSFields()
+	{
+		$fields = parent::getCMSFields();
+
+		$fields->removeByName('ParentID');
+
+		$externalLinkField = $fields->fieldByName('Root.Main.ExternalLink');
+
+		$fields->removeByName('ExternalLink');
+		$fields->removeByName('InternalLinkID');
+		$fields->removeByName('SortOrder');
+		$externalLinkField->addExtraClass('noBorder');
+
+		$fields->addFieldToTab('Root.Main', CompositeField::create(
+			array(
+				TreeDropdownField::create(
+					'InternalLinkID',
+					$this->fieldLabel('InternalLinkID'),
+					SiteTree::class
+				),
+				$externalLinkField,
+				$wrap = CompositeField::create(
+					$extraLabel = LiteralField::create(
+						'NoteOverride',
+						sprintf('<div class="message good notice">%s</div>', _t(
+							__CLASS__ . '.Note',
+							'Note: If you specify an External Link, the Internal Link will be ignored.'
+						))
+					)
+				)
+			)
+		));
+		$fields->insertBefore(
+			'Name',
+			LiteralField::create(
+				'Note',
+				sprintf('<p>%s</p>', _t(
+					__CLASS__ . '.Note2',
+					'Use this to specify a link to a page either on this site '
+						. '(Internal Link) or another site (External Link).'
+				))
+			)
+		);
+
+		return $fields;
+	}
 }

tests/PageTypes/NewsPageTest.php

Indentation +14 added lines, -14 removed lines

@@ -9,21 +9,21 @@
 
 class NewsPageTest extends SapphireTest
 {
-    protected $usesDatabase = true;
+	protected $usesDatabase = true;
 
-    public function testGetNewsPageAuthor()
-    {
-        $holder = new NewsHolder();
-        $holder->Title = 'Holder';
-        $holder->write();
+	public function testGetNewsPageAuthor()
+	{
+		$holder = new NewsHolder();
+		$holder->Title = 'Holder';
+		$holder->write();
 
-        $page = new NewsPage();
-        $page->Author = 'Leslie Lawless';
-        $page->ParentID = $holder->ID;
-        $page->write();
+		$page = new NewsPage();
+		$page->Author = 'Leslie Lawless';
+		$page->ParentID = $holder->ID;
+		$page->write();
 
-        $field = $page->getNewsPageAuthor();
-        $this->assertInstanceOf(DBField::class, $field);
-        $this->assertSame('Leslie Lawless', $field->getValue());
-    }
+		$field = $page->getNewsPageAuthor();
+		$this->assertInstanceOf(DBField::class, $field);
+		$this->assertSame('Leslie Lawless', $field->getValue());
+	}
 }

src/PageTypes/DatedUpdateHolderController.php

Indentation +366 added lines, -366 removed lines

@@ -35,370 +35,370 @@
  */
 class DatedUpdateHolderController extends PageController
 {
-    private static $allowed_actions = [
-        'rss',
-        'atom',
-        'DateRangeForm',
-    ];
-
-    private static $casting = [
-        'MetaTitle' => 'Text',
-        'FilterDescription' => 'Text',
-    ];
-
-    /**
-     * The session key for storing temporary form messages
-     *
-     * @var string
-     */
-    const TEMP_FORM_MESSAGE = __CLASS__ . '.TempFormMessage';
-
-    /**
-     * Get the meta title for the current action
-     *
-     * @return string
-     */
-    public function getMetaTitle()
-    {
-        $title = $this->data()->getTitle();
-        $filter = $this->FilterDescription();
-        if ($filter) {
-            $title = "{$title} - {$filter}";
-        }
-
-        $this->extend('updateMetaTitle', $title);
-        return $title;
-    }
-
-    /**
-     * Returns a description of the current filter
-     *
-     * @return string
-     */
-    public function FilterDescription()
-    {
-        $params = $this->parseParams();
-
-        $filters = array();
-        if ($params['tag']) {
-            $term = TaxonomyTerm::get_by_id(TaxonomyTerm::class, $params['tag']);
-            if ($term) {
-                $filters[] = _t(
-                    'CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_WITHIN',
-                    'within'
-                ) . ' "' . $term->Name . '"';
-            }
-        }
-
-        if ($params['from'] || $params['to']) {
-            if ($params['from']) {
-                $from = strtotime($params['from']);
-                if ($params['to']) {
-                    $to = strtotime($params['to']);
-                    $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_BETWEEN', 'between') . ' '
-                        . date('j/m/Y', $from) . ' and ' . date('j/m/Y', $to);
-                } else {
-                    $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on')
-                        . ' ' . date('j/m/Y', $from);
-                }
-            } else {
-                $to = strtotime($params['to']);
-                $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on')
-                    . ' ' . date('j/m/Y', $to);
-            }
-        }
-
-        if ($params['year'] && $params['month']) {
-            $timestamp = mktime(1, 1, 1, $params['month'], 1, $params['year']);
-            $filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_IN', 'in')
-                . ' ' . date('F', $timestamp) . ' ' . $params['year'];
-        }
-
-        if ($filters) {
-            return $this->getUpdateName() . ' ' . implode(' ', $filters);
-        }
-    }
-
-    public function getUpdateName()
-    {
-        return Config::inst()->get($this->data()->ClassName, 'update_name');
-    }
-
-    protected function init()
-    {
-        parent::init();
-        RSSFeed::linkToFeed($this->Link() . 'rss', $this->getSubscriptionTitle());
-    }
-
-    /**
-     * Parse URL parameters.
-     *
-     * @param bool $produceErrorMessages Set to false to omit session messages.
-     */
-    public function parseParams($produceErrorMessages = true)
-    {
-        $tag = $this->request->getVar('tag');
-        $from = $this->request->getVar('from');
-        $to = $this->request->getVar('to');
-        $year = $this->request->getVar('year');
-        $month = $this->request->getVar('month');
-
-        if ($tag == '') {
-            $tag = null;
-        }
-        if ($from == '') {
-            $from = null;
-        }
-        if ($to == '') {
-            $to = null;
-        }
-        if ($year == '') {
-            $year = null;
-        }
-        if ($month == '') {
-            $month = null;
-        }
-
-        if (isset($tag)) {
-            $tag = (int)$tag;
-        }
-        try {
-            if (isset($from)) {
-                $from = urldecode($from);
-                $parser = DBDatetime::create();
-                $parser->setValue($from);
-                $from = $parser->Format('y-MM-dd');
-            }
-            if (isset($to)) {
-                $to = urldecode($to);
-                $parser = DBDatetime::create();
-                $parser->setValue($to);
-                $to = $parser->Format('y-MM-dd');
-            }
-        } catch (InvalidArgumentException $e) {
-            if ($produceErrorMessages) {
-                $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
-                    __CLASS__ . '.InvalidDateFormat',
-                    'Dates must be in "y-MM-dd" format.'
-                ));
-            }
-        }
-        if (isset($year)) {
-            $year = (int)$year;
-        }
-        if (isset($month)) {
-            $month = (int)$month;
-        }
-
-        // If only "To" has been provided filter by single date. Normalise by swapping with "From".
-        if (isset($to) && !isset($from)) {
-            list($to, $from) = [$from, $to];
-        }
-
-        // Flip the dates if the order is wrong.
-        if (isset($to) && isset($from) && strtotime($from) > strtotime($to)) {
-            list($to, $from) = [$from, $to];
-
-            if ($produceErrorMessages) {
-                $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
-                    __CLASS__ . '.FilterAppliedMessage',
-                    'Filter has been applied with the dates reversed.'
-                ));
-            }
-        }
-
-        // Notify the user that filtering by single date is taking place.
-        if (isset($from) && !isset($to)) {
-            if ($produceErrorMessages) {
-                $this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
-                    __CLASS__ . '.DateRangeFilterMessage',
-                    'Filtered by a single date.'
-                ));
-            }
-        }
-
-        return [
-            'tag' => $tag,
-            'from' => $from,
-            'to' => $to,
-            'year' => $year,
-            'month' => $month,
-        ];
-    }
-
-    /**
-     * Build the link - keep the date range, reset the rest.
-     */
-    public function AllTagsLink()
-    {
-        $link = HTTP::setGetVar('tag', null, null, '&');
-        $link = HTTP::setGetVar('month', null, $link, '&');
-        $link = HTTP::setGetVar('year', null, $link, '&');
-        $link = HTTP::setGetVar('start', null, $link, '&');
-
-        return $link;
-    }
-
-    /**
-     * List tags and attach links.
-     */
-    public function UpdateTagsWithLinks()
-    {
-        $tags = $this->UpdateTags();
-
-        $processed = ArrayList::create();
-
-        foreach ($tags as $tag) {
-            // Build the link - keep the tag, and date range, but reset month, year and pagination.
-            $link = HTTP::setGetVar('tag', $tag->ID, null, '&');
-            $link = HTTP::setGetVar('month', null, $link, '&');
-            $link = HTTP::setGetVar('year', null, $link, '&');
-            $link = HTTP::setGetVar('start', null, $link, '&');
-
-            $tag->Link = $link;
-            $processed->push($tag);
-        }
-
-        return $processed;
-    }
-
-    /**
-     * Get the TaxonomyTerm related to the current tag GET parameter.
-     */
-    public function CurrentTag()
-    {
-        $tagID = $this->request->getVar('tag');
-
-        if (isset($tagID)) {
-            return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID);
-        }
-    }
-
-    /**
-     * Extract the available months based on the current query.
-     * Only tag is respected. Pagination and months are ignored.
-     */
-    public function AvailableMonths()
-    {
-        $params = $this->parseParams();
-
-        return DatedUpdateHolder::ExtractMonths(
-            $this->Updates($params['tag'], $params['from'], $params['to']),
-            Director::makeRelative($_SERVER['REQUEST_URI']),
-            $params['year'],
-            $params['month']
-        );
-    }
-
-    /**
-     * Get the updates based on the current query.
-     */
-    public function FilteredUpdates($pageSize = 20)
-    {
-        $params = $this->parseParams();
-
-        $items = $this->Updates(
-            $params['tag'],
-            $params['from'],
-            $params['to'],
-            $params['year'],
-            $params['month']
-        );
-
-        // Apply pagination
-        $list = PaginatedList::create($items, $this->getRequest());
-        $list->setPageLength($pageSize);
-        return $list;
-    }
-
-    /**
-     * @return Form
-     */
-    public function DateRangeForm()
-    {
-        $dateFromTitle = DBField::create_field('HTMLText', sprintf(
-            '%s <span class="field-note">%s</span>',
-            _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FROM_DATE', 'From date'),
-            _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 30/12/2017)')
-        ));
-        $dateToTitle = DBField::create_field('HTMLText', sprintf(
-            '%s <span class="field-note">%s</span>',
-            _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.TO_DATE', 'To date'),
-            _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 30/12/2017)')
-        ));
-
-        $fields = FieldList::create(
-            DateField::create('from', $dateFromTitle),
-            DateField::create('to', $dateToTitle),
-            HiddenField::create('tag')
-        );
-
-        $actions = FieldList::create(
-            FormAction::create("doDateFilter")
-                ->setTitle(_t(__CLASS__ . '.Filter', 'Filter'))
-                ->addExtraClass('btn btn-primary primary'),
-            FormAction::create("doDateReset")
-                ->setTitle(_t(__CLASS__ . '.Clear', 'Clear'))
-                ->addExtraClass('btn')
-        );
-
-        $form = Form::create($this, 'DateRangeForm', $fields, $actions);
-        $form->loadDataFrom($this->request->getVars());
-        $form->setFormMethod('get');
-
-        // Add any locally stored form messages before returning
-        if ($formMessage = $this->getRequest()->getSession()->get(self::TEMP_FORM_MESSAGE)) {
-            $form->setMessage($formMessage, ValidationResult::TYPE_WARNING);
-            $this->getRequest()->getSession()->clear(self::TEMP_FORM_MESSAGE);
-        }
-
-        return $form;
-    }
-
-    public function doDateFilter()
-    {
-        $params = $this->parseParams();
-
-        // Build the link - keep the tag, but reset month, year and pagination.
-        $link = HTTP::setGetVar('from', $params['from'], $this->AbsoluteLink(), '&');
-        $link = HTTP::setGetVar('to', $params['to'], $link, '&');
-        if (isset($params['tag'])) {
-            $link = HTTP::setGetVar('tag', $params['tag'], $link, '&');
-        }
-
-        $this->redirect($link);
-    }
-
-    public function doDateReset()
-    {
-        $params = $this->parseParams(false);
-
-        // Reset the link - only include the tag.
-        $link = $this->AbsoluteLink();
-        if (isset($params['tag'])) {
-            $link = HTTP::setGetVar('tag', $params['tag'], $link, '&');
-        }
-
-        $this->redirect($link);
-    }
-
-    public function rss()
-    {
-        $rss = RSSFeed::create(
-            $this->Updates()->sort('Created DESC')->limit(20),
-            $this->Link('rss'),
-            $this->getSubscriptionTitle()
-        );
-        return $rss->outputToBrowser();
-    }
-
-    public function atom()
-    {
-        $atom = CwpAtomFeed::create(
-            $this->Updates()->sort('Created DESC')->limit(20),
-            $this->Link('atom'),
-            $this->getSubscriptionTitle()
-        );
-        return $atom->outputToBrowser();
-    }
+	private static $allowed_actions = [
+		'rss',
+		'atom',
+		'DateRangeForm',
+	];
+
+	private static $casting = [
+		'MetaTitle' => 'Text',
+		'FilterDescription' => 'Text',
+	];
+
+	/**
+	 * The session key for storing temporary form messages
+	 *
+	 * @var string
+	 */
+	const TEMP_FORM_MESSAGE = __CLASS__ . '.TempFormMessage';
+
+	/**
+	 * Get the meta title for the current action
+	 *
+	 * @return string
+	 */
+	public function getMetaTitle()
+	{
+		$title = $this->data()->getTitle();
+		$filter = $this->FilterDescription();
+		if ($filter) {
+			$title = "{$title} - {$filter}";
+		}
+
+		$this->extend('updateMetaTitle', $title);
+		return $title;
+	}
+
+	/**
+	 * Returns a description of the current filter
+	 *
+	 * @return string
+	 */
+	public function FilterDescription()
+	{
+		$params = $this->parseParams();
+
+		$filters = array();
+		if ($params['tag']) {
+			$term = TaxonomyTerm::get_by_id(TaxonomyTerm::class, $params['tag']);
+			if ($term) {
+				$filters[] = _t(
+					'CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_WITHIN',
+					'within'
+				) . ' "' . $term->Name . '"';
+			}
+		}
+
+		if ($params['from'] || $params['to']) {
+			if ($params['from']) {
+				$from = strtotime($params['from']);
+				if ($params['to']) {
+					$to = strtotime($params['to']);
+					$filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_BETWEEN', 'between') . ' '
+						. date('j/m/Y', $from) . ' and ' . date('j/m/Y', $to);
+				} else {
+					$filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on')
+						. ' ' . date('j/m/Y', $from);
+				}
+			} else {
+				$to = strtotime($params['to']);
+				$filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_ON', 'on')
+					. ' ' . date('j/m/Y', $to);
+			}
+		}
+
+		if ($params['year'] && $params['month']) {
+			$timestamp = mktime(1, 1, 1, $params['month'], 1, $params['year']);
+			$filters[] = _t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FILTER_IN', 'in')
+				. ' ' . date('F', $timestamp) . ' ' . $params['year'];
+		}
+
+		if ($filters) {
+			return $this->getUpdateName() . ' ' . implode(' ', $filters);
+		}
+	}
+
+	public function getUpdateName()
+	{
+		return Config::inst()->get($this->data()->ClassName, 'update_name');
+	}
+
+	protected function init()
+	{
+		parent::init();
+		RSSFeed::linkToFeed($this->Link() . 'rss', $this->getSubscriptionTitle());
+	}
+
+	/**
+	 * Parse URL parameters.
+	 *
+	 * @param bool $produceErrorMessages Set to false to omit session messages.
+	 */
+	public function parseParams($produceErrorMessages = true)
+	{
+		$tag = $this->request->getVar('tag');
+		$from = $this->request->getVar('from');
+		$to = $this->request->getVar('to');
+		$year = $this->request->getVar('year');
+		$month = $this->request->getVar('month');
+
+		if ($tag == '') {
+			$tag = null;
+		}
+		if ($from == '') {
+			$from = null;
+		}
+		if ($to == '') {
+			$to = null;
+		}
+		if ($year == '') {
+			$year = null;
+		}
+		if ($month == '') {
+			$month = null;
+		}
+
+		if (isset($tag)) {
+			$tag = (int)$tag;
+		}
+		try {
+			if (isset($from)) {
+				$from = urldecode($from);
+				$parser = DBDatetime::create();
+				$parser->setValue($from);
+				$from = $parser->Format('y-MM-dd');
+			}
+			if (isset($to)) {
+				$to = urldecode($to);
+				$parser = DBDatetime::create();
+				$parser->setValue($to);
+				$to = $parser->Format('y-MM-dd');
+			}
+		} catch (InvalidArgumentException $e) {
+			if ($produceErrorMessages) {
+				$this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
+					__CLASS__ . '.InvalidDateFormat',
+					'Dates must be in "y-MM-dd" format.'
+				));
+			}
+		}
+		if (isset($year)) {
+			$year = (int)$year;
+		}
+		if (isset($month)) {
+			$month = (int)$month;
+		}
+
+		// If only "To" has been provided filter by single date. Normalise by swapping with "From".
+		if (isset($to) && !isset($from)) {
+			list($to, $from) = [$from, $to];
+		}
+
+		// Flip the dates if the order is wrong.
+		if (isset($to) && isset($from) && strtotime($from) > strtotime($to)) {
+			list($to, $from) = [$from, $to];
+
+			if ($produceErrorMessages) {
+				$this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
+					__CLASS__ . '.FilterAppliedMessage',
+					'Filter has been applied with the dates reversed.'
+				));
+			}
+		}
+
+		// Notify the user that filtering by single date is taking place.
+		if (isset($from) && !isset($to)) {
+			if ($produceErrorMessages) {
+				$this->getRequest()->getSession()->set(self::TEMP_FORM_MESSAGE, _t(
+					__CLASS__ . '.DateRangeFilterMessage',
+					'Filtered by a single date.'
+				));
+			}
+		}
+
+		return [
+			'tag' => $tag,
+			'from' => $from,
+			'to' => $to,
+			'year' => $year,
+			'month' => $month,
+		];
+	}
+
+	/**
+	 * Build the link - keep the date range, reset the rest.
+	 */
+	public function AllTagsLink()
+	{
+		$link = HTTP::setGetVar('tag', null, null, '&');
+		$link = HTTP::setGetVar('month', null, $link, '&');
+		$link = HTTP::setGetVar('year', null, $link, '&');
+		$link = HTTP::setGetVar('start', null, $link, '&');
+
+		return $link;
+	}
+
+	/**
+	 * List tags and attach links.
+	 */
+	public function UpdateTagsWithLinks()
+	{
+		$tags = $this->UpdateTags();
+
+		$processed = ArrayList::create();
+
+		foreach ($tags as $tag) {
+			// Build the link - keep the tag, and date range, but reset month, year and pagination.
+			$link = HTTP::setGetVar('tag', $tag->ID, null, '&');
+			$link = HTTP::setGetVar('month', null, $link, '&');
+			$link = HTTP::setGetVar('year', null, $link, '&');
+			$link = HTTP::setGetVar('start', null, $link, '&');
+
+			$tag->Link = $link;
+			$processed->push($tag);
+		}
+
+		return $processed;
+	}
+
+	/**
+	 * Get the TaxonomyTerm related to the current tag GET parameter.
+	 */
+	public function CurrentTag()
+	{
+		$tagID = $this->request->getVar('tag');
+
+		if (isset($tagID)) {
+			return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID);
+		}
+	}
+
+	/**
+	 * Extract the available months based on the current query.
+	 * Only tag is respected. Pagination and months are ignored.
+	 */
+	public function AvailableMonths()
+	{
+		$params = $this->parseParams();
+
+		return DatedUpdateHolder::ExtractMonths(
+			$this->Updates($params['tag'], $params['from'], $params['to']),
+			Director::makeRelative($_SERVER['REQUEST_URI']),
+			$params['year'],
+			$params['month']
+		);
+	}
+
+	/**
+	 * Get the updates based on the current query.
+	 */
+	public function FilteredUpdates($pageSize = 20)
+	{
+		$params = $this->parseParams();
+
+		$items = $this->Updates(
+			$params['tag'],
+			$params['from'],
+			$params['to'],
+			$params['year'],
+			$params['month']
+		);
+
+		// Apply pagination
+		$list = PaginatedList::create($items, $this->getRequest());
+		$list->setPageLength($pageSize);
+		return $list;
+	}
+
+	/**
+	 * @return Form
+	 */
+	public function DateRangeForm()
+	{
+		$dateFromTitle = DBField::create_field('HTMLText', sprintf(
+			'%s <span class="field-note">%s</span>',
+			_t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.FROM_DATE', 'From date'),
+			_t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 30/12/2017)')
+		));
+		$dateToTitle = DBField::create_field('HTMLText', sprintf(
+			'%s <span class="field-note">%s</span>',
+			_t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.TO_DATE', 'To date'),
+			_t('CWP\\CWP\\PageTypes\\DatedUpdateHolder.DATE_EXAMPLE', '(example: 30/12/2017)')
+		));
+
+		$fields = FieldList::create(
+			DateField::create('from', $dateFromTitle),
+			DateField::create('to', $dateToTitle),
+			HiddenField::create('tag')
+		);
+
+		$actions = FieldList::create(
+			FormAction::create("doDateFilter")
+				->setTitle(_t(__CLASS__ . '.Filter', 'Filter'))
+				->addExtraClass('btn btn-primary primary'),
+			FormAction::create("doDateReset")
+				->setTitle(_t(__CLASS__ . '.Clear', 'Clear'))
+				->addExtraClass('btn')
+		);
+
+		$form = Form::create($this, 'DateRangeForm', $fields, $actions);
+		$form->loadDataFrom($this->request->getVars());
+		$form->setFormMethod('get');
+
+		// Add any locally stored form messages before returning
+		if ($formMessage = $this->getRequest()->getSession()->get(self::TEMP_FORM_MESSAGE)) {
+			$form->setMessage($formMessage, ValidationResult::TYPE_WARNING);
+			$this->getRequest()->getSession()->clear(self::TEMP_FORM_MESSAGE);
+		}
+
+		return $form;
+	}
+
+	public function doDateFilter()
+	{
+		$params = $this->parseParams();
+
+		// Build the link - keep the tag, but reset month, year and pagination.
+		$link = HTTP::setGetVar('from', $params['from'], $this->AbsoluteLink(), '&');
+		$link = HTTP::setGetVar('to', $params['to'], $link, '&');
+		if (isset($params['tag'])) {
+			$link = HTTP::setGetVar('tag', $params['tag'], $link, '&');
+		}
+
+		$this->redirect($link);
+	}
+
+	public function doDateReset()
+	{
+		$params = $this->parseParams(false);
+
+		// Reset the link - only include the tag.
+		$link = $this->AbsoluteLink();
+		if (isset($params['tag'])) {
+			$link = HTTP::setGetVar('tag', $params['tag'], $link, '&');
+		}
+
+		$this->redirect($link);
+	}
+
+	public function rss()
+	{
+		$rss = RSSFeed::create(
+			$this->Updates()->sort('Created DESC')->limit(20),
+			$this->Link('rss'),
+			$this->getSubscriptionTitle()
+		);
+		return $rss->outputToBrowser();
+	}
+
+	public function atom()
+	{
+		$atom = CwpAtomFeed::create(
+			$this->Updates()->sort('Created DESC')->limit(20),
+			$this->Link('atom'),
+			$this->getSubscriptionTitle()
+		);
+		return $atom->outputToBrowser();
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -160,7 +160,7 @@ 
         }
 
         if (isset($tag)) {
-            $tag = (int)$tag;
+            $tag = (int) $tag;
         }
         try {
             if (isset($from)) {
@@ -184,10 +184,10 @@ 
             }
         }
         if (isset($year)) {
-            $year = (int)$year;
+            $year = (int) $year;
         }
         if (isset($month)) {
-            $month = (int)$month;
+            $month = (int) $month;
         }
 
         // If only "To" has been provided filter by single date. Normalise by swapping with "From".
@@ -270,7 +270,7 @@ 
         $tagID = $this->request->getVar('tag');
 
         if (isset($tagID)) {
-            return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int)$tagID);
+            return TaxonomyTerm::get_by_id(TaxonomyTerm::class, (int) $tagID);
         }
     }
 

tests/PageTypes/DatedUpdateHolderControllerTest.php

Indentation +30 added lines, -30 removed lines

@@ -9,44 +9,44 @@
 
 class DatedUpdateHolderControllerTest extends FunctionalTest
 {
-    protected static $fixture_file = 'EventHolderTest.yml';
+	protected static $fixture_file = 'EventHolderTest.yml';
 
-    protected static $use_draft_site = true;
+	protected static $use_draft_site = true;
 
-    protected function setUp()
-    {
-        parent::setUp();
+	protected function setUp()
+	{
+		parent::setUp();
 
-        // Note: this test requires the starter theme to be installed
-        Config::modify()->set(SSViewer::class, 'themes', ['starter', '$default']);
-        Config::modify()->set(SSViewer::class, 'theme', 'starter');
-    }
+		// Note: this test requires the starter theme to be installed
+		Config::modify()->set(SSViewer::class, 'themes', ['starter', '$default']);
+		Config::modify()->set(SSViewer::class, 'theme', 'starter');
+	}
 
-    public function testSettingDateFiltersInReverseOrderShowsMessage()
-    {
-        /** @var EventHolder $holder */
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testSettingDateFiltersInReverseOrderShowsMessage()
+	{
+		/** @var EventHolder $holder */
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01');
+		$result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01');
 
-        $this->assertContains('Filter has been applied with the dates reversed', $result->getBody());
-    }
+		$this->assertContains('Filter has been applied with the dates reversed', $result->getBody());
+	}
 
-    public function testSettingFromButNotToDateShowsMessage()
-    {
-        /** @var EventHolder $holder */
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+	public function testSettingFromButNotToDateShowsMessage()
+	{
+		/** @var EventHolder $holder */
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
 
-        $result = $this->get($holder->Link() . '?from=2018-01-10');
+		$result = $this->get($holder->Link() . '?from=2018-01-10');
 
-        $this->assertContains('Filtered by a single date', $result->getBody());
-    }
+		$this->assertContains('Filtered by a single date', $result->getBody());
+	}
 
-    public function testInvalidDateFormat()
-    {
-        /** @var EventHolder $holder */
-        $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
-        $result = $this->get($holder->Link() . '?from=christmas&to=2018-01-10');
-        $this->assertContains(htmlentities('Dates must be in "y-MM-dd" format.'), $result->getBody());
-    }
+	public function testInvalidDateFormat()
+	{
+		/** @var EventHolder $holder */
+		$holder = $this->objFromFixture(EventHolder::class, 'EventHolder1');
+		$result = $this->get($holder->Link() . '?from=christmas&to=2018-01-10');
+		$this->assertContains(htmlentities('Dates must be in "y-MM-dd" format.'), $result->getBody());
+	}
 }