silverstripe / cwp

src/PageTypes/BasePage.php

Indentation +235 added lines, -235 removed lines

@@ -27,239 +27,239 @@
 
 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);
-
-            /** @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();
-    }
-
-    /**
-     * Returns the native language name for the selected locale/language, empty string if Fluent is not available
-     *
-     * @return string
-     */
-    public function getSelectedLanguage()
-    {
-        if (!class_exists(Locale::class) || !$this->hasMethod('Locales')) {
-            return '';
-        }
-
-        /** @var ArrayData $information */
-        $information = $this->LocaleInformation(FluentState::singleton()->getLocale());
-
-        return $information->LanguageNative;
-    }
+	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);
+
+			/** @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();
+	}
+
+	/**
+	 * Returns the native language name for the selected locale/language, empty string if Fluent is not available
+	 *
+	 * @return string
+	 */
+	public function getSelectedLanguage()
+	{
+		if (!class_exists(Locale::class) || !$this->hasMethod('Locales')) {
+			return '';
+		}
+
+		/** @var ArrayData $information */
+		$information = $this->LocaleInformation(FluentState::singleton()->getLocale());
+
+		return $information->LanguageNative;
+	}
 }