silverstripe / cwp

src/PageTypes/DatedUpdateHolderController.php

Indentation +357 added lines, -357 removed lines

@@ -34,361 +34,361 @@
  */
 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;
-        }
-        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');
-        }
-        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;
+		}
+		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');
+		}
+		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();
+	}
 }