BaseElementExtension::getVirtualElements() - Code Metrics - Inspection of "Changes so that elements can be moved to a differe..." - dnadesign/silverstripe-elemental-virtual - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#19)

unknown

created 2018-10-19 14:49 UTC

BaseElementExtension::getVirtualElements() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0

<?php

namespace DNADesign\ElementalVirtual\Extensions;

use DNADesign\ElementalVirtual\Forms\ElementalGridFieldDeleteAction;
use DNADesign\ElementalVirtual\Model\ElementVirtual;
use SilverStripe\ORM\DataExtension;
use SilverStripe\Forms\FieldList;
use SilverStripe\Versioned\Versioned;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\GridField\GridFieldConfig_Base;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldDetailForm;

class BaseElementExtension extends DataExtension
{
    /**
     * @var mixed
     */
    protected $virtualOwner;

    /**
     * @config
     *
     * @var boolean
     */
    private static $default_global_elements = true;

    /**
     * @var array
     */
    private static $db = [
        'AvailableGlobally' => 'Boolean(1)'
    ];

    /** I added this part to make all newly created elements 'AvailableGlobally' by default **/
    private static $defaults [

        'AvailableGlobally' => 1
    ];
    
    /**
     * @var array $has_many
     */
    private static $has_many = [
        'VirtualClones' => ElementVirtual::class
    ];

    public function populateDefaults()
    {
        $this->AvailableGlobally = $this->owner->config()->get('default_global_elements');
    }

    /**
     * @param ElementVirtual
     *
     * @return $this
     */
    public function setVirtualOwner(ElementVirtual $owner)
    {
        $this->virtualOwner = $owner;
        return $this;
    }

    /**
     * @return ElementVirtual
     */
    public function getVirtualOwner()
    {
        return $this->virtualOwner;
    }

    /**
     * Finds and returns elements that are virtual elements which link to this
     * element.
     *
     * @return DataList
     */
    public function getVirtualElements()
    {
        return ElementVirtual::get()->filter('LinkedElementID', $this->owner->ID);
    }

    /**
     * @return DataList
     */
    public function getPublishedVirtualElements()
    {
        return ElementVirtual::get()->filter('LinkedElementID', $this->owner->ID)->setDataQueryParam([
            'Versioned.mode' => 'stage',
            'Versioned.stage' => 'Live'
        ]);
    }

    /**
     * @param FieldList $fields
     *
     * @return FieldList
     */
    public function updateCMSFields(FieldList $fields)
    {
        $global = $fields->dataFieldByName('AvailableGlobally');

        if ($global) {
            $fields->removeByName('AvailableGlobally');
            $fields->addFieldToTab('Root.Settings', $global);
        }

        if ($virtual = $fields->dataFieldByName('VirtualClones')) {
            if ($this->owner->VirtualClones()->Count() > 0) {
                $tab = $fields->findOrMakeTab('Root.VirtualClones');
                $tab->setTitle(_t(__CLASS__ . '.LinkedTo', 'Linked To'));

                if ($ownerPage = $this->owner->getPage()) {
                    $fields->addFieldToTab(
                        'Root.VirtualClones',
                        LiteralField::create(
                            'DisplaysOnPage',
                            sprintf(
                                "<p>"
                                . _t(__CLASS__ . '.OriginalContentFrom', 'The original content element appears on')
                                . " <a href='%s'>%s</a></p>",
                                ($ownerPage->hasMethod('CMSEditLink') && $ownerPage->canEdit()) ? $ownerPage->CMSEditLink() : $ownerPage->Link(),
                                $ownerPage->MenuTitle
                            )
                        ),
                        'VirtualClones'
                    );
                }

                $virtual->setConfig(new GridFieldConfig_Base());
                $virtual
                    ->setTitle(_t(__CLASS__ . '.OtherPages', 'Other pages'))
                    ->getConfig()
                        ->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
                        ->removeComponentsByType(GridFieldAddNewButton::class)
                        ->removeComponentsByType(GridFieldDeleteAction::class)
                        ->removeComponentsByType(GridFieldDetailForm::class)
                        ->addComponent(new ElementalGridFieldDeleteAction());

                $virtual->getConfig()
                    ->getComponentByType(GridFieldDataColumns::class)
                    ->setDisplayFields([
                        'getPage.Title' => _t(__CLASS__ . '.GridFieldTitle', 'Title'),
                        'ParentCMSEditLink' => _t(__CLASS__ . '.GridFieldUsedOn', 'Used on'),
                    ]);
            } else {
                $fields->removeByName('VirtualClones');
            }
        }
    }

    /**
     * Ensure that if there are elements that are virtualised from this element
     * that we move the original element to replace one of the virtual elements
     *
     * But only if it's a delete not an unpublish
     */
    public function onBeforeDelete()
    {
        if (Versioned::get_reading_mode() == 'Stage.Stage') {
            $firstVirtual = false;
            $allVirtual = $this->getVirtualElements();

            if ($this->getPublishedVirtualElements()->Count() > 0) {
                // choose the first one
                $firstVirtual = $this->getPublishedVirtualElements()->First();
                $wasPublished = true;
            } elseif ($allVirtual->Count() > 0) {
                // choose the first one
                $firstVirtual = $this->getVirtualElements()->First();
                $wasPublished = false;
            }
            if ($firstVirtual) {
                $origParentID = $this->ParentID;
                $origSort = $this->Sort;

                $clone = $this->duplicate(false);

                // set clones values to first virtual's values
                $clone->ParentID = $firstVirtual->ParentID;
                $clone->Sort = $firstVirtual->Sort;

                $clone->write();
                if ($wasPublished) {
                    $clone->doPublish();
                    $firstVirtual->doUnpublish();
                }

                // clone has a new ID, so need to repoint
                // all the other virtual elements
                foreach ($allVirtual as $virtual) {
                    if ($virtual->ID == $firstVirtual->ID) {
                        continue;
                    }
                    $pub = false;
                    if ($virtual->isPublished()) {
                        $pub = true;
                    }
                    $virtual->LinkedElementID = $clone->ID;
                    $virtual->write();
                    if ($pub) {
                        $virtual->doPublish();
                    }
                }

                $firstVirtual->delete();
            }
        }
    }

    /**
     * @param array $classes
     */
    public function updateAllowedElementClasses(&$classes)
    {
        if (isset($classes[ElementVirtual::class])) {
            unset($classes[ElementVirtual::class]);
        }
    }


    /**
     * get all pages where this element is used
     *
     * @return ArrayList
     */
    public function getUsage()
    {
        $usage = new ArrayList();

        if ($page = $this->getPage()) {
            $usage->push($page);
            if ($this->virtualOwner) {
                $page->setField('ElementType', 'Linked');
            } else {
                $page->setField('ElementType', 'Master');
            }
        }

        $linkedElements = ElementVirtual::get()->filter('LinkedElementID', $this->ID);

        foreach ($linkedElements as $element) {
            $area = $element->Parent();

            if ($area instanceof ElementalArea && $page = $area->getOwnerPage()) {
                $page->setField('ElementType', 'Linked');
                $usage->push($page);
            }
        }

        $usage->removeDuplicates();
        return $usage;
    }

    /**
     * @return DBHTMLText
     */
    public function UsageSummary()
    {
        $usage = $this->getUsage();
        $arr = array();
        foreach ($usage as $page) {
            $type = ($page->ElementType) ? sprintf("<em> - %s</em>", $page->ElementType) : null;
            $arr[] = sprintf("<a href=\"%s\" target=\"blank\">%s</a> %s", $page->CMSEditLink(), $page->Title, $type);
        }
        $html = DBHTMLText::create('UsageSummary');
        $html->setValue(implode('<br>', $arr));

        return $html;
    }

    /**
     * @param DBHTMLVarchar
     */
    public function updateElementIcon($icon)
    {
        $linked = $this->owner->LinkedElement();

        if ($linked) {
            $linkedIcon = $linked->config()->get('icon');

            $icon = DBField::create_field('HTMLVarchar', '<span class="el-icongroup"><img width="16px" src="' . Director::absoluteBaseURL() . $linkedIcon . '" alt="" /><img class="el-icon--virtual" width="16px" src="' . Director::absoluteBaseURL() . $icon . '" alt="" /></span>');
        }
    }
}


1			<?php
2
3			namespace DNADesign\ElementalVirtual\Extensions;
4
5			use DNADesign\ElementalVirtual\Forms\ElementalGridFieldDeleteAction;
6			use DNADesign\ElementalVirtual\Model\ElementVirtual;
7			use SilverStripe\ORM\DataExtension;
8			use SilverStripe\Forms\FieldList;
9			use SilverStripe\Versioned\Versioned;
10			use SilverStripe\Forms\LiteralField;
11			use SilverStripe\Forms\GridField\GridFieldConfig_Base;
12			use SilverStripe\Forms\GridField\GridFieldDataColumns;
13			use SilverStripe\Forms\GridField\GridFieldAddNewButton;
14			use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
15			use SilverStripe\Forms\GridField\GridFieldDetailForm;
16
17			class BaseElementExtension extends DataExtension
18			{
19			/**
20			* @var mixed
21			*/
22			protected $virtualOwner;
23
24			/**
25			* @config
26			*
27			* @var boolean
28			*/
29			private static $default_global_elements = true;
30
31			/**
32			* @var array
33			*/
34			private static $db = [
35			'AvailableGlobally' => 'Boolean(1)'
36			];
37
38			/ I added this part to make all newly created elements 'AvailableGlobally' by default /
39			private static $defaults [
			0 ignored issues – show Bug introduced 2018-10-19 14:51 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected '[', expecting ',' or ';' on line 39 at column 29 Loading history...
40			'AvailableGlobally' => 1
41			];
42
43			/**
44			* @var array $has_many
45			*/
46			private static $has_many = [
47			'VirtualClones' => ElementVirtual::class
48			];
49
50			public function populateDefaults()
51			{
52			$this->AvailableGlobally = $this->owner->config()->get('default_global_elements');
53			}
54
55			/**
56			* @param ElementVirtual
57			*
58			* @return $this
59			*/
60			public function setVirtualOwner(ElementVirtual $owner)
61			{
62			$this->virtualOwner = $owner;
63			return $this;
64			}
65
66			/**
67			* @return ElementVirtual
68			*/
69			public function getVirtualOwner()
70			{
71			return $this->virtualOwner;
72			}
73
74			/**
75			* Finds and returns elements that are virtual elements which link to this
76			* element.
77			*
78			* @return DataList
79			*/
80			public function getVirtualElements()
81			{
82			return ElementVirtual::get()->filter('LinkedElementID', $this->owner->ID);
83			}
84
85			/**
86			* @return DataList
87			*/
88			public function getPublishedVirtualElements()
89			{
90			return ElementVirtual::get()->filter('LinkedElementID', $this->owner->ID)->setDataQueryParam([
91			'Versioned.mode' => 'stage',
92			'Versioned.stage' => 'Live'
93			]);
94			}
95
96			/**
97			* @param FieldList $fields
98			*
99			* @return FieldList
100			*/
101			public function updateCMSFields(FieldList $fields)
102			{
103			$global = $fields->dataFieldByName('AvailableGlobally');
104
105			if ($global) {
106			$fields->removeByName('AvailableGlobally');
107			$fields->addFieldToTab('Root.Settings', $global);
108			}
109
110			if ($virtual = $fields->dataFieldByName('VirtualClones')) {
111			if ($this->owner->VirtualClones()->Count() > 0) {
112			$tab = $fields->findOrMakeTab('Root.VirtualClones');
113			$tab->setTitle(_t(__CLASS__ . '.LinkedTo', 'Linked To'));
114
115			if ($ownerPage = $this->owner->getPage()) {
116			$fields->addFieldToTab(
117			'Root.VirtualClones',
118			LiteralField::create(
119			'DisplaysOnPage',
120			sprintf(
121			"<p>"
122			. _t(__CLASS__ . '.OriginalContentFrom', 'The original content element appears on')
123			. " <a href='%s'>%s</a></p>",
124			($ownerPage->hasMethod('CMSEditLink') && $ownerPage->canEdit()) ? $ownerPage->CMSEditLink() : $ownerPage->Link(),
125			$ownerPage->MenuTitle
126			)
127			),
128			'VirtualClones'
129			);
130			}
131
132			$virtual->setConfig(new GridFieldConfig_Base());
133			$virtual
134			->setTitle(_t(__CLASS__ . '.OtherPages', 'Other pages'))
135			->getConfig()
136			->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
137			->removeComponentsByType(GridFieldAddNewButton::class)
138			->removeComponentsByType(GridFieldDeleteAction::class)
139			->removeComponentsByType(GridFieldDetailForm::class)
140			->addComponent(new ElementalGridFieldDeleteAction());
141
142			$virtual->getConfig()
143			->getComponentByType(GridFieldDataColumns::class)
144			->setDisplayFields([
145			'getPage.Title' => _t(__CLASS__ . '.GridFieldTitle', 'Title'),
146			'ParentCMSEditLink' => _t(__CLASS__ . '.GridFieldUsedOn', 'Used on'),
147			]);
148			} else {
149			$fields->removeByName('VirtualClones');
150			}
151			}
152			}
153
154			/**
155			* Ensure that if there are elements that are virtualised from this element
156			* that we move the original element to replace one of the virtual elements
157			*
158			* But only if it's a delete not an unpublish
159			*/
160			public function onBeforeDelete()
161			{
162			if (Versioned::get_reading_mode() == 'Stage.Stage') {
163			$firstVirtual = false;
164			$allVirtual = $this->getVirtualElements();
165
166			if ($this->getPublishedVirtualElements()->Count() > 0) {
167			// choose the first one
168			$firstVirtual = $this->getPublishedVirtualElements()->First();
169			$wasPublished = true;
170			} elseif ($allVirtual->Count() > 0) {
171			// choose the first one
172			$firstVirtual = $this->getVirtualElements()->First();
173			$wasPublished = false;
174			}
175			if ($firstVirtual) {
176			$origParentID = $this->ParentID;
177			$origSort = $this->Sort;
178
179			$clone = $this->duplicate(false);
180
181			// set clones values to first virtual's values
182			$clone->ParentID = $firstVirtual->ParentID;
183			$clone->Sort = $firstVirtual->Sort;
184
185			$clone->write();
186			if ($wasPublished) {
187			$clone->doPublish();
188			$firstVirtual->doUnpublish();
189			}
190
191			// clone has a new ID, so need to repoint
192			// all the other virtual elements
193			foreach ($allVirtual as $virtual) {
194			if ($virtual->ID == $firstVirtual->ID) {
195			continue;
196			}
197			$pub = false;
198			if ($virtual->isPublished()) {
199			$pub = true;
200			}
201			$virtual->LinkedElementID = $clone->ID;
202			$virtual->write();
203			if ($pub) {
204			$virtual->doPublish();
205			}
206			}
207
208			$firstVirtual->delete();
209			}
210			}
211			}
212
213			/**
214			* @param array $classes
215			*/
216			public function updateAllowedElementClasses(&$classes)
217			{
218			if (isset($classes[ElementVirtual::class])) {
219			unset($classes[ElementVirtual::class]);
220			}
221			}
222
223
224			/**
225			* get all pages where this element is used
226			*
227			* @return ArrayList
228			*/
229			public function getUsage()
230			{
231			$usage = new ArrayList();
232
233			if ($page = $this->getPage()) {
234			$usage->push($page);
235			if ($this->virtualOwner) {
236			$page->setField('ElementType', 'Linked');
237			} else {
238			$page->setField('ElementType', 'Master');
239			}
240			}
241
242			$linkedElements = ElementVirtual::get()->filter('LinkedElementID', $this->ID);
243
244			foreach ($linkedElements as $element) {
245			$area = $element->Parent();
246
247			if ($area instanceof ElementalArea && $page = $area->getOwnerPage()) {
248			$page->setField('ElementType', 'Linked');
249			$usage->push($page);
250			}
251			}
252
253			$usage->removeDuplicates();
254			return $usage;
255			}
256
257			/**
258			* @return DBHTMLText
259			*/
260			public function UsageSummary()
261			{
262			$usage = $this->getUsage();
263			$arr = array();
264			foreach ($usage as $page) {
265			$type = ($page->ElementType) ? sprintf("<em> - %s</em>", $page->ElementType) : null;
266			$arr[] = sprintf("<a href=\"%s\" target=\"blank\">%s</a> %s", $page->CMSEditLink(), $page->Title, $type);
267			}
268			$html = DBHTMLText::create('UsageSummary');
269			$html->setValue(implode('<br>', $arr));
270
271			return $html;
272			}
273
274			/**
275			* @param DBHTMLVarchar
276			*/
277			public function updateElementIcon($icon)
278			{
279			$linked = $this->owner->LinkedElement();
280
281			if ($linked) {
282			$linkedIcon = $linked->config()->get('icon');
283
284			$icon = DBField::create_field('HTMLVarchar', '<span class="el-icongroup"><img width="16px" src="' . Director::absoluteBaseURL() . $linkedIcon . '" alt="" /><img class="el-icon--virtual" width="16px" src="' . Director::absoluteBaseURL() . $icon . '" alt="" /></span>');
285			}
286			}
287			}
288

dnadesign / silverstripe-elemental-virtual

Pull Request — master (#19)

BaseElementExtension::getVirtualElements() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like