silverstripe / cwp

tests/PageTypes/DatedUpdateHolderControllerTest.php

Indentation +23 added lines, -23 removed lines

@@ -9,36 +9,36 @@
 
 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());
+	}
 }

tests/PageTypes/SitemapPageTest.php

Indentation +19 added lines, -19 removed lines

@@ -9,27 +9,27 @@
 
 class SitemapPageTest extends FunctionalTest
 {
-    protected static $fixture_file = 'SitemapPageTest.yml';
+	protected static $fixture_file = 'SitemapPageTest.yml';
 
-    protected static $use_draft_site = true;
+	protected static $use_draft_site = true;
 
-    protected function setUp()
-    {
-        parent::setUp();
+	protected function setUp()
+	{
+		parent::setUp();
 
-        Config::modify()->set(SSViewer::class, 'themes', ['starter', '$default']);
-        Config::modify()->set(SSViewer::class, 'theme', 'starter');
-    }
+		Config::modify()->set(SSViewer::class, 'themes', ['starter', '$default']);
+		Config::modify()->set(SSViewer::class, 'theme', 'starter');
+	}
 
-    /**
-     * Note: this test depends on the "starter" theme being installed and configured as default
-     */
-    public function testSitemapShowsNavigationTitleNotNormalTitle()
-    {
-        $response = $this->get('sitemap');
-        $parser = new CSSContentParser($response->getBody());
-        $elements = $parser->getBySelector('.sitemap li.first .sitemap-link');
-        $this->assertNotEmpty($elements);
-        $this->assertEquals('Top page nav 1', (string) $elements[0]);
-    }
+	/**
+	 * Note: this test depends on the "starter" theme being installed and configured as default
+	 */
+	public function testSitemapShowsNavigationTitleNotNormalTitle()
+	{
+		$response = $this->get('sitemap');
+		$parser = new CSSContentParser($response->getBody());
+		$elements = $parser->getBySelector('.sitemap li.first .sitemap-link');
+		$this->assertNotEmpty($elements);
+		$this->assertEquals('Top page nav 1', (string) $elements[0]);
+	}
 }

src/PageTypes/BasePageController.php

Indentation +10 added lines, -10 removed lines

@@ -7,15 +7,15 @@
 
 class BasePageController extends ContentController
 {
-    /**
-     * Provide current year.
-     */
-    public function CurrentDatetime()
-    {
-        return DBDatetime::now();
-    }
+	/**
+	 * Provide current year.
+	 */
+	public function CurrentDatetime()
+	{
+		return DBDatetime::now();
+	}
 
-    public function getRSSLink()
-    {
-    }
+	public function getRSSLink()
+	{
+	}
 }

src/Report/CwpStatsReport.php

Indentation +104 added lines, -104 removed lines

@@ -20,108 +20,108 @@
  */
 class CwpStatsReport extends Report
 {
-    public function title()
-    {
-        return _t(__CLASS__ . '.Title', 'Summary statistics');
-    }
-
-    public function description()
-    {
-        return _t(
-            __CLASS__ . '.Description',
-            'This report provides various statistics for this site. The "total live page count" is the number that ' .
-                'can be compared against the instance size specifications.'
-        );
-    }
-
-    public function columns()
-    {
-        return [
-            'Name' => _t(__CLASS__ . '.Name', 'Name'),
-            'Count' => _t(__CLASS__ . '.Count', 'Count'),
-        ];
-    }
-
-    /**
-     * Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
-     *
-     * {@inheritDoc}
-     */
-    public function sourceRecords($params = [], $sort = null, $limit = null)
-    {
-        $records = [];
-
-        // Get the query to apply across all variants: looks at all subsites, translations, live stage only.
-        $crossVariant = (function ($dataQuery) {
-            $params = [
-                'Subsite.filter' => false,
-                'Versioned.mode' => 'stage',
-                'Versioned.stage' => Versioned::LIVE,
-            ];
-
-            return $dataQuery->setDataQueryParam($params);
-        });
-
-        // Total.
-        $records[] = [
-            'Name' => _t(
-                __CLASS__ . '.TotalPageCount',
-                'Total live page count, across all translations and subsites'
-            ),
-            'Count' => $crossVariant(SiteTree::get())->count(),
-        ];
-
-        if (class_exists(Subsite::class)) {
-            // Main site.
-            $records[] = [
-                'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
-                'Count' => $crossVariant(SiteTree::get())
-                    ->filter(['SubsiteID' => 0])
-                    ->count(),
-            ];
-
-            // Per subsite.
-            $subsites = Subsite::get();
-            foreach ($subsites as $subsite) {
-                $records[] = [
-                    'Name' => _t(
-                        __CLASS__ . '.PagesForSubsite',
-                        "- in the subsite '{SubsiteTitle}'",
-                        ['SubsiteTitle' => $subsite->Title]
-                    ),
-                    'Count' => $crossVariant(SiteTree::get())
-                        ->filter(['SubsiteID' => $subsite->ID])
-                        ->count(),
-                ];
-            }
-        }
-
-        // Files.
-        $records[] = [
-            'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
-            'Count' => File::get()
-                ->setDataQueryParam('Subsite.filter', false)
-                ->filter(['ClassName:not' => Folder::class])
-                ->count(),
-        ];
-
-        return ArrayList::create($records);
-    }
-
-    /**
-     * @return GridField
-     */
-    public function getReportField()
-    {
-        /** @var GridField $gridField */
-        $gridField = parent::getReportField();
-
-        /** @var GridFieldConfig $gridConfig */
-        $gridConfig = $gridField->getConfig();
-        $gridConfig->removeComponentsByType(GridFieldPrintButton::class);
-        $gridConfig->removeComponentsByType(GridFieldExportButton::class);
-        $gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
-
-        return $gridField;
-    }
+	public function title()
+	{
+		return _t(__CLASS__ . '.Title', 'Summary statistics');
+	}
+
+	public function description()
+	{
+		return _t(
+			__CLASS__ . '.Description',
+			'This report provides various statistics for this site. The "total live page count" is the number that ' .
+				'can be compared against the instance size specifications.'
+		);
+	}
+
+	public function columns()
+	{
+		return [
+			'Name' => _t(__CLASS__ . '.Name', 'Name'),
+			'Count' => _t(__CLASS__ . '.Count', 'Count'),
+		];
+	}
+
+	/**
+	 * Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
+	 *
+	 * {@inheritDoc}
+	 */
+	public function sourceRecords($params = [], $sort = null, $limit = null)
+	{
+		$records = [];
+
+		// Get the query to apply across all variants: looks at all subsites, translations, live stage only.
+		$crossVariant = (function ($dataQuery) {
+			$params = [
+				'Subsite.filter' => false,
+				'Versioned.mode' => 'stage',
+				'Versioned.stage' => Versioned::LIVE,
+			];
+
+			return $dataQuery->setDataQueryParam($params);
+		});
+
+		// Total.
+		$records[] = [
+			'Name' => _t(
+				__CLASS__ . '.TotalPageCount',
+				'Total live page count, across all translations and subsites'
+			),
+			'Count' => $crossVariant(SiteTree::get())->count(),
+		];
+
+		if (class_exists(Subsite::class)) {
+			// Main site.
+			$records[] = [
+				'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
+				'Count' => $crossVariant(SiteTree::get())
+					->filter(['SubsiteID' => 0])
+					->count(),
+			];
+
+			// Per subsite.
+			$subsites = Subsite::get();
+			foreach ($subsites as $subsite) {
+				$records[] = [
+					'Name' => _t(
+						__CLASS__ . '.PagesForSubsite',
+						"- in the subsite '{SubsiteTitle}'",
+						['SubsiteTitle' => $subsite->Title]
+					),
+					'Count' => $crossVariant(SiteTree::get())
+						->filter(['SubsiteID' => $subsite->ID])
+						->count(),
+				];
+			}
+		}
+
+		// Files.
+		$records[] = [
+			'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
+			'Count' => File::get()
+				->setDataQueryParam('Subsite.filter', false)
+				->filter(['ClassName:not' => Folder::class])
+				->count(),
+		];
+
+		return ArrayList::create($records);
+	}
+
+	/**
+	 * @return GridField
+	 */
+	public function getReportField()
+	{
+		/** @var GridField $gridField */
+		$gridField = parent::getReportField();
+
+		/** @var GridFieldConfig $gridConfig */
+		$gridConfig = $gridField->getConfig();
+		$gridConfig->removeComponentsByType(GridFieldPrintButton::class);
+		$gridConfig->removeComponentsByType(GridFieldExportButton::class);
+		$gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
+
+		return $gridField;
+	}
 }

tests/Extensions/WorkflowDefinitionExtensionTest.php

Indentation +34 added lines, -34 removed lines

@@ -15,38 +15,38 @@
 class WorkflowDefinitionExtensionTest extends FunctionalTest
 {
 
-    /**
-     * @var Boolean If set to TRUE, this will force a test database to be generated
-     * in {@link setUp()}. Note that this flag is overruled by the presence of a
-     * {@link $fixture_file}, which always forces a database build.
-     */
-    protected $usesDatabase = true;
-
-    /**
-     * Tests the config option that controls the creation of a default workflow definition
-     *
-     * @return void
-     */
-    public function testCreateDefaultWorkflowTest()
-    {
-        if (!class_exists(WorkflowDefinition::class)) {
-            $this->markTestSkipped('This test requires the advancedworkflow module to be installed');
-        }
-
-        DB::quiet();
-
-        // test disabling the default workflow definition
-        Config::modify()->set(CwpWorkflowDefinitionExtension::class, 'create_default_workflow', false);
-        $workflowExtn = Injector::inst()->create(CwpWorkflowDefinitionExtension::class);
-        $workflowExtn->requireDefaultRecords();
-        $definition = WorkflowDefinition::get()->first();
-        $this->assertNull($definition);
-
-        // test enabling the default workflow definition
-        Config::modify()->set(CwpWorkflowDefinitionExtension::class, 'create_default_workflow', true);
-        $workflowExtn = Injector::inst()->create(CwpWorkflowDefinitionExtension::class);
-        $workflowExtn->requireDefaultRecords();
-        $definition = WorkflowDefinition::get()->first();
-        $this->assertNotNull($definition);
-    }
+	/**
+	 * @var Boolean If set to TRUE, this will force a test database to be generated
+	 * in {@link setUp()}. Note that this flag is overruled by the presence of a
+	 * {@link $fixture_file}, which always forces a database build.
+	 */
+	protected $usesDatabase = true;
+
+	/**
+	 * Tests the config option that controls the creation of a default workflow definition
+	 *
+	 * @return void
+	 */
+	public function testCreateDefaultWorkflowTest()
+	{
+		if (!class_exists(WorkflowDefinition::class)) {
+			$this->markTestSkipped('This test requires the advancedworkflow module to be installed');
+		}
+
+		DB::quiet();
+
+		// test disabling the default workflow definition
+		Config::modify()->set(CwpWorkflowDefinitionExtension::class, 'create_default_workflow', false);
+		$workflowExtn = Injector::inst()->create(CwpWorkflowDefinitionExtension::class);
+		$workflowExtn->requireDefaultRecords();
+		$definition = WorkflowDefinition::get()->first();
+		$this->assertNull($definition);
+
+		// test enabling the default workflow definition
+		Config::modify()->set(CwpWorkflowDefinitionExtension::class, 'create_default_workflow', true);
+		$workflowExtn = Injector::inst()->create(CwpWorkflowDefinitionExtension::class);
+		$workflowExtn->requireDefaultRecords();
+		$definition = WorkflowDefinition::get()->first();
+		$this->assertNotNull($definition);
+	}
 }

tests/Tasks/PopulateThemeSampleDataTaskTest.php

Indentation +46 added lines, -46 removed lines

@@ -10,50 +10,50 @@
 
 class PopulateThemeSampleDataTaskTest extends SapphireTest
 {
-    protected $usesDatabase = true;
-
-    /**
-     * Ensure that the "contact" user form is only created once
-     */
-    public function testOnlyCreateContactFormOnce()
-    {
-        if (!class_exists(UserDefinedForm::class)) {
-            $this->markTestSkipped('This test requires the userforms module to be installed');
-        }
-
-        $createdMessage = 'Created "contact" UserDefinedForm';
-
-        $task = new PopulateThemeSampleDataTask;
-
-        // Run the task
-        $this->assertContains($createdMessage, $this->bufferedTask($task));
-
-        // Run a second time
-        $this->assertNotContains($createdMessage, $this->bufferedTask($task));
-
-        // Change the page name
-        $form = UserDefinedForm::get()->filter('URLSegment', 'contact')->first();
-        $form->URLSegment = 'testing';
-        $form->write();
-
-        // Ensure the old version is still detected in draft, so not recreated
-        $this->assertNotContains($createdMessage, $this->bufferedTask($task));
-
-        // Delete the page, then ensure it's recreated again (DataObject::delete will remove staged versions)
-        $form->delete();
-        $this->assertContains($createdMessage, $this->bufferedTask($task));
-    }
-
-    /**
-     * Run a BuildTask while buffering its output, and return the result
-     *
-     * @param  BuildTask $task
-     * @return string
-     */
-    protected function bufferedTask(BuildTask $task)
-    {
-        ob_start();
-        $task->run(new HTTPRequest('GET', '/'));
-        return ob_get_clean();
-    }
+	protected $usesDatabase = true;
+
+	/**
+	 * Ensure that the "contact" user form is only created once
+	 */
+	public function testOnlyCreateContactFormOnce()
+	{
+		if (!class_exists(UserDefinedForm::class)) {
+			$this->markTestSkipped('This test requires the userforms module to be installed');
+		}
+
+		$createdMessage = 'Created "contact" UserDefinedForm';
+
+		$task = new PopulateThemeSampleDataTask;
+
+		// Run the task
+		$this->assertContains($createdMessage, $this->bufferedTask($task));
+
+		// Run a second time
+		$this->assertNotContains($createdMessage, $this->bufferedTask($task));
+
+		// Change the page name
+		$form = UserDefinedForm::get()->filter('URLSegment', 'contact')->first();
+		$form->URLSegment = 'testing';
+		$form->write();
+
+		// Ensure the old version is still detected in draft, so not recreated
+		$this->assertNotContains($createdMessage, $this->bufferedTask($task));
+
+		// Delete the page, then ensure it's recreated again (DataObject::delete will remove staged versions)
+		$form->delete();
+		$this->assertContains($createdMessage, $this->bufferedTask($task));
+	}
+
+	/**
+	 * Run a BuildTask while buffering its output, and return the result
+	 *
+	 * @param  BuildTask $task
+	 * @return string
+	 */
+	protected function bufferedTask(BuildTask $task)
+	{
+		ob_start();
+		$task->run(new HTTPRequest('GET', '/'));
+		return ob_get_clean();
+	}
 }

src/Tasks/PopulateThemeSampleDataTask.php

Indentation +132 added lines, -132 removed lines

@@ -17,136 +17,136 @@
  */
 class PopulateThemeSampleDataTask extends BuildTask
 {
-    protected $title = 'Populate sample data for theme demo';
-
-    protected $description = 'Populates some sample data for showcasing the functionality of the '
-        . 'starter and Wātea themes';
-
-    /**
-     * A series of method calls to create sample data
-     *
-     * @param HTTPRequest $request
-     */
-    public function run($request)
-    {
-        if (!class_exists(UserDefinedForm::class)) {
-            return;
-        }
-        $this->handleContactForm();
-    }
-
-    /**
-     * Decide whether to create a contact user defined form, and call it to be be created if so
-     *
-     * @return $this
-     */
-    protected function handleContactForm()
-    {
-        if (!$this->getContactFormExists()) {
-            $this->createContactForm();
-        }
-        return $this;
-    }
-
-    /**
-     * Determine whether a "contact us" userform exists yet
-     *
-     * @return bool
-     */
-    protected function getContactFormExists()
-    {
-        $exists = false;
-        foreach (UserDefinedForm::get()->column('ID') as $formId) {
-            $count = Versioned::get_all_versions(UserDefinedForm::class, $formId)
-                ->filter('URLSegment', 'contact')
-                ->count();
-
-            if ($count >= 1) {
-                $exists = true;
-                break;
-            }
-        }
-        return $exists;
-    }
-
-    /**
-     * Create a "contact us" userform. Please note that this form does not have any recipients by default, so
-     * no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
-     * tab.
-     *
-     * @return $this
-     */
-    protected function createContactForm()
-    {
-        $form = UserDefinedForm::create(array(
-            'Title' => 'Contact',
-            'URLSegment' => 'contact',
-            'Content' => '<p>$UserDefinedForm</p>',
-            'SubmitButtonText' => 'Submit',
-            'ClearButtonText' => 'Clear',
-            'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
-            'EnableLiveValidation' => true
-        ));
-
-        $form->write();
-
-        // Add form fields
-        $fields = array(
-            EditableFormStep::create([
-                'Title' => _t(
-                    'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
-                    'First Page'
-                )
-            ]),
-            EditableTextField::create([
-                'Title' => 'Name',
-                'Required' => true,
-                'RightTitle' => 'Please enter your first and last name'
-            ]),
-            EditableEmailField::create([
-                'Title' => Email::class,
-                'Required' => true,
-                'Placeholder' => 'example@example.com'
-            ]),
-            EditableTextField::create([
-                'Title' => 'Subject'
-            ]),
-            EditableTextField::create([
-                'Title' => 'Message',
-                'Required' => true,
-                'Rows' => 5
-            ])
-        );
-
-        foreach ($fields as $field) {
-            $field->write();
-            $form->Fields()->add($field);
-            $field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
-        }
-
-        $form->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
-        $form->flushCache();
-
-        $this->output(' + Created "contact" UserDefinedForm page');
-
-        return $this;
-    }
-
-    /**
-     * Output a message either to the console or browser
-     *
-     * @param  string $message
-     * @return $this
-     */
-    protected function output($message)
-    {
-        if (Director::is_cli()) {
-            $message .= PHP_EOL;
-        } else {
-            $message = sprintf('<p>%s</p>', $message);
-        }
-        echo $message;
-
-        return $this;
-    }
+	protected $title = 'Populate sample data for theme demo';
+
+	protected $description = 'Populates some sample data for showcasing the functionality of the '
+		. 'starter and Wātea themes';
+
+	/**
+	 * A series of method calls to create sample data
+	 *
+	 * @param HTTPRequest $request
+	 */
+	public function run($request)
+	{
+		if (!class_exists(UserDefinedForm::class)) {
+			return;
+		}
+		$this->handleContactForm();
+	}
+
+	/**
+	 * Decide whether to create a contact user defined form, and call it to be be created if so
+	 *
+	 * @return $this
+	 */
+	protected function handleContactForm()
+	{
+		if (!$this->getContactFormExists()) {
+			$this->createContactForm();
+		}
+		return $this;
+	}
+
+	/**
+	 * Determine whether a "contact us" userform exists yet
+	 *
+	 * @return bool
+	 */
+	protected function getContactFormExists()
+	{
+		$exists = false;
+		foreach (UserDefinedForm::get()->column('ID') as $formId) {
+			$count = Versioned::get_all_versions(UserDefinedForm::class, $formId)
+				->filter('URLSegment', 'contact')
+				->count();
+
+			if ($count >= 1) {
+				$exists = true;
+				break;
+			}
+		}
+		return $exists;
+	}
+
+	/**
+	 * Create a "contact us" userform. Please note that this form does not have any recipients by default, so
+	 * no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
+	 * tab.
+	 *
+	 * @return $this
+	 */
+	protected function createContactForm()
+	{
+		$form = UserDefinedForm::create(array(
+			'Title' => 'Contact',
+			'URLSegment' => 'contact',
+			'Content' => '<p>$UserDefinedForm</p>',
+			'SubmitButtonText' => 'Submit',
+			'ClearButtonText' => 'Clear',
+			'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
+			'EnableLiveValidation' => true
+		));
+
+		$form->write();
+
+		// Add form fields
+		$fields = array(
+			EditableFormStep::create([
+				'Title' => _t(
+					'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
+					'First Page'
+				)
+			]),
+			EditableTextField::create([
+				'Title' => 'Name',
+				'Required' => true,
+				'RightTitle' => 'Please enter your first and last name'
+			]),
+			EditableEmailField::create([
+				'Title' => Email::class,
+				'Required' => true,
+				'Placeholder' => 'example@example.com'
+			]),
+			EditableTextField::create([
+				'Title' => 'Subject'
+			]),
+			EditableTextField::create([
+				'Title' => 'Message',
+				'Required' => true,
+				'Rows' => 5
+			])
+		);
+
+		foreach ($fields as $field) {
+			$field->write();
+			$form->Fields()->add($field);
+			$field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
+		}
+
+		$form->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
+		$form->flushCache();
+
+		$this->output(' + Created "contact" UserDefinedForm page');
+
+		return $this;
+	}
+
+	/**
+	 * Output a message either to the console or browser
+	 *
+	 * @param  string $message
+	 * @return $this
+	 */
+	protected function output($message)
+	{
+		if (Director::is_cli()) {
+			$message .= PHP_EOL;
+		} else {
+			$message = sprintf('<p>%s</p>', $message);
+		}
+		echo $message;
+
+		return $this;
+	}
 }

src/PageTypes/SitemapPageController.php

Indentation +41 added lines, -41 removed lines

@@ -7,45 +7,45 @@
 
 class SitemapPageController extends PageController
 {
-    private static $allowed_actions = [
-        'showpage',
-    ];
-
-    private static $url_handlers = [
-        'page/$ID' => 'showpage',
-    ];
-
-    public function showpage($request)
-    {
-        $id = (int) $request->param('ID');
-        if (!$id) {
-            return false;
-        }
-        $page = SiteTree::get()->byId($id);
-
-        // does the page exist?
-        if (!($page && $page->exists())) {
-            return $this->httpError(404);
-        }
-
-        // can the page be viewed?
-        if (!$page->canView()) {
-            return $this->httpError(403);
-        }
-
-        $viewer = $this->customise([
-            'IsAjax' => $request->isAjax(),
-            'SelectedPage' => $page,
-            'Children' => $page->Children(),
-        ]);
-
-        if ($request->isAjax()) {
-            return $viewer->renderWith([
-                'type' => 'Includes',
-                'SitemapNodeChildren'
-            ]);
-        }
-
-        return $viewer;
-    }
+	private static $allowed_actions = [
+		'showpage',
+	];
+
+	private static $url_handlers = [
+		'page/$ID' => 'showpage',
+	];
+
+	public function showpage($request)
+	{
+		$id = (int) $request->param('ID');
+		if (!$id) {
+			return false;
+		}
+		$page = SiteTree::get()->byId($id);
+
+		// does the page exist?
+		if (!($page && $page->exists())) {
+			return $this->httpError(404);
+		}
+
+		// can the page be viewed?
+		if (!$page->canView()) {
+			return $this->httpError(403);
+		}
+
+		$viewer = $this->customise([
+			'IsAjax' => $request->isAjax(),
+			'SelectedPage' => $page,
+			'Children' => $page->Children(),
+		]);
+
+		if ($request->isAjax()) {
+			return $viewer->renderWith([
+				'type' => 'Includes',
+				'SitemapNodeChildren'
+			]);
+		}
+
+		return $viewer;
+	}
 }

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();
+	}
 }