silverstripe / cwp

src/PageTypes/EventHolderController.php

Indentation +41 added lines, -41 removed lines

@@ -19,53 +19,53 @@
  */
 class EventHolderController extends DatedUpdateHolderController
 {
-    public function getUpdateName()
-    {
-        $params = $this->parseParams();
-        if ($params['upcomingOnly']) {
-            return _t('CWP\\CWP\\PageTypes\\EventHolder.Upcoming', 'Upcoming events');
-        }
+	public function getUpdateName()
+	{
+		$params = $this->parseParams();
+		if ($params['upcomingOnly']) {
+			return _t('CWP\\CWP\\PageTypes\\EventHolder.Upcoming', 'Upcoming events');
+		}
 
-        return 'Events';
-    }
+		return 'Events';
+	}
 
-    /**
-     * Parse URL parameters.
-     *
-     * @param boolean $produceErrorMessages Set to false to omit session messages.
-     */
-    public function parseParams($produceErrorMessages = true)
-    {
-        $params = parent::parseParams($produceErrorMessages);
+	/**
+	 * Parse URL parameters.
+	 *
+	 * @param boolean $produceErrorMessages Set to false to omit session messages.
+	 */
+	public function parseParams($produceErrorMessages = true)
+	{
+		$params = parent::parseParams($produceErrorMessages);
 
-        // We need to set whether or not we're supposed to be displaying only upcoming events or all events.
-        $params['upcomingOnly'] = !($params['from'] || $params['to'] || $params['year'] || $params['month']);
+		// We need to set whether or not we're supposed to be displaying only upcoming events or all events.
+		$params['upcomingOnly'] = !($params['from'] || $params['to'] || $params['year'] || $params['month']);
 
-        return $params;
-    }
+		return $params;
+	}
 
-    /**
-     * Get the events based on the current query.
-     */
-    public function FilteredUpdates($pageSize = 20)
-    {
-        $params = $this->parseParams();
+	/**
+	 * Get the events 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']
-        );
+		$items = $this->Updates(
+			$params['tag'],
+			$params['from'],
+			$params['to'],
+			$params['year'],
+			$params['month']
+		);
 
-        if ($params['upcomingOnly']) {
-            $items = $items->filter(['Date:LessThan:Not' => DBDatetime::now()->Format('y-MM-dd')]);
-        }
+		if ($params['upcomingOnly']) {
+			$items = $items->filter(['Date:LessThan:Not' => DBDatetime::now()->Format('y-MM-dd')]);
+		}
 
-        // Apply pagination
-        $list = PaginatedList::create($items, $this->getRequest());
-        $list->setPageLength($pageSize);
-        return $list;
-    }
+		// Apply pagination
+		$list = PaginatedList::create($items, $this->getRequest());
+		$list->setPageLength($pageSize);
+		return $list;
+	}
 }

src/PageTypes/EventPage.php

Indentation +77 added lines, -77 removed lines

@@ -12,81 +12,81 @@
 
 class EventPage extends DatedUpdatePage
 {
-    private static $description = 'Describes an event occurring on a specific date.';
-
-    private static $default_parent = EventHolder::class;
-
-    private static $can_be_root = false;
-
-    private static $icon = 'cwp/cwp:images/icons/sitetree_images/event_page.png';
-
-    private static $singular_name = 'Event Page';
-
-    private static $plural_name = 'Event Pages';
-
-    private static $db = [
-        'StartTime' => 'Time',
-        'EndTime' => 'Time',
-        'Location' => 'Text',
-    ];
-
-    private static $table_name = 'EventPage';
-
-    public function fieldLabels($includerelations = true)
-    {
-        $labels = parent::fieldLabels($includerelations);
-        $labels['StartTime'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.StartTimeFieldLabel', 'Start Time');
-        $labels['EndTime'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.EndTimeFieldLabel', 'End Time');
-        $labels['Location'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.LocationFieldLabel', 'Location');
-
-        return $labels;
-    }
-
-    /**
-     * Add the default for the Date being the current day.
-     */
-    public function populateDefaults()
-    {
-        if (!isset($this->Date) || $this->Date === null) {
-            $this->Date = DBDatetime::now()->Format('y-MM-dd');
-        }
-
-        if (!isset($this->StartTime) || $this->StartTime === null) {
-            $this->StartTime = '09:00:00';
-        }
-
-        if (!isset($this->EndTime) || $this->EndTime === null) {
-            $this->EndTime = '17:00:00';
-        }
-
-        parent::populateDefaults();
-    }
-
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function (FieldList $fields) {
-            $fields->removeByName('Date');
-
-            $dateTimeFields = array();
-
-            $dateTimeFields[] = $dateField = DateField::create('Date', 'Date');
-            $dateTimeFields[] = $startTimeField = TimeField::create(
-                'StartTime',
-                '  ' . $this->fieldLabel('StartTime')
-            );
-            $dateTimeFields[] = $endTimeField = TimeField::create('EndTime', $this->fieldLabel('EndTime'));
-
-            $fields->addFieldsToTab('Root.Main', [
-                $dateTimeField = FieldGroup::create('Date and time', $dateTimeFields),
-                $locationField = TextareaField::create('Location', $this->fieldLabel('Location'))
-            ], 'Abstract');
-            $locationField->setRows(4);
-        });
-        return parent::getCMSFields();
-    }
-
-    public function NiceLocation()
-    {
-        return nl2br(Convert::raw2xml($this->Location), true);
-    }
+	private static $description = 'Describes an event occurring on a specific date.';
+
+	private static $default_parent = EventHolder::class;
+
+	private static $can_be_root = false;
+
+	private static $icon = 'cwp/cwp:images/icons/sitetree_images/event_page.png';
+
+	private static $singular_name = 'Event Page';
+
+	private static $plural_name = 'Event Pages';
+
+	private static $db = [
+		'StartTime' => 'Time',
+		'EndTime' => 'Time',
+		'Location' => 'Text',
+	];
+
+	private static $table_name = 'EventPage';
+
+	public function fieldLabels($includerelations = true)
+	{
+		$labels = parent::fieldLabels($includerelations);
+		$labels['StartTime'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.StartTimeFieldLabel', 'Start Time');
+		$labels['EndTime'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.EndTimeFieldLabel', 'End Time');
+		$labels['Location'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.LocationFieldLabel', 'Location');
+
+		return $labels;
+	}
+
+	/**
+	 * Add the default for the Date being the current day.
+	 */
+	public function populateDefaults()
+	{
+		if (!isset($this->Date) || $this->Date === null) {
+			$this->Date = DBDatetime::now()->Format('y-MM-dd');
+		}
+
+		if (!isset($this->StartTime) || $this->StartTime === null) {
+			$this->StartTime = '09:00:00';
+		}
+
+		if (!isset($this->EndTime) || $this->EndTime === null) {
+			$this->EndTime = '17:00:00';
+		}
+
+		parent::populateDefaults();
+	}
+
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function (FieldList $fields) {
+			$fields->removeByName('Date');
+
+			$dateTimeFields = array();
+
+			$dateTimeFields[] = $dateField = DateField::create('Date', 'Date');
+			$dateTimeFields[] = $startTimeField = TimeField::create(
+				'StartTime',
+				'  ' . $this->fieldLabel('StartTime')
+			);
+			$dateTimeFields[] = $endTimeField = TimeField::create('EndTime', $this->fieldLabel('EndTime'));
+
+			$fields->addFieldsToTab('Root.Main', [
+				$dateTimeField = FieldGroup::create('Date and time', $dateTimeFields),
+				$locationField = TextareaField::create('Location', $this->fieldLabel('Location'))
+			], 'Abstract');
+			$locationField->setRows(4);
+		});
+		return parent::getCMSFields();
+	}
+
+	public function NiceLocation()
+	{
+		return nl2br(Convert::raw2xml($this->Location), true);
+	}
 }

src/PageTypes/BaseHomePage.php

Indentation +133 added lines, -133 removed lines

@@ -26,137 +26,137 @@
  */
 class BaseHomePage extends Page
 {
-    private static $icon = 'cwp/cwp:images/icons/sitetree_images/home.png';
-
-    private static $hide_ancestor = BaseHomePage::class;
-
-    private static $singular_name = 'Home Page';
-
-    private static $plural_name = 'Home Pages';
-
-    private static $table_name = 'BaseHomePage';
-
-    private static $db = array(
-        'FeatureOneTitle' => 'Varchar(255)',
-        'FeatureOneCategory' => "Enum('bell,comments,film,flag,globe,group,list,phone,rss,time,user','comments')",
-        'FeatureOneContent' => 'HTMLText',
-        'FeatureOneButtonText' => 'Varchar(255)',
-        'FeatureTwoTitle' => 'Varchar(255)',
-        'FeatureTwoCategory' => "Enum('bell,comments,film,flag,globe,group,list,phone,rss,time,user','comments')",
-        'FeatureTwoContent' => 'HTMLText',
-        'FeatureTwoButtonText' => 'Varchar(255)'
-    );
-
-    private static $has_one = array(
-        'LearnMorePage' => SiteTree::class,
-        'FeatureOneLink' => SiteTree::class,
-        'FeatureTwoLink' => SiteTree::class
-    );
-
-    private static $has_many = array(
-        'Quicklinks' => 'Quicklink.Parent'
-    );
-
-    public function Quicklinks()
-    {
-        return $this->getComponents('Quicklinks')->sort('SortOrder');
-    }
-
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function (FieldList $fields) {
-            // Main Content tab
-            $fields->addFieldToTab(
-                'Root.Main',
-                TreeDropdownField::create(
-                    'LearnMorePageID',
-                    _t(__CLASS__ . '.LearnMoreLink', 'Page to link the "Learn More" button to:'),
-                    SiteTree::class
-                ),
-                'Metadata'
-            );
-
-            $gridField = GridField::create(
-                'Quicklinks',
-                'Quicklinks',
-                $this->Quicklinks(),
-                GridFieldConfig_RelationEditor::create()
-            );
-            $gridConfig = $gridField->getConfig();
-            $gridConfig->getComponentByType(GridFieldAddNewButton::class)->setButtonName(
-                _t(__CLASS__ . '.AddNewButton', 'Add new')
-            );
-
-            $injector = Injector::inst();
-
-            $gridConfig->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
-            $gridConfig->removeComponentsByType(GridFieldDeleteAction::class);
-            $gridConfig->addComponent($injector->create(GridFieldDeleteAction::class));
-            $gridConfig->addComponent($injector->create(GridFieldSortableRows::class, 'SortOrder'));
-            $gridField->setModelClass(Quicklink::class);
-
-            $fields->addFieldToTab('Root.Quicklinks', $gridField);
-
-            $fields->removeByName('Import');
-
-            $fields->addFieldToTab(
-                'Root.Features',
-                ToggleCompositeField::create(
-                    'FeatureOne',
-                    _t(__CLASS__ . '.FeatureOne', 'Feature One'),
-                    array(
-                        TextField::create('FeatureOneTitle', _t(__CLASS__ . '.Title', 'Title')),
-                        $dropdownField = DropdownField::create(
-                            'FeatureOneCategory',
-                            _t(__CLASS__ . '.FeatureCategoryDropdown', 'Category icon'),
-                            singleton(BaseHomePage::class)->dbObject('FeatureOneCategory')->enumValues()
-                        ),
-                        HTMLEditorField::create(
-                            'FeatureOneContent',
-                            _t(__CLASS__ . '.FeatureContentFieldLabel', 'Content')
-                        ),
-                        TextField::create(
-                            'FeatureOneButtonText',
-                            _t(__CLASS__ . '.FeatureButtonText', 'Button text')
-                        ),
-                        TreeDropdownField::create(
-                            'FeatureOneLinkID',
-                            _t(__CLASS__ . '.FeatureLink', 'Page to link to'),
-                            SiteTree::class
-                        )->setDescription(_t(__CLASS__ . '.ButtonTextRequired', 'Button text must be filled in'))
-                    )
-                )->setHeadingLevel(3)
-            );
-            $dropdownField->setEmptyString('none');
-
-            $fields->addFieldToTab('Root.Features', ToggleCompositeField::create(
-                'FeatureTwo',
-                _t(__CLASS__ . '.FeatureTwo', 'Feature Two'),
-                array(
-                    TextField::create('FeatureTwoTitle', _t(__CLASS__ . '.Title', 'Title')),
-                    $dropdownField = DropdownField::create(
-                        'FeatureTwoCategory',
-                        _t(__CLASS__ . '.FeatureCategoryDropdown', 'Category icon'),
-                        singleton(BaseHomePage::class)->dbObject('FeatureTwoCategory')->enumValues()
-                    ),
-                    HTMLEditorField::create(
-                        'FeatureTwoContent',
-                        _t(__CLASS__ . '.FeatureContentFieldLabel', 'Content')
-                    ),
-                    TextField::create(
-                        'FeatureTwoButtonText',
-                        _t(__CLASS__ . '.FeatureButtonText', 'Button text')
-                    ),
-                    TreeDropdownField::create(
-                        'FeatureTwoLinkID',
-                        _t(__CLASS__ . '.FeatureLink', 'Page to link to'),
-                        SiteTree::class
-                    )->setDescription(_t(__CLASS__ . '.ButtonTextRequired', 'Button text must be filled in'))
-                )
-            )->setHeadingLevel(3));
-            $dropdownField->setEmptyString('none');
-        });
-
-        return parent::getCMSFields();
-    }
+	private static $icon = 'cwp/cwp:images/icons/sitetree_images/home.png';
+
+	private static $hide_ancestor = BaseHomePage::class;
+
+	private static $singular_name = 'Home Page';
+
+	private static $plural_name = 'Home Pages';
+
+	private static $table_name = 'BaseHomePage';
+
+	private static $db = array(
+		'FeatureOneTitle' => 'Varchar(255)',
+		'FeatureOneCategory' => "Enum('bell,comments,film,flag,globe,group,list,phone,rss,time,user','comments')",
+		'FeatureOneContent' => 'HTMLText',
+		'FeatureOneButtonText' => 'Varchar(255)',
+		'FeatureTwoTitle' => 'Varchar(255)',
+		'FeatureTwoCategory' => "Enum('bell,comments,film,flag,globe,group,list,phone,rss,time,user','comments')",
+		'FeatureTwoContent' => 'HTMLText',
+		'FeatureTwoButtonText' => 'Varchar(255)'
+	);
+
+	private static $has_one = array(
+		'LearnMorePage' => SiteTree::class,
+		'FeatureOneLink' => SiteTree::class,
+		'FeatureTwoLink' => SiteTree::class
+	);
+
+	private static $has_many = array(
+		'Quicklinks' => 'Quicklink.Parent'
+	);
+
+	public function Quicklinks()
+	{
+		return $this->getComponents('Quicklinks')->sort('SortOrder');
+	}
+
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function (FieldList $fields) {
+			// Main Content tab
+			$fields->addFieldToTab(
+				'Root.Main',
+				TreeDropdownField::create(
+					'LearnMorePageID',
+					_t(__CLASS__ . '.LearnMoreLink', 'Page to link the "Learn More" button to:'),
+					SiteTree::class
+				),
+				'Metadata'
+			);
+
+			$gridField = GridField::create(
+				'Quicklinks',
+				'Quicklinks',
+				$this->Quicklinks(),
+				GridFieldConfig_RelationEditor::create()
+			);
+			$gridConfig = $gridField->getConfig();
+			$gridConfig->getComponentByType(GridFieldAddNewButton::class)->setButtonName(
+				_t(__CLASS__ . '.AddNewButton', 'Add new')
+			);
+
+			$injector = Injector::inst();
+
+			$gridConfig->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
+			$gridConfig->removeComponentsByType(GridFieldDeleteAction::class);
+			$gridConfig->addComponent($injector->create(GridFieldDeleteAction::class));
+			$gridConfig->addComponent($injector->create(GridFieldSortableRows::class, 'SortOrder'));
+			$gridField->setModelClass(Quicklink::class);
+
+			$fields->addFieldToTab('Root.Quicklinks', $gridField);
+
+			$fields->removeByName('Import');
+
+			$fields->addFieldToTab(
+				'Root.Features',
+				ToggleCompositeField::create(
+					'FeatureOne',
+					_t(__CLASS__ . '.FeatureOne', 'Feature One'),
+					array(
+						TextField::create('FeatureOneTitle', _t(__CLASS__ . '.Title', 'Title')),
+						$dropdownField = DropdownField::create(
+							'FeatureOneCategory',
+							_t(__CLASS__ . '.FeatureCategoryDropdown', 'Category icon'),
+							singleton(BaseHomePage::class)->dbObject('FeatureOneCategory')->enumValues()
+						),
+						HTMLEditorField::create(
+							'FeatureOneContent',
+							_t(__CLASS__ . '.FeatureContentFieldLabel', 'Content')
+						),
+						TextField::create(
+							'FeatureOneButtonText',
+							_t(__CLASS__ . '.FeatureButtonText', 'Button text')
+						),
+						TreeDropdownField::create(
+							'FeatureOneLinkID',
+							_t(__CLASS__ . '.FeatureLink', 'Page to link to'),
+							SiteTree::class
+						)->setDescription(_t(__CLASS__ . '.ButtonTextRequired', 'Button text must be filled in'))
+					)
+				)->setHeadingLevel(3)
+			);
+			$dropdownField->setEmptyString('none');
+
+			$fields->addFieldToTab('Root.Features', ToggleCompositeField::create(
+				'FeatureTwo',
+				_t(__CLASS__ . '.FeatureTwo', 'Feature Two'),
+				array(
+					TextField::create('FeatureTwoTitle', _t(__CLASS__ . '.Title', 'Title')),
+					$dropdownField = DropdownField::create(
+						'FeatureTwoCategory',
+						_t(__CLASS__ . '.FeatureCategoryDropdown', 'Category icon'),
+						singleton(BaseHomePage::class)->dbObject('FeatureTwoCategory')->enumValues()
+					),
+					HTMLEditorField::create(
+						'FeatureTwoContent',
+						_t(__CLASS__ . '.FeatureContentFieldLabel', 'Content')
+					),
+					TextField::create(
+						'FeatureTwoButtonText',
+						_t(__CLASS__ . '.FeatureButtonText', 'Button text')
+					),
+					TreeDropdownField::create(
+						'FeatureTwoLinkID',
+						_t(__CLASS__ . '.FeatureLink', 'Page to link to'),
+						SiteTree::class
+					)->setDescription(_t(__CLASS__ . '.ButtonTextRequired', 'Button text must be filled in'))
+				)
+			)->setHeadingLevel(3));
+			$dropdownField->setEmptyString('none');
+		});
+
+		return parent::getCMSFields();
+	}
 }

src/PageTypes/NewsPage.php

Indentation +39 added lines, -39 removed lines

@@ -9,55 +9,55 @@
 
 class NewsPage extends DatedUpdatePage
 {
-    private static $description = 'Describes an item of news';
+	private static $description = 'Describes an item of news';
 
-    private static $default_parent = 'NewsHolderPage';
+	private static $default_parent = 'NewsHolderPage';
 
-    private static $can_be_root = false;
+	private static $can_be_root = false;
 
-    private static $icon = 'cwp/cwp:images/icons/sitetree_images/news.png';
+	private static $icon = 'cwp/cwp:images/icons/sitetree_images/news.png';
 
-    private static $singular_name = 'News Page';
+	private static $singular_name = 'News Page';
 
-    private static $plural_name = 'News Pages';
+	private static $plural_name = 'News Pages';
 
-    private static $db = [
-        'Author' => 'Varchar(255)',
-    ];
+	private static $db = [
+		'Author' => 'Varchar(255)',
+	];
 
-    private static $has_one = [
-        'FeaturedImage' => Image::class,
-    ];
+	private static $has_one = [
+		'FeaturedImage' => Image::class,
+	];
 
-    private static $table_name = 'NewsPage';
+	private static $table_name = 'NewsPage';
 
-    public function fieldLabels($includerelations = true)
-    {
-        $labels = parent::fieldLabels($includerelations);
-        $labels['Author'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.AuthorFieldLabel', 'Author');
-        $labels['FeaturedImageID'] = _t(
-            'CWP\\CWP\\PageTypes\\DateUpdatePage.FeaturedImageFieldLabel',
-            'Featured Image'
-        );
+	public function fieldLabels($includerelations = true)
+	{
+		$labels = parent::fieldLabels($includerelations);
+		$labels['Author'] = _t('CWP\\CWP\\PageTypes\\DateUpdatePage.AuthorFieldLabel', 'Author');
+		$labels['FeaturedImageID'] = _t(
+			'CWP\\CWP\\PageTypes\\DateUpdatePage.FeaturedImageFieldLabel',
+			'Featured Image'
+		);
 
-        return $labels;
-    }
+		return $labels;
+	}
 
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function (FieldList $fields) {
-            $fields->addFieldToTab(
-                'Root.Main',
-                TextField::create('Author', $this->fieldLabel('Author')),
-                'Abstract'
-            );
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function (FieldList $fields) {
+			$fields->addFieldToTab(
+				'Root.Main',
+				TextField::create('Author', $this->fieldLabel('Author')),
+				'Abstract'
+			);
 
-            $fields->addFieldToTab(
-                'Root.Main',
-                UploadField::create('FeaturedImage', $this->fieldLabel('FeaturedImageID')),
-                'Abstract'
-            );
-        });
-        return parent::getCMSFields();
-    }
+			$fields->addFieldToTab(
+				'Root.Main',
+				UploadField::create('FeaturedImage', $this->fieldLabel('FeaturedImageID')),
+				'Abstract'
+			);
+		});
+		return parent::getCMSFields();
+	}
 }

src/PageTypes/BasePageController.php

Indentation +319 added lines, -319 removed lines

@@ -23,329 +23,329 @@
 
 class BasePageController extends ContentController
 {
-    private static $allowed_actions = [
-        'downloadpdf',
-        'SearchForm',
-        'results',
-    ];
-
-    /**
-     * How many search results should be shown per-page?
-     * @var int
-     */
-    public static $results_per_page = 10;
-
-    public static $search_index_class = CwpSolrIndex::class;
-
-    /**
-     * If spelling suggestions for searches are given, enable
-     * suggested searches to be followed immediately
-     *
-     * @config
-     * @var bool
-     */
-    private static $search_follow_suggestions = true;
-
-    /**
-     * Which classes should be queried when searching?
-     * @var array
-     */
-    public static $classes_to_search = [
-        [
-            'class' => 'Page',
-            'includeSubclasses' => true,
-        ]
-    ];
-
-    /**
-     * Serve the page rendered as PDF.
-     */
-    public function downloadpdf()
-    {
-        if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
-            return false;
-        }
-
-        // We only allow producing live pdf. There is no way to secure the draft files.
-        Versioned::set_stage(Versioned::LIVE);
-
-        $path = $this->dataRecord->getPdfFilename();
-        if (!file_exists($path)) {
-            $this->generatePDF();
-        }
-
-        return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf');
-    }
-
-    /*
+	private static $allowed_actions = [
+		'downloadpdf',
+		'SearchForm',
+		'results',
+	];
+
+	/**
+	 * How many search results should be shown per-page?
+	 * @var int
+	 */
+	public static $results_per_page = 10;
+
+	public static $search_index_class = CwpSolrIndex::class;
+
+	/**
+	 * If spelling suggestions for searches are given, enable
+	 * suggested searches to be followed immediately
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $search_follow_suggestions = true;
+
+	/**
+	 * Which classes should be queried when searching?
+	 * @var array
+	 */
+	public static $classes_to_search = [
+		[
+			'class' => 'Page',
+			'includeSubclasses' => true,
+		]
+	];
+
+	/**
+	 * Serve the page rendered as PDF.
+	 */
+	public function downloadpdf()
+	{
+		if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
+			return false;
+		}
+
+		// We only allow producing live pdf. There is no way to secure the draft files.
+		Versioned::set_stage(Versioned::LIVE);
+
+		$path = $this->dataRecord->getPdfFilename();
+		if (!file_exists($path)) {
+			$this->generatePDF();
+		}
+
+		return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf');
+	}
+
+	/*
     * This will return either pdf_base_url from YML, CWP_SECURE_DOMAIN
     * from _ss_environment, or blank. In that order of importance.
     */
-    public function getPDFBaseURL()
-    {
-        //if base url YML is defined in YML, use that
-        if (Config::inst()->get(BasePage::class, 'pdf_base_url')) {
-            $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/';
-            //otherwise, if we are CWP use the secure domain
-        } elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) {
-            $pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/';
-            //or if neither, leave blank
-        } else {
-            $pdfBaseUrl = '';
-        }
-        return $pdfBaseUrl;
-    }
-
-    /*
+	public function getPDFBaseURL()
+	{
+		//if base url YML is defined in YML, use that
+		if (Config::inst()->get(BasePage::class, 'pdf_base_url')) {
+			$pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/';
+			//otherwise, if we are CWP use the secure domain
+		} elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) {
+			$pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/';
+			//or if neither, leave blank
+		} else {
+			$pdfBaseUrl = '';
+		}
+		return $pdfBaseUrl;
+	}
+
+	/*
     * Don't use the proxy if the pdf domain is the CWP secure domain
     * Or if we aren't on a CWP server
     */
-    public function getPDFProxy($pdfBaseUrl)
-    {
-        if (!Environment::getEnv('CWP_SECURE_DOMAIN')
-            || $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/'
-        ) {
-            $proxy = '';
-        } else {
-            $proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY')
-                . ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
-        }
-        return $proxy;
-    }
-
-    /**
-     * Render the page as PDF using wkhtmltopdf.
-     */
-    public function generatePDF()
-    {
-        if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
-            return false;
-        }
-
-        $binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary');
-        if (!$binaryPath || !is_executable($binaryPath)) {
-            if (Environment::getEnv('WKHTMLTOPDF_BINARY')
-                && is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY'))
-            ) {
-                $binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY');
-            }
-        }
-
-        if (!$binaryPath) {
-            user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR);
-        }
-
-        if (Versioned::get_reading_mode() == 'Stage.Stage') {
-            user_error('Generating PDFs on draft is not supported', E_USER_ERROR);
-        }
-
-        set_time_limit(60);
-
-        // prepare the paths
-        $pdfFile = $this->dataRecord->getPdfFilename();
-        $bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile);
-        $footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile);
-
-        // make sure the work directory exists
-        if (!file_exists(dirname($pdfFile))) {
-            Filesystem::makeFolder(dirname($pdfFile));
-        }
-
-        //decide the domain to use in generation
-        $pdfBaseUrl = $this->getPDFBaseURL();
-
-        // Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway.
-        if (Environment::getEnv('CWP_ENVIRONMENT')) {
-            Config::modify()->set(Director::class, 'alternate_protocol', 'http');
-            //only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is
-            if ($pdfBaseUrl) {
-                Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl);
-            }
-        }
-
-        $bodyViewer = $this->getViewer('pdf');
-
-        // write the output of this page to HTML, ready for conversion to PDF
-        file_put_contents($bodyFile, $bodyViewer->process($this));
-
-        // get the viewer for the current template with _pdffooter
-        $footerViewer = $this->getViewer('pdffooter');
-
-        // write the output of the footer template to HTML, ready for conversion to PDF
-        file_put_contents($footerFile, $footerViewer->process($this));
-
-        //decide what the proxy should look like
-        $proxy = $this->getPDFProxy($pdfBaseUrl);
-
-        // finally, generate the PDF
-        $command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 '
-            . '--orientation Portrait --disable-javascript --quiet --print-media-type ';
-        $retVal = 0;
-        $output = array();
-        exec(
-            $command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout",
-            $output,
-            $retVal
-        );
-
-        // remove temporary file
-        unlink($bodyFile);
-        unlink($footerFile);
-
-        // output any errors
-        if ($retVal != 0) {
-            user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR);
-        }
-
-        // serve the generated file
-        return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf');
-    }
-
-    /**
-     * Site search form
-     */
-    public function SearchForm()
-    {
-        $searchText = $this->getRequest()->getVar('Search');
-
-        $fields = FieldList::create(
-            TextField::create('Search', false, $searchText)
-        );
-        $actions = FieldList::create(
-            FormAction::create('results', _t('SilverStripe\\CMS\\Search\\SearchForm.GO', 'Go'))
-        );
-
-        $form = SearchForm::create($this, SearchForm::class, $fields, $actions);
-        $form->setFormAction('search/SearchForm');
-
-        return $form;
-    }
-
-    /**
-     * Get search form with _header suffix
-     *
-     * @return SearchForm
-     */
-    public function HeaderSearchForm()
-    {
-        return $this->SearchForm()->setTemplate('SearchForm_header');
-    }
-
-    /**
-     * Process and render search results.
-     *
-     * @param array $data The raw request data submitted by user
-     * @param SearchForm $form The form instance that was submitted
-     * @param HTTPRequest $request Request generated for this action
-     * @return DBHTMLText
-     */
-    public function results($data, $form, $request)
-    {
-        // Check parameters for terms, pagination, and if we should follow suggestions
-        $keywords = empty($data['Search']) ? '' : $data['Search'];
-        $start = isset($data['start']) ? $data['start'] : 0;
-        $suggestions = isset($data['suggestions'])
-            ? $data['suggestions']
-            : $this->config()->search_follow_suggestions;
-
-        $results = CwpSearchEngine::create()
-            ->search(
-                $keywords,
-                $this->getClassesToSearch(),
-                $this->getSearchIndex(),
-                $this->getSearchPageSize(),
-                $start,
-                $suggestions
-            );
-
-        // Customise content with these results
-        $properties = [
-            'MetaTitle' => _t(__CLASS__ . '.MetaTitle', 'Search {keywords}', ['keywords' => $keywords]),
-            'NoSearchResults' => _t(__CLASS__ . '.NoResult', 'Sorry, your search query did not return any results.'),
-            'EmptySearch' => _t(__CLASS__ . '.EmptySearch', 'Search field empty, please enter your search query.'),
-            'PdfLink' => '',
-            'Title' => _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results'),
-        ];
-        $this->extend('updateSearchResults', $results, $properties);
-
-        // Customise page
-        $response = $this->customise($properties);
-        if ($results) {
-            $response = $response
-                ->customise($results)
-                ->customise(array( 'Results' => $results->getResults() ));
-        }
-
-        // Render
-        $templates = $this->getResultsTemplate($request);
-        return $response->renderWith($templates);
-    }
-
-    /**
-     * Select the template to render search results with
-     *
-     * @param HTTPRequest $request
-     * @return array
-     */
-    protected function getResultsTemplate($request)
-    {
-        $templates = [Page::class . '_results', Page::class];
-        if ($request->getVar('format') == 'rss') {
-            array_unshift($templates, 'Page_results_rss');
-        }
-        if ($request->getVar('format') == 'atom') {
-            array_unshift($templates, 'Page_results_atom');
-        }
-        return $templates;
-    }
-
-    /**
-     * Provide current year.
-     */
-    public function CurrentDatetime()
-    {
-        return DBDatetime::now();
-    }
-
-    public function getRSSLink()
-    {
-    }
-
-    /**
-     * Get the search index registered for this application
-     *
-     * @return CwpSearchIndex
-     */
-    protected function getSearchIndex()
-    {
-        // Will be a service name in 2.0 and returned via injector
-        /** @var CwpSearchIndex $index */
-        $index = null;
-        if (self::$search_index_class) {
-            $index = Injector::inst()->get(self::$search_index_class);
-        }
-        return $index;
-    }
-
-    /**
-     * Gets the list of configured classes to search
-     *
-     * @return array
-     */
-    protected function getClassesToSearch()
-    {
-        // Will be private static config in 2.0
-        return self::$classes_to_search;
-    }
-
-    /**
-     * Get page size for search
-     *
-     * @return int
-     */
-    protected function getSearchPageSize()
-    {
-        // Will be private static config in 2.0
-        return self::$results_per_page;
-    }
+	public function getPDFProxy($pdfBaseUrl)
+	{
+		if (!Environment::getEnv('CWP_SECURE_DOMAIN')
+			|| $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/'
+		) {
+			$proxy = '';
+		} else {
+			$proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY')
+				. ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
+		}
+		return $proxy;
+	}
+
+	/**
+	 * Render the page as PDF using wkhtmltopdf.
+	 */
+	public function generatePDF()
+	{
+		if (!Config::inst()->get(BasePage::class, 'pdf_export')) {
+			return false;
+		}
+
+		$binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary');
+		if (!$binaryPath || !is_executable($binaryPath)) {
+			if (Environment::getEnv('WKHTMLTOPDF_BINARY')
+				&& is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY'))
+			) {
+				$binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY');
+			}
+		}
+
+		if (!$binaryPath) {
+			user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR);
+		}
+
+		if (Versioned::get_reading_mode() == 'Stage.Stage') {
+			user_error('Generating PDFs on draft is not supported', E_USER_ERROR);
+		}
+
+		set_time_limit(60);
+
+		// prepare the paths
+		$pdfFile = $this->dataRecord->getPdfFilename();
+		$bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile);
+		$footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile);
+
+		// make sure the work directory exists
+		if (!file_exists(dirname($pdfFile))) {
+			Filesystem::makeFolder(dirname($pdfFile));
+		}
+
+		//decide the domain to use in generation
+		$pdfBaseUrl = $this->getPDFBaseURL();
+
+		// Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway.
+		if (Environment::getEnv('CWP_ENVIRONMENT')) {
+			Config::modify()->set(Director::class, 'alternate_protocol', 'http');
+			//only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is
+			if ($pdfBaseUrl) {
+				Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl);
+			}
+		}
+
+		$bodyViewer = $this->getViewer('pdf');
+
+		// write the output of this page to HTML, ready for conversion to PDF
+		file_put_contents($bodyFile, $bodyViewer->process($this));
+
+		// get the viewer for the current template with _pdffooter
+		$footerViewer = $this->getViewer('pdffooter');
+
+		// write the output of the footer template to HTML, ready for conversion to PDF
+		file_put_contents($footerFile, $footerViewer->process($this));
+
+		//decide what the proxy should look like
+		$proxy = $this->getPDFProxy($pdfBaseUrl);
+
+		// finally, generate the PDF
+		$command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 '
+			. '--orientation Portrait --disable-javascript --quiet --print-media-type ';
+		$retVal = 0;
+		$output = array();
+		exec(
+			$command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout",
+			$output,
+			$retVal
+		);
+
+		// remove temporary file
+		unlink($bodyFile);
+		unlink($footerFile);
+
+		// output any errors
+		if ($retVal != 0) {
+			user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR);
+		}
+
+		// serve the generated file
+		return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf');
+	}
+
+	/**
+	 * Site search form
+	 */
+	public function SearchForm()
+	{
+		$searchText = $this->getRequest()->getVar('Search');
+
+		$fields = FieldList::create(
+			TextField::create('Search', false, $searchText)
+		);
+		$actions = FieldList::create(
+			FormAction::create('results', _t('SilverStripe\\CMS\\Search\\SearchForm.GO', 'Go'))
+		);
+
+		$form = SearchForm::create($this, SearchForm::class, $fields, $actions);
+		$form->setFormAction('search/SearchForm');
+
+		return $form;
+	}
+
+	/**
+	 * Get search form with _header suffix
+	 *
+	 * @return SearchForm
+	 */
+	public function HeaderSearchForm()
+	{
+		return $this->SearchForm()->setTemplate('SearchForm_header');
+	}
+
+	/**
+	 * Process and render search results.
+	 *
+	 * @param array $data The raw request data submitted by user
+	 * @param SearchForm $form The form instance that was submitted
+	 * @param HTTPRequest $request Request generated for this action
+	 * @return DBHTMLText
+	 */
+	public function results($data, $form, $request)
+	{
+		// Check parameters for terms, pagination, and if we should follow suggestions
+		$keywords = empty($data['Search']) ? '' : $data['Search'];
+		$start = isset($data['start']) ? $data['start'] : 0;
+		$suggestions = isset($data['suggestions'])
+			? $data['suggestions']
+			: $this->config()->search_follow_suggestions;
+
+		$results = CwpSearchEngine::create()
+			->search(
+				$keywords,
+				$this->getClassesToSearch(),
+				$this->getSearchIndex(),
+				$this->getSearchPageSize(),
+				$start,
+				$suggestions
+			);
+
+		// Customise content with these results
+		$properties = [
+			'MetaTitle' => _t(__CLASS__ . '.MetaTitle', 'Search {keywords}', ['keywords' => $keywords]),
+			'NoSearchResults' => _t(__CLASS__ . '.NoResult', 'Sorry, your search query did not return any results.'),
+			'EmptySearch' => _t(__CLASS__ . '.EmptySearch', 'Search field empty, please enter your search query.'),
+			'PdfLink' => '',
+			'Title' => _t('SilverStripe\\CMS\\Search\\SearchForm.SearchResults', 'Search Results'),
+		];
+		$this->extend('updateSearchResults', $results, $properties);
+
+		// Customise page
+		$response = $this->customise($properties);
+		if ($results) {
+			$response = $response
+				->customise($results)
+				->customise(array( 'Results' => $results->getResults() ));
+		}
+
+		// Render
+		$templates = $this->getResultsTemplate($request);
+		return $response->renderWith($templates);
+	}
+
+	/**
+	 * Select the template to render search results with
+	 *
+	 * @param HTTPRequest $request
+	 * @return array
+	 */
+	protected function getResultsTemplate($request)
+	{
+		$templates = [Page::class . '_results', Page::class];
+		if ($request->getVar('format') == 'rss') {
+			array_unshift($templates, 'Page_results_rss');
+		}
+		if ($request->getVar('format') == 'atom') {
+			array_unshift($templates, 'Page_results_atom');
+		}
+		return $templates;
+	}
+
+	/**
+	 * Provide current year.
+	 */
+	public function CurrentDatetime()
+	{
+		return DBDatetime::now();
+	}
+
+	public function getRSSLink()
+	{
+	}
+
+	/**
+	 * Get the search index registered for this application
+	 *
+	 * @return CwpSearchIndex
+	 */
+	protected function getSearchIndex()
+	{
+		// Will be a service name in 2.0 and returned via injector
+		/** @var CwpSearchIndex $index */
+		$index = null;
+		if (self::$search_index_class) {
+			$index = Injector::inst()->get(self::$search_index_class);
+		}
+		return $index;
+	}
+
+	/**
+	 * Gets the list of configured classes to search
+	 *
+	 * @return array
+	 */
+	protected function getClassesToSearch()
+	{
+		// Will be private static config in 2.0
+		return self::$classes_to_search;
+	}
+
+	/**
+	 * Get page size for search
+	 *
+	 * @return int
+	 */
+	protected function getSearchPageSize()
+	{
+		// Will be private static config in 2.0
+		return self::$results_per_page;
+	}
 }

src/PageTypes/SitemapPageController.php

Indentation +38 added lines, -38 removed lines

@@ -7,42 +7,42 @@
 
 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('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('SitemapNodeChildren');
+		}
+
+		return $viewer;
+	}
 }

src/PageTypes/BasePage.php

Indentation +298 added lines, -298 removed lines

@@ -28,302 +28,302 @@
 
 class BasePage extends SiteTree
 {
-    private static $icon = 'cwp/cwp:images/icons/sitetree_images/page.png';
-
-    /**
-     * Hide this page type from the CMS. hide_ancestor is slightly misnamed, should really be just "hide"
-     *
-     * {@inheritDoc}
-     */
-    private static $hide_ancestor = BasePage::class;
-
-    /**
-     * @config
-     * @var bool
-     */
-    private static $pdf_export = false;
-
-    /**
-     * Domain to generate PDF's from, DOES not include protocol
-     * i.e. google.com not http://google.com
-     * @config
-     * @var string
-     */
-    private static $pdf_base_url = "";
-
-    /**
-     * Allow custom overriding of the path to the WKHTMLTOPDF binary, in cases
-     * where multiple versions of the binary are available to choose from. This
-     * should be the full path to the binary (e.g. /usr/local/bin/wkhtmltopdf)
-     * @see BasePage_Controller::generatePDF();
-     *
-     * @config
-     * @var string|null
-     */
-    private static $wkhtmltopdf_binary = null;
-
-    /**
-     * Where to store generated PDF files
-     *
-     * @config
-     * @var string
-     */
-    private static $generated_pdf_path = 'assets/_generated_pdfs';
-
-    private static $api_access = [
-        'view' => [
-            'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
-            'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
-        ],
-        'edit' => [
-            'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
-            'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
-        ],
-    ];
-
-    private static $table_name = 'BasePage';
-
-    /**
-     * @config
-     * @var string
-     */
-    private static $related_pages_title = 'Related pages';
-
-    private static $many_many = [
-        'Terms' => TaxonomyTerm::class,
-        'RelatedPages' => BasePage::class,
-    ];
-
-    private static $many_many_extraFields = [
-        'RelatedPages' => [
-            'SortOrder' => 'Int',
-        ],
-    ];
-
-    private static $plural_name = 'Base Pages';
-
-    /**
-     * Get the footer holder.
-     */
-    public function getFooter()
-    {
-        return FooterHolder::get_one(FooterHolder::class);
-    }
-
-    /**
-     * Return the full filename of the pdf file, including path & extension
-     */
-    public function getPdfFilename()
-    {
-        $baseName = sprintf('%s-%s', $this->URLSegment, $this->ID);
-
-        $folderPath = $this->config()->get('generated_pdf_path');
-        if ($folderPath[0] != '/') {
-            $folderPath = BASE_PATH . '/' . $folderPath;
-        }
-
-        return sprintf('%s/%s.pdf', $folderPath, $baseName);
-    }
-
-    /**
-     * Build pdf link for template.
-     */
-    public function PdfLink()
-    {
-        if (!$this->config()->get('pdf_export')) {
-            return false;
-        }
-
-        $path = $this->getPdfFilename();
-
-        if ((Versioned::get_stage() === Versioned::LIVE) && file_exists($path)) {
-            return Director::baseURL() . preg_replace('#^/#', '', Director::makeRelative($path));
-        }
-        return $this->Link('downloadpdf');
-    }
-
-    public function RelatedPages()
-    {
-        return $this->getManyManyComponents('RelatedPages')->sort('SortOrder');
-    }
-
-    public function RelatedPagesTitle()
-    {
-        return $this->config()->get('related_pages_title');
-    }
-
-    /**
-     * Remove linked pdf when publishing the page,
-     * as it would be out of date.
-     */
-    public function onAfterPublish()
-    {
-        $filepath = $this->getPdfFilename();
-        if (file_exists($filepath)) {
-            unlink($filepath);
-        }
-    }
-
-    /**
-     * Remove linked pdf when unpublishing the page,
-     * so it's no longer valid.
-     *
-     * @return boolean
-     */
-    public function doUnpublish()
-    {
-        if (!parent::doUnpublish()) {
-            return false;
-        }
-
-        $filepath = $this->getPdfFilename();
-        if (file_exists($filepath)) {
-            unlink($filepath);
-        }
-
-        return true;
-    }
-
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function (FieldList $fields) {
-            // Related Pages
-            $components = GridFieldConfig_RelationEditor::create();
-            $components->removeComponentsByType(GridFieldAddNewButton::class);
-            $components->removeComponentsByType(GridFieldEditButton::class);
-            $components->removeComponentsByType(GridFieldFilterHeader::class);
-            $components->addComponent(new GridFieldSortableRows('SortOrder'));
-
-            /** @var GridFieldDataColumns $dataColumns */
-            $dataColumns = $components->getComponentByType(GridFieldDataColumns::class);
-            $dataColumns->setDisplayFields([
-                'Title' => _t(__CLASS__ . '.ColumnTitle', 'Title'),
-                'ClassName' => _t(__CLASS__ . '.ColumnPageType', 'Page Type')
-            ]);
-
-            $fields->findOrMakeTab(
-                'Root.RelatedPages',
-                _t(__CLASS__ . '.RelatedPages', 'Related pages')
-            );
-            $fields->addFieldToTab(
-                'Root.RelatedPages',
-                GridField::create(
-                    'RelatedPages',
-                    _t(__CLASS__ . '.RelatedPages', 'Related pages'),
-                    $this->RelatedPages(),
-                    $components
-                )
-            );
-
-            // Taxonomies - Unless they have their own 'Tags' field (such as in Blog, etc)
-            $hasMany = $this->hasMany();
-            $manyMany = $this->manyMany();
-            if (!isset($hasMany['Tags']) && !isset($manyMany['Tags'])) {
-                $components = GridFieldConfig_RelationEditor::create();
-                $components->removeComponentsByType(GridFieldAddNewButton::class);
-                $components->removeComponentsByType(GridFieldEditButton::class);
-
-                /** @var GridFieldAddExistingAutocompleter $autoCompleter */
-                $autoCompleter = $components->getComponentByType(GridFieldAddExistingAutocompleter::class);
-                $autoCompleter->setResultsFormat('$Name ($TaxonomyName)');
-
-                /** @var GridFieldDataColumns $dataColumns */
-                $dataColumns = $components->getComponentByType(GridFieldDataColumns::class);
-                $dataColumns->setDisplayFields([
-                    'Name' => _t(__CLASS__ . '.Term', 'Term'),
-                    'TaxonomyName' => _t(__CLASS__ . '.Taxonomy', 'Taxonomy')
-                ]);
-
-                $fields->findOrMakeTab('Root.Tags', _t(__CLASS__ . '.TagsTabTitle', 'Tags'));
-                $fields->addFieldToTab(
-                    'Root.Tags',
-                    TreeMultiselectField::create(
-                        'Terms',
-                        _t(__CLASS__ . '.Terms', 'Terms'),
-                        TaxonomyTerm::class
-                    )->setDescription(_t(__CLASS__ . '.TermsDescription', 'Click to search for additional terms'))
-                );
-            }
-        });
-        return parent::getCMSFields();
-    }
-
-    /**
-     * Provides data for translation navigation.
-     * Collects all site translations, marks the current one, and redirects
-     * to the translated home page if a. there is a translated homepage and b. the
-     * translation of the specific page is not available.
-     * @todo re-implement with Fluent
-     */
-    public function getAvailableTranslations()
-    {
-        if (!class_exists('Translatable')) {
-            return false;
-        }
-
-        $translations = new ArrayList();
-        $globalTranslations = Translatable::get_existing_content_languages();
-
-        foreach ($globalTranslations as $loc => $langName) {
-            // Find out the language name in native language.
-            $nativeLangName = i18n::get_language_name($loc, true);
-            if (!$nativeLangName) {
-                $nativeLangName = i18n::get_language_name(i18n::get_lang_from_locale($loc), true);
-            }
-            if (!$nativeLangName) {
-                // Fall back to the locale name.
-                $nativeLangName = $langName;
-            }
-
-            // Eliminate the part in brackets (e.g. [mandarin])
-            $nativeLangName = preg_replace('/ *[\(\[].*$/', '', $nativeLangName);
-
-            // Find out the link to the translated page.
-            $link = null;
-            $page = $this->getTranslation($loc);
-            if ($page) {
-                $link = $page->Link();
-            }
-            if (!$link) {
-                // Fall back to the home page
-                $link = Translatable::get_homepage_link_by_locale($loc);
-            }
-            if (!$link) {
-                continue;
-            }
-
-            // Assemble the table for the switcher.
-            $translations->push(new ArrayData(array(
-                'Locale' => i18n::convert_rfc1766($loc),
-                'LangName' => $nativeLangName,
-                'Link' => $link,
-                'Current' => (Translatable::get_current_locale()==$loc)
-            )));
-        }
-
-        if ($translations->count()>1) {
-            return $translations;
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Returns the native language name for the selected locale/language, empty string if Translatable is not available
-     *
-     * @return string
-     * @todo re-implement with Fluent
-     */
-    public function getSelectedLanguage()
-    {
-        if (!class_exists('Translatable')) {
-            return '';
-        }
-
-        $language = explode('_', Translatable::get_current_locale());
-        $languageCode = array_shift($language);
-        $nativeName = i18n::get_language_name($languageCode, true);
-
-        return $nativeName;
-    }
+	private static $icon = 'cwp/cwp:images/icons/sitetree_images/page.png';
+
+	/**
+	 * Hide this page type from the CMS. hide_ancestor is slightly misnamed, should really be just "hide"
+	 *
+	 * {@inheritDoc}
+	 */
+	private static $hide_ancestor = BasePage::class;
+
+	/**
+	 * @config
+	 * @var bool
+	 */
+	private static $pdf_export = false;
+
+	/**
+	 * Domain to generate PDF's from, DOES not include protocol
+	 * i.e. google.com not http://google.com
+	 * @config
+	 * @var string
+	 */
+	private static $pdf_base_url = "";
+
+	/**
+	 * Allow custom overriding of the path to the WKHTMLTOPDF binary, in cases
+	 * where multiple versions of the binary are available to choose from. This
+	 * should be the full path to the binary (e.g. /usr/local/bin/wkhtmltopdf)
+	 * @see BasePage_Controller::generatePDF();
+	 *
+	 * @config
+	 * @var string|null
+	 */
+	private static $wkhtmltopdf_binary = null;
+
+	/**
+	 * Where to store generated PDF files
+	 *
+	 * @config
+	 * @var string
+	 */
+	private static $generated_pdf_path = 'assets/_generated_pdfs';
+
+	private static $api_access = [
+		'view' => [
+			'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
+			'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
+		],
+		'edit' => [
+			'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
+			'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
+		],
+	];
+
+	private static $table_name = 'BasePage';
+
+	/**
+	 * @config
+	 * @var string
+	 */
+	private static $related_pages_title = 'Related pages';
+
+	private static $many_many = [
+		'Terms' => TaxonomyTerm::class,
+		'RelatedPages' => BasePage::class,
+	];
+
+	private static $many_many_extraFields = [
+		'RelatedPages' => [
+			'SortOrder' => 'Int',
+		],
+	];
+
+	private static $plural_name = 'Base Pages';
+
+	/**
+	 * Get the footer holder.
+	 */
+	public function getFooter()
+	{
+		return FooterHolder::get_one(FooterHolder::class);
+	}
+
+	/**
+	 * Return the full filename of the pdf file, including path & extension
+	 */
+	public function getPdfFilename()
+	{
+		$baseName = sprintf('%s-%s', $this->URLSegment, $this->ID);
+
+		$folderPath = $this->config()->get('generated_pdf_path');
+		if ($folderPath[0] != '/') {
+			$folderPath = BASE_PATH . '/' . $folderPath;
+		}
+
+		return sprintf('%s/%s.pdf', $folderPath, $baseName);
+	}
+
+	/**
+	 * Build pdf link for template.
+	 */
+	public function PdfLink()
+	{
+		if (!$this->config()->get('pdf_export')) {
+			return false;
+		}
+
+		$path = $this->getPdfFilename();
+
+		if ((Versioned::get_stage() === Versioned::LIVE) && file_exists($path)) {
+			return Director::baseURL() . preg_replace('#^/#', '', Director::makeRelative($path));
+		}
+		return $this->Link('downloadpdf');
+	}
+
+	public function RelatedPages()
+	{
+		return $this->getManyManyComponents('RelatedPages')->sort('SortOrder');
+	}
+
+	public function RelatedPagesTitle()
+	{
+		return $this->config()->get('related_pages_title');
+	}
+
+	/**
+	 * Remove linked pdf when publishing the page,
+	 * as it would be out of date.
+	 */
+	public function onAfterPublish()
+	{
+		$filepath = $this->getPdfFilename();
+		if (file_exists($filepath)) {
+			unlink($filepath);
+		}
+	}
+
+	/**
+	 * Remove linked pdf when unpublishing the page,
+	 * so it's no longer valid.
+	 *
+	 * @return boolean
+	 */
+	public function doUnpublish()
+	{
+		if (!parent::doUnpublish()) {
+			return false;
+		}
+
+		$filepath = $this->getPdfFilename();
+		if (file_exists($filepath)) {
+			unlink($filepath);
+		}
+
+		return true;
+	}
+
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function (FieldList $fields) {
+			// Related Pages
+			$components = GridFieldConfig_RelationEditor::create();
+			$components->removeComponentsByType(GridFieldAddNewButton::class);
+			$components->removeComponentsByType(GridFieldEditButton::class);
+			$components->removeComponentsByType(GridFieldFilterHeader::class);
+			$components->addComponent(new GridFieldSortableRows('SortOrder'));
+
+			/** @var GridFieldDataColumns $dataColumns */
+			$dataColumns = $components->getComponentByType(GridFieldDataColumns::class);
+			$dataColumns->setDisplayFields([
+				'Title' => _t(__CLASS__ . '.ColumnTitle', 'Title'),
+				'ClassName' => _t(__CLASS__ . '.ColumnPageType', 'Page Type')
+			]);
+
+			$fields->findOrMakeTab(
+				'Root.RelatedPages',
+				_t(__CLASS__ . '.RelatedPages', 'Related pages')
+			);
+			$fields->addFieldToTab(
+				'Root.RelatedPages',
+				GridField::create(
+					'RelatedPages',
+					_t(__CLASS__ . '.RelatedPages', 'Related pages'),
+					$this->RelatedPages(),
+					$components
+				)
+			);
+
+			// Taxonomies - Unless they have their own 'Tags' field (such as in Blog, etc)
+			$hasMany = $this->hasMany();
+			$manyMany = $this->manyMany();
+			if (!isset($hasMany['Tags']) && !isset($manyMany['Tags'])) {
+				$components = GridFieldConfig_RelationEditor::create();
+				$components->removeComponentsByType(GridFieldAddNewButton::class);
+				$components->removeComponentsByType(GridFieldEditButton::class);
+
+				/** @var GridFieldAddExistingAutocompleter $autoCompleter */
+				$autoCompleter = $components->getComponentByType(GridFieldAddExistingAutocompleter::class);
+				$autoCompleter->setResultsFormat('$Name ($TaxonomyName)');
+
+				/** @var GridFieldDataColumns $dataColumns */
+				$dataColumns = $components->getComponentByType(GridFieldDataColumns::class);
+				$dataColumns->setDisplayFields([
+					'Name' => _t(__CLASS__ . '.Term', 'Term'),
+					'TaxonomyName' => _t(__CLASS__ . '.Taxonomy', 'Taxonomy')
+				]);
+
+				$fields->findOrMakeTab('Root.Tags', _t(__CLASS__ . '.TagsTabTitle', 'Tags'));
+				$fields->addFieldToTab(
+					'Root.Tags',
+					TreeMultiselectField::create(
+						'Terms',
+						_t(__CLASS__ . '.Terms', 'Terms'),
+						TaxonomyTerm::class
+					)->setDescription(_t(__CLASS__ . '.TermsDescription', 'Click to search for additional terms'))
+				);
+			}
+		});
+		return parent::getCMSFields();
+	}
+
+	/**
+	 * Provides data for translation navigation.
+	 * Collects all site translations, marks the current one, and redirects
+	 * to the translated home page if a. there is a translated homepage and b. the
+	 * translation of the specific page is not available.
+	 * @todo re-implement with Fluent
+	 */
+	public function getAvailableTranslations()
+	{
+		if (!class_exists('Translatable')) {
+			return false;
+		}
+
+		$translations = new ArrayList();
+		$globalTranslations = Translatable::get_existing_content_languages();
+
+		foreach ($globalTranslations as $loc => $langName) {
+			// Find out the language name in native language.
+			$nativeLangName = i18n::get_language_name($loc, true);
+			if (!$nativeLangName) {
+				$nativeLangName = i18n::get_language_name(i18n::get_lang_from_locale($loc), true);
+			}
+			if (!$nativeLangName) {
+				// Fall back to the locale name.
+				$nativeLangName = $langName;
+			}
+
+			// Eliminate the part in brackets (e.g. [mandarin])
+			$nativeLangName = preg_replace('/ *[\(\[].*$/', '', $nativeLangName);
+
+			// Find out the link to the translated page.
+			$link = null;
+			$page = $this->getTranslation($loc);
+			if ($page) {
+				$link = $page->Link();
+			}
+			if (!$link) {
+				// Fall back to the home page
+				$link = Translatable::get_homepage_link_by_locale($loc);
+			}
+			if (!$link) {
+				continue;
+			}
+
+			// Assemble the table for the switcher.
+			$translations->push(new ArrayData(array(
+				'Locale' => i18n::convert_rfc1766($loc),
+				'LangName' => $nativeLangName,
+				'Link' => $link,
+				'Current' => (Translatable::get_current_locale()==$loc)
+			)));
+		}
+
+		if ($translations->count()>1) {
+			return $translations;
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns the native language name for the selected locale/language, empty string if Translatable is not available
+	 *
+	 * @return string
+	 * @todo re-implement with Fluent
+	 */
+	public function getSelectedLanguage()
+	{
+		if (!class_exists('Translatable')) {
+			return '';
+		}
+
+		$language = explode('_', Translatable::get_current_locale());
+		$languageCode = array_shift($language);
+		$nativeName = i18n::get_language_name($languageCode, true);
+
+		return $nativeName;
+	}
 }

src/PageTypes/DatedUpdateHolderController.php

Indentation +342 added lines, -342 removed lines

@@ -33,357 +33,357 @@
  */
 class DatedUpdateHolderController extends PageController
 {
-    private static $allowed_actions = [
-        'rss',
-        'atom',
-        'DateRangeForm',
-    ];
-
-    private static $casting = [
-        'MetaTitle' => 'Text',
-        'FilterDescription' => 'Text',
-    ];
-
-    /**
-     * 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) = array($from, $to);
-        }
-
-        // Flip the dates if the order is wrong.
-        if (isset($to) && isset($from) && strtotime($from)>strtotime($to)) {
-            list($to, $from) = array($from, $to);
-
-            if ($produceErrorMessages) {
-                // @todo replace
+	private static $allowed_actions = [
+		'rss',
+		'atom',
+		'DateRangeForm',
+	];
+
+	private static $casting = [
+		'MetaTitle' => 'Text',
+		'FilterDescription' => 'Text',
+	];
+
+	/**
+	 * 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) = array($from, $to);
+		}
+
+		// Flip the dates if the order is wrong.
+		if (isset($to) && isset($from) && strtotime($from)>strtotime($to)) {
+			list($to, $from) = array($from, $to);
+
+			if ($produceErrorMessages) {
+				// @todo replace
 //                Session::setFormMessage(
 //                    'Form_DateRangeForm',
 //                    _t('DateUpdateHolder.FilterAppliedMessage', 'Filter has been applied with the dates reversed.'),
 //                    'warning'
 //                );
-            }
-        }
+			}
+		}
 
-        // Notify the user that filtering by single date is taking place.
-        if (isset($from) && !isset($to)) {
-            if ($produceErrorMessages) {
-                // @todo replace
+		// Notify the user that filtering by single date is taking place.
+		if (isset($from) && !isset($to)) {
+			if ($produceErrorMessages) {
+				// @todo replace
 //                Session::setFormMessage(
 //                    'Form_DateRangeForm',
 //                    _t('DateUpdateHolder.DateRangeFilterMessage', 'Filtered by a single date.'),
 //                    'warning'
 //                );
-            }
-        }
-
-        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: 2017/12/30)')
-        ));
-        $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: 2017/12/30)')
-        ));
-
-        $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');
-
-        // Manually extract the message so we can clear it.
-        $form->ErrorMessage = $form->getMessage();
-        $form->ErrorMessageType = $form->getMessageType();
-        $form->clearMessage();
-
-        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();
-    }
+			}
+		}
+
+		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: 2017/12/30)')
+		));
+		$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: 2017/12/30)')
+		));
+
+		$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');
+
+		// Manually extract the message so we can clear it.
+		$form->ErrorMessage = $form->getMessage();
+		$form->ErrorMessageType = $form->getMessageType();
+		$form->clearMessage();
+
+		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();
+	}
 }

src/Model/QuickLink.php

Indentation +113 added lines, -113 removed lines

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