silverstripe / cwp

tests/Tasks/PopulateThemeSampleDataTaskTest.php

Indentation +42 added lines, -42 removed lines

@@ -10,46 +10,46 @@
 
 class PopulateThemeSampleDataTaskTest extends SapphireTest
 {
-    protected $usesDatabase = true;
-
-    /**
-     * Ensure that the "contact" user form is only created once
-     */
-    public function testOnlyCreateContactFormOnce()
-    {
-        $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()
+	{
+		$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/PageTypes/FooterHolder.php

Indentation +42 added lines, -42 removed lines

@@ -14,54 +14,54 @@
 class FooterHolder extends RedirectorPage
 {
 
-    private static $description = 'Holder page that displays all child pages as links in the footer';
+	private static $description = 'Holder page that displays all child pages as links in the footer';
 
-    private static $singular_name = 'Footer Holder';
+	private static $singular_name = 'Footer Holder';
 
-    private static $plural_name = 'Footer Holders';
+	private static $plural_name = 'Footer Holders';
 
-    private static $defaults = [
-        'ShowInMenus' => 0,
-        'ShowInSearch' => 0,
-    ];
+	private static $defaults = [
+		'ShowInMenus' => 0,
+		'ShowInSearch' => 0,
+	];
 
-    private static $table_name = 'FooterHolder';
+	private static $table_name = 'FooterHolder';
 
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function (FieldList $fields) {
-            $fields->removeByName('RedirectorDescHeader');
-            $fields->removeByName('RedirectionType');
-            $fields->removeByName('LinkToID');
-            $fields->removeByName('ExternalURL');
-        });
-        return parent::getCMSFields();
-    }
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function (FieldList $fields) {
+			$fields->removeByName('RedirectorDescHeader');
+			$fields->removeByName('RedirectionType');
+			$fields->removeByName('LinkToID');
+			$fields->removeByName('ExternalURL');
+		});
+		return parent::getCMSFields();
+	}
 
-    /**
-     * Return the link to the first child page.
-     */
-    public function redirectionLink()
-    {
-        $childPage = $this->Children()->first();
+	/**
+	 * Return the link to the first child page.
+	 */
+	public function redirectionLink()
+	{
+		$childPage = $this->Children()->first();
 
-        if ($childPage) {
-            // If we're linking to another redirectorpage then just return the URLSegment, to prevent a cycle of
-            // redirector pages from causing an infinite loop.  Instead, they will cause a 30x redirection loop in
-            // the browser, but this can be handled sufficiently gracefully by the browser.
-            if ($childPage instanceof RedirectorPage) {
-                return $childPage->regularLink();
-            }
-            // For all other pages, just return the link of the page.
-            return $childPage->Link();
-        }
-    }
+		if ($childPage) {
+			// If we're linking to another redirectorpage then just return the URLSegment, to prevent a cycle of
+			// redirector pages from causing an infinite loop.  Instead, they will cause a 30x redirection loop in
+			// the browser, but this can be handled sufficiently gracefully by the browser.
+			if ($childPage instanceof RedirectorPage) {
+				return $childPage->regularLink();
+			}
+			// For all other pages, just return the link of the page.
+			return $childPage->Link();
+		}
+	}
 
-    public function syncLinkTracking()
-    {
-        // If we don't have anything to link to, then we have a broken link.
-        if (!$this->Children()) {
-            $this->HasBrokenLink = true;
-        }
-    }
+	public function syncLinkTracking()
+	{
+		// If we don't have anything to link to, then we have a broken link.
+		if (!$this->Children()) {
+			$this->HasBrokenLink = true;
+		}
+	}
 }

src/PageTypes/SitemapPage.php

Indentation +4 added lines, -4 removed lines

@@ -6,11 +6,11 @@
 
 class SitemapPage extends Page
 {
-    private static $description = 'Lists all pages on the site';
+	private static $description = 'Lists all pages on the site';
 
-    private static $singular_name = 'Sitemap Page';
+	private static $singular_name = 'Sitemap Page';
 
-    private static $plural_name = 'Sitemap Pages';
+	private static $plural_name = 'Sitemap Pages';
 
-    private static $table_name = 'SitemapPage';
+	private static $table_name = 'SitemapPage';
 }

src/PageTypes/BaseHomePageController.php

Indentation +15 added lines, -15 removed lines

@@ -6,20 +6,20 @@
 
 class BaseHomePageController extends PageController
 {
-    public function getNewsPage()
-    {
-        return NewsHolder::get_one(NewsHolder::class);
-    }
+	public function getNewsPage()
+	{
+		return NewsHolder::get_one(NewsHolder::class);
+	}
 
-    /**
-     * @param int $amount The amount of items to provide.
-     */
-    public function getNewsItems($amount = 2)
-    {
-        $newsHolder = $this->getNewsPage();
-        if ($newsHolder) {
-            $controller = NewsHolderController::create($newsHolder);
-            return $controller->Updates()->limit($amount);
-        }
-    }
+	/**
+	 * @param int $amount The amount of items to provide.
+	 */
+	public function getNewsItems($amount = 2)
+	{
+		$newsHolder = $this->getNewsPage();
+		if ($newsHolder) {
+			$controller = NewsHolderController::create($newsHolder);
+			return $controller->Updates()->limit($amount);
+		}
+	}
 }

src/PageTypes/DatedUpdateHolder.php

Indentation +243 added lines, -243 removed lines

@@ -17,247 +17,247 @@
 
 class DatedUpdateHolder extends Page
 {
-    /**
-     * Meant as an abstract base class.
-     *
-     * {@inheritDoc}
-     */
-    private static $hide_ancestor = DatedUpdateHolder::class;
-
-    private static $update_name = 'Updates';
-
-    private static $update_class = DatedUpdatePage::class;
-
-    private static $singular_name = 'Dated Update Holder';
-
-    private static $plural_name = 'Dated Update Holders';
-
-    private static $table_name = 'DatedUpdateHolder';
-
-    /**
-     * Find all distinct tags (TaxonomyTerms) associated with the DatedUpdatePages under this holder.
-     */
-    public function UpdateTags()
-    {
-        $siteTree = DataObject::getSchema()->tableName(SiteTree::class);
-        $taxonomy = DataObject::getSchema()->tableName(TaxonomyTerm::class);
-
-        $tags = TaxonomyTerm::get()
-            ->innerJoin('BasePage_Terms', sprintf('"%s"."ID"="BasePage_Terms"."TaxonomyTermID"', $taxonomy))
-            ->innerJoin(
-                $siteTree,
-                sprintf(
-                    '"%s"."ID" = "BasePage_Terms"."BasePageID" AND "%s"."ParentID" = \'%d\'',
-                    $siteTree,
-                    $siteTree,
-                    $this->ID
-                )
-            )
-            ->sort('Name');
-
-        return $tags;
-    }
-
-    /**
-     * Wrapper to find all updates belonging to this holder, based on some filters.
-     */
-    public function Updates($tagID = null, $dateFrom = null, $dateTo = null, $year = null, $monthNumber = null)
-    {
-        $className = Config::inst()->get($this->ClassName, 'update_class');
-        return static::AllUpdates($className, $this->ID, $tagID, $dateFrom, $dateTo, $year, $monthNumber);
-    }
-
-    /**
-     * Find all site's updates, 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|null $parentID The ID of the holder to extract the updates from.
-     * @param int|null $tagID The ID of the tag to filter the updates by.
-     * @param string|null $dateFrom The beginning of a date filter range.
-     * @param string|null $dateTo The end of the date filter range. If empty, only one day will be searched for.
-     * @param int|null $year Numeric value of the year to show.
-     * @param int|null $monthNumber Numeric value of the month to show.
-     *
-     * @returns DataList | PaginatedList
-     */
-    public static function AllUpdates(
-        $className = DatedUpdatePage::class,
-        $parentID = null,
-        $tagID = null,
-        $dateFrom = null,
-        $dateTo = null,
-        $year = null,
-        $monthNumber = null
-    ) {
-
-        $items = $className::get();
-        $dbTableName = DataObject::getSchema()->tableForField($className, 'Date');
-        if (!$dbTableName) {
-            $dbTableName = DatedUpdatePage::class;
-        }
-
-        // Filter by parent holder.
-        if (isset($parentID)) {
-            $items = $items->filter(['ParentID'=>$parentID]);
-        }
-
-        // Filter down to a single tag.
-        if (isset($tagID)) {
-            $taxonomy = DataObject::getSchema()->tableName(TaxonomyTerm::class);
-            $tableName = DataObject::getSchema()->tableName($className);
-
-            $items = $items->innerJoin(
-                'BasePage_Terms',
-                sprintf('"%s"."ID" = "BasePage_Terms"."BasePageID"', $tableName)
-            )->innerJoin(
-                $taxonomy,
-                sprintf(
-                    '"BasePage_Terms"."TaxonomyTermID" = "%s"."ID" AND "TaxonomyTerm"."ID" = \'%d\'',
-                    $taxonomy,
-                    $tagID
-                )
-            );
-        }
-
-        // Filter by date
-        if (isset($dateFrom)) {
-            if (!isset($dateTo)) {
-                $dateTo = $dateFrom;
-            }
-
-            $items = $items->where([
-                sprintf('"%s"."Date" >= \'%s\'', $dbTableName, Convert::raw2sql("$dateFrom 00:00:00")),
-                sprintf('"%s"."Date" <= \'%s\'', $dbTableName, Convert::raw2sql("$dateTo 23:59:59"))
-            ]);
-        }
-
-        // Filter down to single month.
-        if (isset($year) && isset($monthNumber)) {
-            $year = (int)$year;
-            $monthNumber = (int)$monthNumber;
-
-            $beginDate = sprintf("%04d-%02d-01 00:00:00", $year, $monthNumber);
-            $endDate = date('Y-m-d H:i:s', strtotime("{$beginDate} +1 month"));
-
-            $items = $items->where(array(
-                sprintf('"%s"."Date" >= \'%s\'', $dbTableName, Convert::raw2sql($beginDate)),
-                sprintf('"%s"."Date" < \'%s\'', $dbTableName, Convert::raw2sql($endDate))
-            ));
-        }
-
-        // Unpaginated DataList.
-        return $items;
-    }
-
-    /**
-     * Produce an ArrayList of available months out of the updates contained in the DataList.
-     *
-     * Here is an example of the returned structure:
-     * ArrayList:
-     *   ArrayData:
-     *     YearName => 2013
-     *     Months => ArrayList:
-     *       MonthName => Jan
-     *       MonthNumber => 1
-     *       MonthLink => (page URL)year=2012&month=1
-     *       Active => true
-     *   ArrayData:
-     *     YearName => 2012
-     *     Months => ArrayList:
-     *     ...
-     *
-     * @param DataList $updates DataList DataList to extract months from.
-     * @param string $link Link used as abase to construct the MonthLink.
-     * @param int $currentYear Currently selected year, for computing the link active state.
-     * @param int $currentMonthNumber Currently selected month, for computing the link active state.
-     *
-     * @returns ArrayList
-     */
-    public static function ExtractMonths(
-        DataList $updates,
-        $link = null,
-        $currentYear = null,
-        $currentMonthNumber = null
-    ) {
-        // Set the link to current URL in the same way the HTTP::setGetVar does it.
-        if (!isset($link)) {
-            $link = Director::makeRelative($_SERVER['REQUEST_URI']);
-        }
-
-        $dates = $updates->dataQuery()
-            ->groupby('YEAR("Date")')
-            ->groupby('MONTH("Date")')
-            ->query()
-            ->setSelect([
-                'Year' => 'YEAR("Date")',
-                'Month' => 'MONTH("Date")',
-            ])
-            ->addWhere('"Date" IS NOT NULL')
-            ->setOrderBy([
-                'YEAR("Date")' => 'DESC',
-                'MONTH("Date")' => 'DESC',
-            ])
-            ->execute();
-
-        $years = [];
-        foreach ($dates as $date) {
-            $monthNumber = $date['Month'];
-            $year = $date['Year'];
-            $dateObj = new DateTime(implode('-', [$year, $monthNumber, 1]));
-            $monthName = $dateObj->Format('M');
-
-            // Set up the relevant year array, if not yet available.
-            if (!isset($years[$year])) {
-                $years[$year] = ['YearName'=>$year, 'Months' => []];
-            }
-
-            // Check if the currently processed month is the one that is selected via GET params.
-            $active = false;
-            if (isset($year) && isset($monthNumber)) {
-                $active = (((int)$currentYear)==$year && ((int)$currentMonthNumber)==$monthNumber);
-            }
-
-            // Build the link - keep the tag and date filter, but reset the pagination.
-            if ($active) {
-                // Allow clicking to deselect the month.
-                $link = HTTP::setGetVar('month', null, $link, '&');
-                $link = HTTP::setGetVar('year', null, $link, '&');
-            } else {
-                $link = HTTP::setGetVar('month', $monthNumber, $link, '&');
-                $link = HTTP::setGetVar('year', $year, $link, '&');
-            }
-            $link = HTTP::setGetVar('start', null, $link, '&');
-
-            $years[$year]['Months'][$monthNumber] = array(
-                'MonthName'=>$monthName,
-                'MonthNumber'=>$monthNumber,
-                'MonthLink'=>$link,
-                'Active'=>$active
-            );
-        }
-
-        // ArrayList will not recursively walk through the supplied array, so manually build nested ArrayLists.
-        foreach ($years as &$year) {
-            $year['Months'] = new ArrayList($year['Months']);
-        }
-
-        // Reverse the list so the most recent years appear first.
-        return new ArrayList($years);
-    }
-
-    public function getDefaultRSSLink()
-    {
-        return $this->Link('rss');
-    }
-
-    public function getDefaultAtomLink()
-    {
-        return $this->Link('atom');
-    }
-
-    public function getSubscriptionTitle()
-    {
-        return $this->Title;
-    }
+	/**
+	 * Meant as an abstract base class.
+	 *
+	 * {@inheritDoc}
+	 */
+	private static $hide_ancestor = DatedUpdateHolder::class;
+
+	private static $update_name = 'Updates';
+
+	private static $update_class = DatedUpdatePage::class;
+
+	private static $singular_name = 'Dated Update Holder';
+
+	private static $plural_name = 'Dated Update Holders';
+
+	private static $table_name = 'DatedUpdateHolder';
+
+	/**
+	 * Find all distinct tags (TaxonomyTerms) associated with the DatedUpdatePages under this holder.
+	 */
+	public function UpdateTags()
+	{
+		$siteTree = DataObject::getSchema()->tableName(SiteTree::class);
+		$taxonomy = DataObject::getSchema()->tableName(TaxonomyTerm::class);
+
+		$tags = TaxonomyTerm::get()
+			->innerJoin('BasePage_Terms', sprintf('"%s"."ID"="BasePage_Terms"."TaxonomyTermID"', $taxonomy))
+			->innerJoin(
+				$siteTree,
+				sprintf(
+					'"%s"."ID" = "BasePage_Terms"."BasePageID" AND "%s"."ParentID" = \'%d\'',
+					$siteTree,
+					$siteTree,
+					$this->ID
+				)
+			)
+			->sort('Name');
+
+		return $tags;
+	}
+
+	/**
+	 * Wrapper to find all updates belonging to this holder, based on some filters.
+	 */
+	public function Updates($tagID = null, $dateFrom = null, $dateTo = null, $year = null, $monthNumber = null)
+	{
+		$className = Config::inst()->get($this->ClassName, 'update_class');
+		return static::AllUpdates($className, $this->ID, $tagID, $dateFrom, $dateTo, $year, $monthNumber);
+	}
+
+	/**
+	 * Find all site's updates, 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|null $parentID The ID of the holder to extract the updates from.
+	 * @param int|null $tagID The ID of the tag to filter the updates by.
+	 * @param string|null $dateFrom The beginning of a date filter range.
+	 * @param string|null $dateTo The end of the date filter range. If empty, only one day will be searched for.
+	 * @param int|null $year Numeric value of the year to show.
+	 * @param int|null $monthNumber Numeric value of the month to show.
+	 *
+	 * @returns DataList | PaginatedList
+	 */
+	public static function AllUpdates(
+		$className = DatedUpdatePage::class,
+		$parentID = null,
+		$tagID = null,
+		$dateFrom = null,
+		$dateTo = null,
+		$year = null,
+		$monthNumber = null
+	) {
+
+		$items = $className::get();
+		$dbTableName = DataObject::getSchema()->tableForField($className, 'Date');
+		if (!$dbTableName) {
+			$dbTableName = DatedUpdatePage::class;
+		}
+
+		// Filter by parent holder.
+		if (isset($parentID)) {
+			$items = $items->filter(['ParentID'=>$parentID]);
+		}
+
+		// Filter down to a single tag.
+		if (isset($tagID)) {
+			$taxonomy = DataObject::getSchema()->tableName(TaxonomyTerm::class);
+			$tableName = DataObject::getSchema()->tableName($className);
+
+			$items = $items->innerJoin(
+				'BasePage_Terms',
+				sprintf('"%s"."ID" = "BasePage_Terms"."BasePageID"', $tableName)
+			)->innerJoin(
+				$taxonomy,
+				sprintf(
+					'"BasePage_Terms"."TaxonomyTermID" = "%s"."ID" AND "TaxonomyTerm"."ID" = \'%d\'',
+					$taxonomy,
+					$tagID
+				)
+			);
+		}
+
+		// Filter by date
+		if (isset($dateFrom)) {
+			if (!isset($dateTo)) {
+				$dateTo = $dateFrom;
+			}
+
+			$items = $items->where([
+				sprintf('"%s"."Date" >= \'%s\'', $dbTableName, Convert::raw2sql("$dateFrom 00:00:00")),
+				sprintf('"%s"."Date" <= \'%s\'', $dbTableName, Convert::raw2sql("$dateTo 23:59:59"))
+			]);
+		}
+
+		// Filter down to single month.
+		if (isset($year) && isset($monthNumber)) {
+			$year = (int)$year;
+			$monthNumber = (int)$monthNumber;
+
+			$beginDate = sprintf("%04d-%02d-01 00:00:00", $year, $monthNumber);
+			$endDate = date('Y-m-d H:i:s', strtotime("{$beginDate} +1 month"));
+
+			$items = $items->where(array(
+				sprintf('"%s"."Date" >= \'%s\'', $dbTableName, Convert::raw2sql($beginDate)),
+				sprintf('"%s"."Date" < \'%s\'', $dbTableName, Convert::raw2sql($endDate))
+			));
+		}
+
+		// Unpaginated DataList.
+		return $items;
+	}
+
+	/**
+	 * Produce an ArrayList of available months out of the updates contained in the DataList.
+	 *
+	 * Here is an example of the returned structure:
+	 * ArrayList:
+	 *   ArrayData:
+	 *     YearName => 2013
+	 *     Months => ArrayList:
+	 *       MonthName => Jan
+	 *       MonthNumber => 1
+	 *       MonthLink => (page URL)year=2012&month=1
+	 *       Active => true
+	 *   ArrayData:
+	 *     YearName => 2012
+	 *     Months => ArrayList:
+	 *     ...
+	 *
+	 * @param DataList $updates DataList DataList to extract months from.
+	 * @param string $link Link used as abase to construct the MonthLink.
+	 * @param int $currentYear Currently selected year, for computing the link active state.
+	 * @param int $currentMonthNumber Currently selected month, for computing the link active state.
+	 *
+	 * @returns ArrayList
+	 */
+	public static function ExtractMonths(
+		DataList $updates,
+		$link = null,
+		$currentYear = null,
+		$currentMonthNumber = null
+	) {
+		// Set the link to current URL in the same way the HTTP::setGetVar does it.
+		if (!isset($link)) {
+			$link = Director::makeRelative($_SERVER['REQUEST_URI']);
+		}
+
+		$dates = $updates->dataQuery()
+			->groupby('YEAR("Date")')
+			->groupby('MONTH("Date")')
+			->query()
+			->setSelect([
+				'Year' => 'YEAR("Date")',
+				'Month' => 'MONTH("Date")',
+			])
+			->addWhere('"Date" IS NOT NULL')
+			->setOrderBy([
+				'YEAR("Date")' => 'DESC',
+				'MONTH("Date")' => 'DESC',
+			])
+			->execute();
+
+		$years = [];
+		foreach ($dates as $date) {
+			$monthNumber = $date['Month'];
+			$year = $date['Year'];
+			$dateObj = new DateTime(implode('-', [$year, $monthNumber, 1]));
+			$monthName = $dateObj->Format('M');
+
+			// Set up the relevant year array, if not yet available.
+			if (!isset($years[$year])) {
+				$years[$year] = ['YearName'=>$year, 'Months' => []];
+			}
+
+			// Check if the currently processed month is the one that is selected via GET params.
+			$active = false;
+			if (isset($year) && isset($monthNumber)) {
+				$active = (((int)$currentYear)==$year && ((int)$currentMonthNumber)==$monthNumber);
+			}
+
+			// Build the link - keep the tag and date filter, but reset the pagination.
+			if ($active) {
+				// Allow clicking to deselect the month.
+				$link = HTTP::setGetVar('month', null, $link, '&');
+				$link = HTTP::setGetVar('year', null, $link, '&');
+			} else {
+				$link = HTTP::setGetVar('month', $monthNumber, $link, '&');
+				$link = HTTP::setGetVar('year', $year, $link, '&');
+			}
+			$link = HTTP::setGetVar('start', null, $link, '&');
+
+			$years[$year]['Months'][$monthNumber] = array(
+				'MonthName'=>$monthName,
+				'MonthNumber'=>$monthNumber,
+				'MonthLink'=>$link,
+				'Active'=>$active
+			);
+		}
+
+		// ArrayList will not recursively walk through the supplied array, so manually build nested ArrayLists.
+		foreach ($years as &$year) {
+			$year['Months'] = new ArrayList($year['Months']);
+		}
+
+		// Reverse the list so the most recent years appear first.
+		return new ArrayList($years);
+	}
+
+	public function getDefaultRSSLink()
+	{
+		return $this->Link('rss');
+	}
+
+	public function getDefaultAtomLink()
+	{
+		return $this->Link('atom');
+	}
+
+	public function getSubscriptionTitle()
+	{
+		return $this->Title;
+	}
 }

src/Tasks/CleanupGeneratedPdfDailyTask.php

Indentation +5 added lines, -5 removed lines

@@ -7,9 +7,9 @@
 // @todo replace with QueuedJobs
 class CleanupGeneratedPdfDailyTask // extends DailyTask
 {
-    public function process()
-    {
-        $task = new CleanupGeneratedPdfBuildTask();
-        $task->run(null);
-    }
+	public function process()
+	{
+		$task = new CleanupGeneratedPdfBuildTask();
+		$task->run(null);
+	}
 }

src/Tasks/CleanupGeneratedPdfBuildTask.php

Indentation +16 added lines, -16 removed lines

@@ -7,24 +7,24 @@
 
 class CleanupGeneratedPdfBuildTask extends BuildTask
 {
-    protected $title = 'Cleanup generated PDFs';
+	protected $title = 'Cleanup generated PDFs';
 
-    protected $description = 'Removes generated PDFs on the site, forcing a regeneration of all exports to PDF '
-        . 'when users go to download them. This is most useful when templates have been changed so users should '
-        . 'receive a new copy';
+	protected $description = 'Removes generated PDFs on the site, forcing a regeneration of all exports to PDF '
+		. 'when users go to download them. This is most useful when templates have been changed so users should '
+		. 'receive a new copy';
 
-    public function run($request)
-    {
-        $path = sprintf('%s/%s', BASE_PATH, BasePage::config()->generated_pdf_path);
-        if (!file_exists($path)) {
-            return false;
-        }
+	public function run($request)
+	{
+		$path = sprintf('%s/%s', BASE_PATH, BasePage::config()->generated_pdf_path);
+		if (!file_exists($path)) {
+			return false;
+		}
 
-        exec(sprintf('if [ "$(ls -A %s 2> /dev/null)" != "" ]; then rm %s/*; fi', $path, $path), $output, $return_val);
+		exec(sprintf('if [ "$(ls -A %s 2> /dev/null)" != "" ]; then rm %s/*; fi', $path, $path), $output, $return_val);
 
-        // output any errors
-        if ($return_val != 0) {
-            user_error(sprintf('%s failed: ', get_class($this)) . implode("\n", $output), E_USER_ERROR);
-        }
-    }
+		// output any errors
+		if ($return_val != 0) {
+			user_error(sprintf('%s failed: ', get_class($this)) . implode("\n", $output), E_USER_ERROR);
+		}
+	}
 }

src/Search/CwpSearchEngine.php

Indentation +134 added lines, -134 removed lines

@@ -16,138 +16,138 @@
  */
 class CwpSearchEngine
 {
-    use Configurable;
-    use Extensible;
-    use Injectable;
-
-    /**
-     * Default search options
-     *
-     * @var array
-     * @config
-     */
-    private static $search_options = [
-        'hl' => 'true',
-    ];
-
-    /**
-     * Additional search options to send to search when spellcheck
-     * is included
-     *
-     * @var array
-     * @config
-     */
-    private static $spellcheck_options = [
-        'spellcheck' => 'true',
-        'spellcheck.collate' => 'true',
-        // spellcheck.dictionary can also be configured to use '_spellcheck'
-        // dictionary when indexing fields under the _spellcheckText column
-        'spellcheck.dictionary' => 'default',
-    ];
-
-    /**
-     * Build a SearchQuery for a new search
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @return SearchQuery
-     */
-    protected function getSearchQuery($keywords, $classes)
-    {
-        $query = new SearchQuery();
-        $query->classes = $classes;
-        $query->search($keywords);
-        $query->exclude('SiteTree_ShowInSearch', 0);
-        $query->exclude('File_ShowInSearch', 0);
-
-        // Artificially lower the amount of results to prevent too high resource usage.
-        // on subsequent canView check loop.
-        $query->limit(100);
-        return $query;
-    }
-
-    /**
-     * Get solr search options for this query
-     *
-     * @param bool $spellcheck True if we should include spellcheck support
-     * @return array
-     */
-    protected function getSearchOptions($spellcheck)
-    {
-        $options = $this->config()->search_options;
-        if ($spellcheck) {
-            $options = array_merge($options, $this->config()->spellcheck_options);
-        }
-        return $options;
-    }
-
-    /**
-     * Get results for a search term
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @param SolrIndex $searchIndex
-     * @param int $limit Max number of results for this page
-     * @param int $start Skip this number of records
-     * @param bool $spellcheck True to enable spellcheck
-     * @return CwpSearchResult
-     */
-    protected function getResult($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $spellcheck = false)
-    {
-        // Prepare options
-        $query = $this->getSearchQuery($keywords, $classes);
-        $options = $this->getSearchOptions($spellcheck);
-
-        // Get results
-        $solrResult = $searchIndex->search(
-            $query,
-            $start,
-            $limit,
-            $options
-        );
-
-        return CwpSearchResult::create($keywords, $solrResult);
-    }
-
-    /**
-     * Get a CwpSearchResult for a given criterea
-     *
-     * @param string $keywords
-     * @param array $classes
-     * @param SolrIndex $searchIndex
-     * @param int $limit Max number of results for this page
-     * @param int $start Skip this number of records
-     * @param bool $followSuggestions True to enable suggested searches to be returned immediately
-     * @return CwpSearchResult|null
-     */
-    public function search($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $followSuggestions = false)
-    {
-        if (empty($keywords)) {
-            return null;
-        }
-
-        try {
-            // Begin search
-            $result = $this->getResult($keywords, $classes, $searchIndex, $limit, $start, true);
-
-            // Return results if we don't need to refine this any further
-            if (!$followSuggestions || $result->hasResults() || !$result->getSuggestion()) {
-                return $result;
-            }
-
-            // Perform new search with the suggested terms
-            $suggested = $result->getSuggestion();
-            $newResult = $this->getResult($suggested, $classes, $searchIndex, $limit, $start, false);
-            $newResult->setOriginal($keywords);
-
-            // Compare new results to the original query
-            if ($newResult->hasResults()) {
-                return $newResult;
-            } else {
-                return $result;
-            }
-        } catch (Exception $e) {
-            Injector::inst()->get(LoggerInterface::class)->warning($e);
-        }
-    }
+	use Configurable;
+	use Extensible;
+	use Injectable;
+
+	/**
+	 * Default search options
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $search_options = [
+		'hl' => 'true',
+	];
+
+	/**
+	 * Additional search options to send to search when spellcheck
+	 * is included
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $spellcheck_options = [
+		'spellcheck' => 'true',
+		'spellcheck.collate' => 'true',
+		// spellcheck.dictionary can also be configured to use '_spellcheck'
+		// dictionary when indexing fields under the _spellcheckText column
+		'spellcheck.dictionary' => 'default',
+	];
+
+	/**
+	 * Build a SearchQuery for a new search
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @return SearchQuery
+	 */
+	protected function getSearchQuery($keywords, $classes)
+	{
+		$query = new SearchQuery();
+		$query->classes = $classes;
+		$query->search($keywords);
+		$query->exclude('SiteTree_ShowInSearch', 0);
+		$query->exclude('File_ShowInSearch', 0);
+
+		// Artificially lower the amount of results to prevent too high resource usage.
+		// on subsequent canView check loop.
+		$query->limit(100);
+		return $query;
+	}
+
+	/**
+	 * Get solr search options for this query
+	 *
+	 * @param bool $spellcheck True if we should include spellcheck support
+	 * @return array
+	 */
+	protected function getSearchOptions($spellcheck)
+	{
+		$options = $this->config()->search_options;
+		if ($spellcheck) {
+			$options = array_merge($options, $this->config()->spellcheck_options);
+		}
+		return $options;
+	}
+
+	/**
+	 * Get results for a search term
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @param SolrIndex $searchIndex
+	 * @param int $limit Max number of results for this page
+	 * @param int $start Skip this number of records
+	 * @param bool $spellcheck True to enable spellcheck
+	 * @return CwpSearchResult
+	 */
+	protected function getResult($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $spellcheck = false)
+	{
+		// Prepare options
+		$query = $this->getSearchQuery($keywords, $classes);
+		$options = $this->getSearchOptions($spellcheck);
+
+		// Get results
+		$solrResult = $searchIndex->search(
+			$query,
+			$start,
+			$limit,
+			$options
+		);
+
+		return CwpSearchResult::create($keywords, $solrResult);
+	}
+
+	/**
+	 * Get a CwpSearchResult for a given criterea
+	 *
+	 * @param string $keywords
+	 * @param array $classes
+	 * @param SolrIndex $searchIndex
+	 * @param int $limit Max number of results for this page
+	 * @param int $start Skip this number of records
+	 * @param bool $followSuggestions True to enable suggested searches to be returned immediately
+	 * @return CwpSearchResult|null
+	 */
+	public function search($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $followSuggestions = false)
+	{
+		if (empty($keywords)) {
+			return null;
+		}
+
+		try {
+			// Begin search
+			$result = $this->getResult($keywords, $classes, $searchIndex, $limit, $start, true);
+
+			// Return results if we don't need to refine this any further
+			if (!$followSuggestions || $result->hasResults() || !$result->getSuggestion()) {
+				return $result;
+			}
+
+			// Perform new search with the suggested terms
+			$suggested = $result->getSuggestion();
+			$newResult = $this->getResult($suggested, $classes, $searchIndex, $limit, $start, false);
+			$newResult->setOriginal($keywords);
+
+			// Compare new results to the original query
+			if ($newResult->hasResults()) {
+				return $newResult;
+			} else {
+				return $result;
+			}
+		} catch (Exception $e) {
+			Injector::inst()->get(LoggerInterface::class)->warning($e);
+		}
+	}
 }

src/Search/CwpSearchResult.php

Indentation +200 added lines, -200 removed lines

@@ -11,204 +11,204 @@
  */
 class CwpSearchResult extends ViewableData
 {
-    private static $casting = [
-        'Original' => 'Text',
-        'OriginalLink' => 'Text',
-        'Suggestion' => 'Text',
-        'SuggestionLink' => 'Text',
-        'Query' => 'Text',
-        'SearchLink' => 'Text',
-        'RSSLink' => 'Text',
-        'AtomLink' => 'Text',
-    ];
-
-    /**
-     * List of results
-     *
-     * @var PaginatedList
-     */
-    protected $matches;
-
-    /**
-     * Search terms for these results
-     *
-     * @var string
-     */
-    protected $query;
-
-    /**
-     * Suggested search keywords
-     * Used when this search has suggested terms, but following suggestions isn't enabled
-     *
-     * @var string
-     */
-    protected $suggestion;
-
-    /**
-     * Original terms superceded by these result.
-     * Used when a prior search had suggested terms, and follow suggestions is enabled.
-     *
-     * @var PaginatedList
-     */
-    protected $original;
-
-    /**
-     * Create a new CwpSearchResult
-     *
-     * @param string $terms
-     * @param ArrayData $results Result from SolrIndex
-     */
-    public function __construct($terms = '', ArrayData $results = null)
-    {
-        $this->query = $terms;
-        if ($results) {
-            // Clean up the results.
-            $matches = $results->Matches;
-            foreach ($matches as $result) {
-                if (!$result->canView()) {
-                    $matches->remove($result);
-                }
-            }
-
-            $this->matches = $matches;
-            $this->suggestion = $results->SuggestionNice;
-        }
-    }
-
-    /**
-     * Get search results
-     *
-     * @return PaginatedList
-     */
-    public function getResults()
-    {
-        return $this->matches;
-    }
-
-    /**
-     * Check if there are found results
-     *
-     * @return bool
-     */
-    public function hasResults()
-    {
-        return $this->matches && $this->matches->exists();
-    }
-
-    /**
-     * Get search keywords matching these results
-     *
-     * @return string
-     */
-    public function getQuery()
-    {
-        return $this->query;
-    }
-
-    /**
-     * Get suggested search keywords
-     *
-     * @return string
-     */
-    public function getSuggestion()
-    {
-        return $this->suggestion;
-    }
-
-    /**
-     * Get original search keywords superceded by these results
-     *
-     * @return string
-     */
-    public function getOriginal()
-    {
-        return $this->original;
-    }
-
-    /**
-     * Set original keywords
-     *
-     * @param string $original
-     */
-    public function setOriginal($original)
-    {
-        $this->original = $original;
-    }
-
-    /**
-     * Get the link to the suggested search
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getSuggestionLink($format = null)
-    {
-        return $this->getLink($this->suggestion, $format);
-    }
-
-    /**
-     * Gets the link to the given search
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getSearchLink($format = null)
-    {
-        return $this->getLink($this->query, $format);
-    }
-
-    /**
-     * Gets the link to the original search, with suggestions disabled
-     *
-     * @param string $format Optional output format
-     * @return string
-     */
-    public function getOriginalLink($format = null)
-    {
-        return $this->getLink($this->original, $format) . "&suggestions=0";
-    }
-
-    /**
-     * Get link to these results in RSS format
-     *
-     * @return string
-     */
-    public function getRSSLink()
-    {
-        return $this->getLink($this->query, 'rss');
-    }
-
-    /**
-     * Get link to these results in atom format
-     *
-     * @return string
-     */
-    public function getAtomLink()
-    {
-        return $this->getLink($this->query, 'atom');
-    }
-
-    /**
-     * Get a search link for given terms
-     *
-     * @param string $terms
-     * @return string|null
-     */
-    protected function getLink($terms, $format = null)
-    {
-        if (!$terms) {
-            return null;
-        }
-        $link = 'search/SearchForm?Search='.rawurlencode($terms);
-        if ($format) {
-            $link .= '&format='.rawurlencode($format);
-        }
-        return $link;
-    }
-
-    public function hasField($field)
-    {
-        // Fix customise not detecting custom field getters
-        return array_key_exists($field, $this->config()->casting);
-    }
+	private static $casting = [
+		'Original' => 'Text',
+		'OriginalLink' => 'Text',
+		'Suggestion' => 'Text',
+		'SuggestionLink' => 'Text',
+		'Query' => 'Text',
+		'SearchLink' => 'Text',
+		'RSSLink' => 'Text',
+		'AtomLink' => 'Text',
+	];
+
+	/**
+	 * List of results
+	 *
+	 * @var PaginatedList
+	 */
+	protected $matches;
+
+	/**
+	 * Search terms for these results
+	 *
+	 * @var string
+	 */
+	protected $query;
+
+	/**
+	 * Suggested search keywords
+	 * Used when this search has suggested terms, but following suggestions isn't enabled
+	 *
+	 * @var string
+	 */
+	protected $suggestion;
+
+	/**
+	 * Original terms superceded by these result.
+	 * Used when a prior search had suggested terms, and follow suggestions is enabled.
+	 *
+	 * @var PaginatedList
+	 */
+	protected $original;
+
+	/**
+	 * Create a new CwpSearchResult
+	 *
+	 * @param string $terms
+	 * @param ArrayData $results Result from SolrIndex
+	 */
+	public function __construct($terms = '', ArrayData $results = null)
+	{
+		$this->query = $terms;
+		if ($results) {
+			// Clean up the results.
+			$matches = $results->Matches;
+			foreach ($matches as $result) {
+				if (!$result->canView()) {
+					$matches->remove($result);
+				}
+			}
+
+			$this->matches = $matches;
+			$this->suggestion = $results->SuggestionNice;
+		}
+	}
+
+	/**
+	 * Get search results
+	 *
+	 * @return PaginatedList
+	 */
+	public function getResults()
+	{
+		return $this->matches;
+	}
+
+	/**
+	 * Check if there are found results
+	 *
+	 * @return bool
+	 */
+	public function hasResults()
+	{
+		return $this->matches && $this->matches->exists();
+	}
+
+	/**
+	 * Get search keywords matching these results
+	 *
+	 * @return string
+	 */
+	public function getQuery()
+	{
+		return $this->query;
+	}
+
+	/**
+	 * Get suggested search keywords
+	 *
+	 * @return string
+	 */
+	public function getSuggestion()
+	{
+		return $this->suggestion;
+	}
+
+	/**
+	 * Get original search keywords superceded by these results
+	 *
+	 * @return string
+	 */
+	public function getOriginal()
+	{
+		return $this->original;
+	}
+
+	/**
+	 * Set original keywords
+	 *
+	 * @param string $original
+	 */
+	public function setOriginal($original)
+	{
+		$this->original = $original;
+	}
+
+	/**
+	 * Get the link to the suggested search
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getSuggestionLink($format = null)
+	{
+		return $this->getLink($this->suggestion, $format);
+	}
+
+	/**
+	 * Gets the link to the given search
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getSearchLink($format = null)
+	{
+		return $this->getLink($this->query, $format);
+	}
+
+	/**
+	 * Gets the link to the original search, with suggestions disabled
+	 *
+	 * @param string $format Optional output format
+	 * @return string
+	 */
+	public function getOriginalLink($format = null)
+	{
+		return $this->getLink($this->original, $format) . "&suggestions=0";
+	}
+
+	/**
+	 * Get link to these results in RSS format
+	 *
+	 * @return string
+	 */
+	public function getRSSLink()
+	{
+		return $this->getLink($this->query, 'rss');
+	}
+
+	/**
+	 * Get link to these results in atom format
+	 *
+	 * @return string
+	 */
+	public function getAtomLink()
+	{
+		return $this->getLink($this->query, 'atom');
+	}
+
+	/**
+	 * Get a search link for given terms
+	 *
+	 * @param string $terms
+	 * @return string|null
+	 */
+	protected function getLink($terms, $format = null)
+	{
+		if (!$terms) {
+			return null;
+		}
+		$link = 'search/SearchForm?Search='.rawurlencode($terms);
+		if ($format) {
+			$link .= '&format='.rawurlencode($format);
+		}
+		return $link;
+	}
+
+	public function hasField($field)
+	{
+		// Fix customise not detecting custom field getters
+		return array_key_exists($field, $this->config()->casting);
+	}
 }