silverstripe / silverstripe-subsites

src/Pages/SubsitesVirtualPage.php

<?php

namespace SilverStripe\Subsites\Pages;

use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Model\VirtualPage;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\TextareaField;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\TreeDropdownField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Subsites\Forms\SubsitesTreeDropdownField;
use SilverStripe\Subsites\Model\Subsite;
use SilverStripe\Subsites\State\SubsiteState;
use SilverStripe\View\ArrayData;

class SubsitesVirtualPage extends VirtualPage
{

    private static $table_name = 'SubsitesVirtualPage';

The private property $table_name is not used, and could be removed.

    private static $description = 'Displays the content of a page on another subsite';

The private property $description is not used, and could be removed.

    private static $db = [
        'CustomMetaTitle' => 'Varchar(255)',
        'CustomMetaKeywords' => 'Varchar(255)',
        'CustomMetaDescription' => 'Text',
        'CustomExtraMeta' => 'HTMLText'
    ];

    private static $non_virtual_fields = [

The private property $non_virtual_fields is not used, and could be removed.

        'SubsiteID'
    ];

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $subsites = DataObject::get(Subsite::class);
        if (!$subsites) {

$subsites is of type SilverStripe\ORM\DataList, thus it always evaluated to true.

            $subsites = new ArrayList();
        } else {
            $subsites = ArrayList::create($subsites->toArray());
        }

        $subsites->push(new ArrayData(['Title' => 'Main site', 'ID' => 0]));

        $fields->addFieldToTab(
            'Root.Main',
            DropdownField::create(
                'CopyContentFromID_SubsiteID',
                _t(__CLASS__ . '.SubsiteField', 'Subsite'),
                $subsites->map('ID', 'Title')
            )->addExtraClass('subsitestreedropdownfield-chooser no-change-track'),
            'CopyContentFromID'
        );

        // Setup the linking to the original page.
        $pageSelectionField = SubsitesTreeDropdownField::create(
            'CopyContentFromID',
            _t('SilverStripe\\CMS\\Model\\VirtualPage.CHOOSE', 'Linked Page'),
            SiteTree::class,
            'ID',
            'MenuTitle'
        );

        $fields->addFieldToTab(
            'Root.Main',
            TreeDropdownField::create('CopyContentFromID', 'Linked Page', SiteTree::class)
        );

        if (Controller::has_curr() && Controller::curr()->getRequest()) {
            $subsiteID = (int) Controller::curr()->getRequest()->requestVar('CopyContentFromID_SubsiteID');
            $pageSelectionField->setSubsiteID($subsiteID);
        }
        $fields->replaceField('CopyContentFromID', $pageSelectionField);

        // Create links back to the original object in the CMS
        if ($this->CopyContentFromID) {
            $editLink = Controller::join_links(
                CMSPageEditController::singleton()->Link('show'),
                $this->CopyContentFromID
            );

            $linkToContent = "
				<a class=\"cmsEditlink\" href=\"$editLink\">" .
                _t('SilverStripe\\CMS\\Model\\VirtualPage.EDITCONTENT', 'Click here to edit the content') .
                '</a>';
            $fields->removeByName('VirtualPageContentLinkLabel');
            $fields->addFieldToTab(
                'Root.Main',
                $linkToContentLabelField = LiteralField::create('VirtualPageContentLinkLabel', $linkToContent),
                'Title'
            );
        }


        $fields->addFieldToTab(
            'Root.Main',
            TextField::create(
                'CustomMetaTitle',
                $this->fieldLabel('CustomMetaTitle')
            )->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
            'MetaTitle'
        );
        $fields->addFieldToTab(
            'Root.Main',
            TextareaField::create(
                'CustomMetaKeywords',
                $this->fieldLabel('CustomMetaKeywords')
            )->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
            'MetaKeywords'
        );
        $fields->addFieldToTab(
            'Root.Main',
            TextareaField::create(
                'CustomMetaDescription',
                $this->fieldLabel('CustomMetaDescription')
            )->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
            'MetaDescription'
        );
        $fields->addFieldToTab(
            'Root.Main',
            TextField::create(
                'CustomExtraMeta',
                $this->fieldLabel('CustomExtraMeta')
            )->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
            'ExtraMeta'
        );

        return $fields;
    }

    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);
        $labels['CustomMetaTitle'] = _t('SilverStripe\\Subsites\\Model\\Subsite.CustomMetaTitle', 'Title');
        $labels['CustomMetaKeywords'] = _t(
            'SilverStripe\\Subsites\\Model\\Subsite.CustomMetaKeywords',
            'Keywords'
        );
        $labels['CustomMetaDescription'] = _t(
            'SilverStripe\\Subsites\\Model\\Subsite.CustomMetaDescription',
            'Description'
        );
        $labels['CustomExtraMeta'] = _t(
            'SilverStripe\\Subsites\\Model\\Subsite.CustomExtraMeta',
            'Custom Meta Tags'
        );

        return $labels;
    }

    public function getCopyContentFromID_SubsiteID()
    {
        if ($this->CopyContentFromID) {
            return (int) $this->CopyContentFrom()->SubsiteID;
        }
        return SubsiteState::singleton()->getSubsiteId();
    }

    public function getVirtualFields()
    {
        $fields = parent::getVirtualFields();
        foreach ($fields as $k => $v) {
            if ($v == 'SubsiteID') {
                unset($fields[$k]);
            }
        }

        foreach (self::$db as $field => $type) {
            if (in_array($field, $fields)) {
                unset($fields[array_search($field, $fields)]);
            }
        }

        return $fields;
    }

    public function syncLinkTracking()
    {
        $oldState = Subsite::$disable_subsite_filter;
        Subsite::$disable_subsite_filter = true;
        if ($this->CopyContentFromID) {
            $this->HasBrokenLink = DataObject::get_by_id(SiteTree::class, $this->CopyContentFromID) ? false : true;

The property HasBrokenLink does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
        Subsite::$disable_subsite_filter = $oldState;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        if ($this->CustomMetaTitle) {

The property CustomMetaTitle does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            $this->MetaTitle = $this->CustomMetaTitle;

The property MetaTitle does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {
            $this->MetaTitle = $this->ContentSource()->MetaTitle ?: $this->MetaTitle;
        }
        if ($this->CustomMetaKeywords) {

The property CustomMetaKeywords does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            $this->MetaKeywords = $this->CustomMetaKeywords;

The property MetaKeywords does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {
            $this->MetaKeywords = $this->ContentSource()->MetaKeywords ?: $this->MetaKeywords;
        }
        if ($this->CustomMetaDescription) {

The property CustomMetaDescription does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            $this->MetaDescription = $this->CustomMetaDescription;

The property MetaDescription does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {
            $this->MetaDescription = $this->ContentSource()->MetaDescription ?: $this->MetaDescription;
        }
        if ($this->CustomExtraMeta) {

The property CustomExtraMeta does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            $this->ExtraMeta = $this->CustomExtraMeta;

The property ExtraMeta does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {
            $this->ExtraMeta = $this->ContentSource()->ExtraMeta ?: $this->ExtraMeta;
        }
    }

    public function validURLSegment()
    {
        $isValid = parent::validURLSegment();

        // Veto the validation rules if its false. In this case, some logic
        // needs to be duplicated from parent to find out the exact reason the validation failed.
        if (!$isValid) {
            $filters = [
                'URLSegment' => $this->URLSegment,

The property URLSegment does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

                'ID:not' => $this->ID,

The property ID does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            ];

            if (Config::inst()->get(SiteTree::class, 'nested_urls')) {
                $filters['ParentID'] = $this->ParentID ?: 0;

The property ParentID does not exist on SilverStripe\Subsites\Pages\SubsitesVirtualPage. Since you implemented __get, consider adding a @property annotation.

            }

            $origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
            Subsite::disable_subsite_filter();
            $existingPage = SiteTree::get()->filter($filters)->first();
            Subsite::disable_subsite_filter($origDisableSubsiteFilter);
            $existingPageInSubsite = SiteTree::get()->filter($filters)->first();

            // If URL has been vetoed because of an existing page,
            // be more specific and allow same URLSegments in different subsites
            $isValid = !($existingPage && $existingPageInSubsite);

$existingPageInSubsite is of type SilverStripe\ORM\DataObject, thus it always evaluated to true.

        }

        return $isValid;
    }
}