SubsitesVirtualPage::validURLSegment() - Code Metrics - silverstripe/silverstripe-subsites - Measure and Improve Code Quality continuously with Scrutinizer

SubsitesVirtualPage::validURLSegment() A
last analyzed 2019-11-27 14:30 UTC

↳ Parent: SubsitesVirtualPage

Complexity

Conditions	5
Paths	5

Size

Total Lines	28
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	14
c	1
b	0
f	0
nc	5
nop	0
dl	0
loc	28
rs	9.4888

<?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';


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


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

    private static $non_virtual_fields = [

        'SubsiteID'
    ];

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

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

            $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;

        }
        Subsite::$disable_subsite_filter = $oldState;
    }

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

        if ($this->CustomMetaTitle) {

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

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

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

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

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

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

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

        } 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,

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

            ];

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

            }

            $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);

        }

        return $isValid;
    }
}


1			<?php
2
3			namespace SilverStripe\Subsites\Pages;
4
5			use SilverStripe\CMS\Controllers\CMSPageEditController;
6			use SilverStripe\CMS\Model\SiteTree;
7			use SilverStripe\CMS\Model\VirtualPage;
8			use SilverStripe\Control\Controller;
9			use SilverStripe\Core\Config\Config;
10			use SilverStripe\Forms\DropdownField;
11			use SilverStripe\Forms\LiteralField;
12			use SilverStripe\Forms\TextareaField;
13			use SilverStripe\Forms\TextField;
14			use SilverStripe\Forms\TreeDropdownField;
15			use SilverStripe\ORM\ArrayList;
16			use SilverStripe\ORM\DataObject;
17			use SilverStripe\Subsites\Forms\SubsitesTreeDropdownField;
18			use SilverStripe\Subsites\Model\Subsite;
19			use SilverStripe\Subsites\State\SubsiteState;
20			use SilverStripe\View\ArrayData;
21
22			class SubsitesVirtualPage extends VirtualPage
23			{
24
25			private static $table_name = 'SubsitesVirtualPage';
			0 ignored issues – show introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
26
27			private static $description = 'Displays the content of a page on another subsite';
			0 ignored issues – show introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The private property `$description` is not used, and could be removed. Loading history...
28
29			private static $db = [
30			'CustomMetaTitle' => 'Varchar(255)',
31			'CustomMetaKeywords' => 'Varchar(255)',
32			'CustomMetaDescription' => 'Text',
33			'CustomExtraMeta' => 'HTMLText'
34			];
35
36			private static $non_virtual_fields = [
			0 ignored issues – show introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The private property `$non_virtual_fields` is not used, and could be removed. Loading history...
37			'SubsiteID'
38			];
39
40			public function getCMSFields()
41			{
42			$fields = parent::getCMSFields();
43
44			$subsites = DataObject::get(Subsite::class);
45			if (!$subsites) {
			0 ignored issues – show introduced 2018-10-19 14:33 UTC by Report Bug Copy Issue Report `$subsites` is of type `SilverStripe\ORM\DataList`, thus it always evaluated to `true`. Loading history...
46			$subsites = new ArrayList();
47			} else {
48			$subsites = ArrayList::create($subsites->toArray());
49			}
50
51			$subsites->push(new ArrayData(['Title' => 'Main site', 'ID' => 0]));
52
53			$fields->addFieldToTab(
54			'Root.Main',
55			DropdownField::create(
56			'CopyContentFromID_SubsiteID',
57			_t(__CLASS__ . '.SubsiteField', 'Subsite'),
58			$subsites->map('ID', 'Title')
59			)->addExtraClass('subsitestreedropdownfield-chooser no-change-track'),
60			'CopyContentFromID'
61			);
62
63			// Setup the linking to the original page.
64			$pageSelectionField = SubsitesTreeDropdownField::create(
65			'CopyContentFromID',
66			_t('SilverStripe\\CMS\\Model\\VirtualPage.CHOOSE', 'Linked Page'),
67			SiteTree::class,
68			'ID',
69			'MenuTitle'
70			);
71
72			$fields->addFieldToTab(
73			'Root.Main',
74			TreeDropdownField::create('CopyContentFromID', 'Linked Page', SiteTree::class)
75			);
76
77			if (Controller::has_curr() && Controller::curr()->getRequest()) {
78			$subsiteID = (int) Controller::curr()->getRequest()->requestVar('CopyContentFromID_SubsiteID');
79			$pageSelectionField->setSubsiteID($subsiteID);
80			}
81			$fields->replaceField('CopyContentFromID', $pageSelectionField);
82
83			// Create links back to the original object in the CMS
84			if ($this->CopyContentFromID) {
85			$editLink = Controller::join_links(
86			CMSPageEditController::singleton()->Link('show'),
87			$this->CopyContentFromID
88			);
89
90			$linkToContent = "
91			<a class=\"cmsEditlink\" href=\"$editLink\">" .
92			_t('SilverStripe\\CMS\\Model\\VirtualPage.EDITCONTENT', 'Click here to edit the content') .
93			'</a>';
94			$fields->removeByName('VirtualPageContentLinkLabel');
95			$fields->addFieldToTab(
96			'Root.Main',
97			$linkToContentLabelField = LiteralField::create('VirtualPageContentLinkLabel', $linkToContent),
98			'Title'
99			);
100			}
101
102
103			$fields->addFieldToTab(
104			'Root.Main',
105			TextField::create(
106			'CustomMetaTitle',
107			$this->fieldLabel('CustomMetaTitle')
108			)->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
109			'MetaTitle'
110			);
111			$fields->addFieldToTab(
112			'Root.Main',
113			TextareaField::create(
114			'CustomMetaKeywords',
115			$this->fieldLabel('CustomMetaKeywords')
116			)->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
117			'MetaKeywords'
118			);
119			$fields->addFieldToTab(
120			'Root.Main',
121			TextareaField::create(
122			'CustomMetaDescription',
123			$this->fieldLabel('CustomMetaDescription')
124			)->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
125			'MetaDescription'
126			);
127			$fields->addFieldToTab(
128			'Root.Main',
129			TextField::create(
130			'CustomExtraMeta',
131			$this->fieldLabel('CustomExtraMeta')
132			)->setDescription(_t(__CLASS__ . '.OverrideNote', 'Overrides inherited value from the source')),
133			'ExtraMeta'
134			);
135
136			return $fields;
137			}
138
139			public function fieldLabels($includerelations = true)
140			{
141			$labels = parent::fieldLabels($includerelations);
142			$labels['CustomMetaTitle'] = _t('SilverStripe\\Subsites\\Model\\Subsite.CustomMetaTitle', 'Title');
143			$labels['CustomMetaKeywords'] = _t(
144			'SilverStripe\\Subsites\\Model\\Subsite.CustomMetaKeywords',
145			'Keywords'
146			);
147			$labels['CustomMetaDescription'] = _t(
148			'SilverStripe\\Subsites\\Model\\Subsite.CustomMetaDescription',
149			'Description'
150			);
151			$labels['CustomExtraMeta'] = _t(
152			'SilverStripe\\Subsites\\Model\\Subsite.CustomExtraMeta',
153			'Custom Meta Tags'
154			);
155
156			return $labels;
157			}
158
159			public function getCopyContentFromID_SubsiteID()
160			{
161			if ($this->CopyContentFromID) {
162			return (int) $this->CopyContentFrom()->SubsiteID;
163			}
164			return SubsiteState::singleton()->getSubsiteId();
165			}
166
167			public function getVirtualFields()
168			{
169			$fields = parent::getVirtualFields();
170			foreach ($fields as $k => $v) {
171			if ($v == 'SubsiteID') {
172			unset($fields[$k]);
173			}
174			}
175
176			foreach (self::$db as $field => $type) {
177			if (in_array($field, $fields)) {
178			unset($fields[array_search($field, $fields)]);
179			}
180			}
181
182			return $fields;
183			}
184
185			public function syncLinkTracking()
186			{
187			$oldState = Subsite::$disable_subsite_filter;
188			Subsite::$disable_subsite_filter = true;
189			if ($this->CopyContentFromID) {
190			$this->HasBrokenLink = DataObject::get_by_id(SiteTree::class, $this->CopyContentFromID) ? false : true;
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `HasBrokenLink` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
191			}
192			Subsite::$disable_subsite_filter = $oldState;
193			}
194
195			public function onBeforeWrite()
196			{
197			parent::onBeforeWrite();
198
199			if ($this->CustomMetaTitle) {
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `CustomMetaTitle` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
200			$this->MetaTitle = $this->CustomMetaTitle;
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `MetaTitle` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
201			} else {
202			$this->MetaTitle = $this->ContentSource()->MetaTitle ?: $this->MetaTitle;
203			}
204			if ($this->CustomMetaKeywords) {
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `CustomMetaKeywords` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
205			$this->MetaKeywords = $this->CustomMetaKeywords;
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `MetaKeywords` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
206			} else {
207			$this->MetaKeywords = $this->ContentSource()->MetaKeywords ?: $this->MetaKeywords;
208			}
209			if ($this->CustomMetaDescription) {
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `CustomMetaDescription` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
210			$this->MetaDescription = $this->CustomMetaDescription;
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `MetaDescription` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
211			} else {
212			$this->MetaDescription = $this->ContentSource()->MetaDescription ?: $this->MetaDescription;
213			}
214			if ($this->CustomExtraMeta) {
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `CustomExtraMeta` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
215			$this->ExtraMeta = $this->CustomExtraMeta;
			0 ignored issues – show Bug Best Practice introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The property `ExtraMeta` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
216			} else {
217			$this->ExtraMeta = $this->ContentSource()->ExtraMeta ?: $this->ExtraMeta;
218			}
219			}
220
221			public function validURLSegment()
222			{
223			$isValid = parent::validURLSegment();
224
225			// Veto the validation rules if its false. In this case, some logic
226			// needs to be duplicated from parent to find out the exact reason the validation failed.
227			if (!$isValid) {
228			$filters = [
229			'URLSegment' => $this->URLSegment,
			0 ignored issues – show Bug Best Practice introduced 2019-06-24 22:07 UTC by Report Bug Copy Issue Report The property `URLSegment` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
230			'ID:not' => $this->ID,
			0 ignored issues – show Bug Best Practice introduced 2019-06-24 22:07 UTC by Report Bug Copy Issue Report The property `ID` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
231			];
232
233			if (Config::inst()->get(SiteTree::class, 'nested_urls')) {
234			$filters['ParentID'] = $this->ParentID ?: 0;
			0 ignored issues – show Bug Best Practice introduced 2019-06-24 22:07 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `SilverStripe\Subsites\Pages\SubsitesVirtualPage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
235			}
236
237			$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
238			Subsite::disable_subsite_filter();
239			$existingPage = SiteTree::get()->filter($filters)->first();
240			Subsite::disable_subsite_filter($origDisableSubsiteFilter);
241			$existingPageInSubsite = SiteTree::get()->filter($filters)->first();
242
243			// If URL has been vetoed because of an existing page,
244			// be more specific and allow same URLSegments in different subsites
245			$isValid = !($existingPage && $existingPageInSubsite);
			0 ignored issues – show introduced 2019-06-24 22:07 UTC by Report Bug Copy Issue Report `$existingPageInSubsite` is of type `SilverStripe\ORM\DataObject`, thus it always evaluated to `true`. Loading history...
246			}
247
248			return $isValid;
249			}
250			}
251

silverstripe / silverstripe-subsites

SubsitesVirtualPage::validURLSegment() A last analyzed 2019-11-27 14:30 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SubsitesVirtualPage::validURLSegment() A
last analyzed 2019-11-27 14:30 UTC