ElementPageExtension::onAfterDuplicate() - Code Metrics - Inspection of "fix(ElementalPageExtension): Make ElementArea grid..." - dnadesign/silverstripe-elemental - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#50)

unknown

created 2016-09-18 06:51 UTC

ElementPageExtension::onAfterDuplicate() A

↳ Parent: ElementPageExtension

Complexity

Conditions	4
Paths	3

Size

Total Lines	17
Code Lines	10

Duplication

Lines	6
Ratio	35.29 %

Importance

Changes

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

<?php

use \Heyday\VersionedDataObjects\VersionedDataObjectDetailsForm;

/**
 * @package elemental
 */
class ElementPageExtension extends DataExtension
namespace YourVendor;

class YourClass { }
{

    /**
     * @config
     *
     * @var string $elements_title Title of the element in the CMS.
     */
    private static $elements_title = 'Content Blocks';


    /**
     * @config
     *
     * @var boolean $disable_element_publish_button Disable publish / unpublish buttons in GridFieldDetailForm.
     */
    private static $disable_element_publish_button = false;


    /**
     * @config
     *
     * @var array $ignored_classes Classes to ignore adding elements too.
     */
    private static $ignored_classes = array();


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


    /**
     * @config
     *
     * @var boolean
     */
    private static $clear_contentfield = false;


    /**
     * @var array $db
     */
    private static $db = array();


    /**
     * @var array $has_one
     */
    private static $has_one = array(

        'ElementArea' => 'ElementalArea'
    );

    /**
     * Setup the CMS Fields
     *
     * @param FieldList
     */
    public function updateCMSFields(FieldList $fields)
    {
        if(!$this->supportsElemental()) {
            return;
        }

        // add an empty holder for content as some module explicitly use insert
        // after content.
        $fields->replaceField('Content', new LiteralField('Content', ''));

        $adder = new ElementalGridFieldAddNewMultiClass();

        $list = $this->getAvailableTypes();
        if($list) {

            $adder->setClasses($list);
        }

        $area = $this->owner->ElementArea();
        if ($this->owner->exists() && (!$area->exists() || !$area->isInDB())) {
            $area->write();

            $this->owner->ElementAreaID = $area->ID;
            $this->owner->write();
        }

        $gridField = GridField::create('ElementArea',
            Config::inst()->get("ElementPageExtension", 'elements_title'),
            $area->AllElements(),
            GridFieldConfig_RelationEditor::create()
                ->removeComponentsByType('GridFieldAddNewButton')
                ->removeComponentsByType('GridFieldSortableHeader')
                ->removeComponentsByType('GridFieldDeleteAction')
                ->removeComponentsByType('GridFieldAddExistingAutocompleter')
                ->addComponent($autocomplete = new ElementalGridFieldAddExistingAutocompleter())
                ->addComponent(new ElementalGridFieldDeleteAction())
                ->addComponent(new GridFieldTitleHeader())
                ->addComponent($adder)
                ->addComponent(new GridFieldSortableRows('Sort'))
        );

        if($list) {

            $autocomplete->setSearchList(BaseElement::get()->filter('ClassName', array_keys($list)));
        }

        $config = $gridField->getConfig();
        $paginator = $config->getComponentByType('GridFieldPaginator');
        $paginator->setItemsPerPage(100);

        if (!$this->owner->config()->disable_element_publish_button) {
            $config->removeComponentsByType('GridFieldDetailForm');
            $config->addComponent($obj = new VersionedDataObjectDetailsForm());
        }

        if ($this->owner instanceof SiteTree && $fields->findOrMakeTab('Root.Main')->fieldByName('Metadata')) {
            $fields->addFieldToTab('Root.Main', $gridField, 'Metadata');
        } else {
            $fields->addFieldToTab('Root.Main', $gridField);
        }

        return $fields;
    }

    /**
     * @return array
     */
    public function getAvailableTypes() {
        if (is_array($this->owner->config()->get('allowed_elements'))) {
            $list = $this->owner->config()->get('allowed_elements');

            if($this->owner->config()->get('sort_types_alphabetically') !== false) {

                $sorted = array();

                foreach ($list as $class) {
                    $inst = singleton($class);

                    if ($inst->canCreate()) {
                        $sorted[$class] = singleton($class)->i18n_singular_name();
                    }
                }

                $list = $sorted;
                asort($list);
            }
        } else {

            $classes = ClassInfo::subclassesFor('BaseElement');
            $list = array();
            unset($classes['BaseElement']);

            $disallowedElements = (array) $this->owner->config()->get('disallowed_elements');

            if (!in_array('ElementVirtualLinked', $disallowedElements)) {
                array_push($disallowedElements, 'ElementVirtualLinked');
            }

            foreach ($classes as $class) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $inst = singleton($class);

                if (!in_array($class, $disallowedElements) && $inst->canCreate()) {
                    $list[$class] = singleton($class)->i18n_singular_name();
                }
            }

            asort($list);
        }

        if (method_exists($this->owner, 'sortElementalOptions')) {
            $this->owner->sortElementalOptions($list);
        }

        return $list;
    }

    /**
     * Make sure there is always a WidgetArea sidebar for adding widgets
     *
     */
    public function onBeforeWrite()
    {
        if(!$this->supportsElemental()) {
            return;
        }

        // enable theme in case elements are being rendered with templates stored in theme folder
        $originalThemeEnabled = Config::inst()->get('SSViewer', 'theme_enabled');
        Config::inst()->update('SSViewer', 'theme_enabled', true);


        if ($this->owner->hasMethod('ElementArea') && Config::inst()->get(__CLASS__, 'copy_element_content_to_contentfield')) {
            $elements = $this->owner->ElementArea();

            if (!$elements->isInDB()) {
                $elements->write();
                $this->owner->ElementAreaID = $elements->ID;
            } else {
                // Copy widgets content to Content to enable search
                $searchableContent = array();

                Requirements::clear();

                foreach ($elements->Elements() as $element) {
                    if ($element->config()->exclude_from_content) {
                        continue;
                    }

                    $controller = $element->getController();
                    $controller->init();

                    array_push($searchableContent, $controller->WidgetHolder());
                }

                Requirements::restore();

                $this->owner->Content = trim(implode(' ', $searchableContent));
            }
        } else {
            if(Config::inst()->get(__CLASS__, 'clear_contentfield')) {
                $this->owner->Content = '';
            }
        }


        // set theme_enabled back to what it was
        Config::inst()->update('SSViewer', 'theme_enabled', $originalThemeEnabled);

        parent::onBeforeWrite();
    }

    /**
     * @return boolean
     */
    public function supportsElemental() {
        if (method_exists($this->owner, 'includeElemental')) {
            return $this->owner->includeElemental();
        }

        if (is_a($this->owner, 'RedirectorPage')) {
            return false;
        } else if ($ignored = Config::inst()->get('ElementPageExtension', 'ignored_classes')) {
            foreach ($ignored as $check) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if (is_a($this->owner, $check)) {
                    return false;
                }
            }
        }

        return true;
    }

    /**
     * If the page is duplicated, copy the widgets across too.
     *
     * Gets called twice from either direction, due to bad DataObject and SiteTree code, hence the weird if statement
     *
     * @return Page The duplicated page

     */
    public function onAfterDuplicate($duplicatePage)
    {
        if ($this->owner->ID != 0 && $this->owner->ID < $duplicatePage->ID) {
            $originalWidgetArea = $this->owner->getComponent('ElementArea');
            $duplicateWidgetArea = $originalWidgetArea->duplicate(false);
            $duplicateWidgetArea->write();
            $duplicatePage->ElementAreaID = $duplicateWidgetArea->ID;
            $duplicatePage->write();

            foreach ($originalWidgetArea->Items() as $originalWidget) {

                $duplicateWidget = $originalWidget->duplicate(true);

                // manually set the ParentID of each widget, so we don't get versioning issues
                DB::query(sprintf("UPDATE Widget SET ParentID = %d WHERE ID = %d", $duplicateWidgetArea->ID, $duplicateWidget->ID));
            }
        }
    }

    /**
     * If the page is duplicated across subsites, copy the widgets across too.
     *
     * @return Page The duplicated page

     */
    public function onAfterDuplicateToSubsite($originalPage)
    {
        $originalWidgetArea = $originalPage->getComponent('ElementArea');
        $duplicateWidgetArea = $originalWidgetArea->duplicate(false);
        $duplicateWidgetArea->write();
        $this->owner->ElementAreaID = $duplicateWidgetArea->ID;
        $this->owner->write();

        foreach ($originalWidgetArea->Items() as $originalWidget) {

            $duplicateWidget = $originalWidget->duplicate(true);

            // manually set the ParentID of each widget, so we don't get versioning issues
            DB::query(sprintf("UPDATE Widget SET ParentID = %d WHERE ID = %d", $duplicateWidgetArea->ID, $duplicateWidget->ID));
        }
    }

    /**
     * Publish
     */
    public function onAfterPublish()
    {
        if ($id = $this->owner->ElementAreaID) {
            $widgets = Versioned::get_by_stage('BaseElement', 'Stage', "ParentID = '$id'");
            $staged = array();

            foreach ($widgets as $widget) {
                $staged[] = $widget->ID;

                $widget->publish('Stage', 'Live');
            }

            // remove any elements that are on live but not in draft.
            $widgets = Versioned::get_by_stage('BaseElement', 'Live', "ParentID = '$id'");

            foreach ($widgets as $widget) {
                if (!in_array($widget->ID, $staged)) {
                    $widget->deleteFromStage('Live');
                }
            }
        }
    }

    /**
     * Roll back all changes if the parent page has a rollback event
     *
     * Only do rollback if it's the 'cancel draft changes' rollback, not a specific version
     * rollback.
     *
     * @param string $version
     * @return null
     */
    public function onBeforeRollback($version)
    {
        if ($version !== 'Live') {
            // we don't yet have a smart way of rolling back to a specific version
            return;
        }
        if ($id = $this->owner->ElementAreaID) {
            $widgets = Versioned::get_by_stage('BaseElement', 'Live', "ParentID = '$id'");
            $staged = array();

            foreach ($widgets as $widget) {
                $staged[] = $widget->ID;

                $widget->invokeWithExtensions('onBeforeRollback', $widget);

                $widget->publish("Live", "Stage", false);

                $widget->invokeWithExtensions('onAfterRollback', $widget);
            }
        }
    }
}


1		<?php
2
3		use \Heyday\VersionedDataObjects\VersionedDataObjectDetailsForm;
4
5		/**
6		* @package elemental
7		*/
8		class ElementPageExtension extends DataExtension
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9		{
10
11		/**
12		* @config
13		*
14		* @var string $elements_title Title of the element in the CMS.
15		*/
16		private static $elements_title = 'Content Blocks';
		0 ignored issues – show Unused Code introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$elements_title` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
17
18		/**
19		* @config
20		*
21		* @var boolean $disable_element_publish_button Disable publish / unpublish buttons in GridFieldDetailForm.
22		*/
23		private static $disable_element_publish_button = false;
		0 ignored issues – show Unused Code introduced 2016-07-01 01:03 UTC by Report Bug Copy Issue Report The property `$disable_element_publish_button` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
24
25		/**
26		* @config
27		*
28		* @var array $ignored_classes Classes to ignore adding elements too.
29		*/
30		private static $ignored_classes = array();
		0 ignored issues – show Unused Code introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$ignored_classes` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
31
32		/**
33		* @config
34		*
35		* @var boolean
36		*/
37		private static $copy_element_content_to_contentfield = true;
		0 ignored issues – show Unused Code introduced 2016-07-05 05:23 UTC by Report Bug Copy Issue Report The property `$copy_element_content_to_contentfield` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
38
39		/**
40		* @config
41		*
42		* @var boolean
43		*/
44		private static $clear_contentfield = false;
		0 ignored issues – show Unused Code introduced 2016-07-05 05:23 UTC by Report Bug Copy Issue Report The property `$clear_contentfield` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
45
46		/**
47		* @var array $db
48		*/
49		private static $db = array();
		0 ignored issues – show Unused Code introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
50
51		/**
52		* @var array $has_one
53		*/
54		private static $has_one = array(
		0 ignored issues – show Unused Code introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$has_one` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
55		'ElementArea' => 'ElementalArea'
56		);
57
58		/**
59		* Setup the CMS Fields
60		*
61		* @param FieldList
62		*/
63		public function updateCMSFields(FieldList $fields)
64		{
65		if(!$this->supportsElemental()) {
66		return;
67		}
68
69		// add an empty holder for content as some module explicitly use insert
70		// after content.
71		$fields->replaceField('Content', new LiteralField('Content', ''));
72
73		$adder = new ElementalGridFieldAddNewMultiClass();
74
75		$list = $this->getAvailableTypes();
76		if($list) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-08 02:52 UTC by Report Bug Copy Issue Report The expression `$list` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
77		$adder->setClasses($list);
78		}
79
80		$area = $this->owner->ElementArea();
81		if ($this->owner->exists() && (!$area->exists() \|\| !$area->isInDB())) {
82		$area->write();
83
84		$this->owner->ElementAreaID = $area->ID;
85		$this->owner->write();
86		}
87
88		$gridField = GridField::create('ElementArea',
89		Config::inst()->get("ElementPageExtension", 'elements_title'),
90		$area->AllElements(),
91		GridFieldConfig_RelationEditor::create()
92		->removeComponentsByType('GridFieldAddNewButton')
93		->removeComponentsByType('GridFieldSortableHeader')
94		->removeComponentsByType('GridFieldDeleteAction')
95		->removeComponentsByType('GridFieldAddExistingAutocompleter')
96		->addComponent($autocomplete = new ElementalGridFieldAddExistingAutocompleter())
97		->addComponent(new ElementalGridFieldDeleteAction())
98		->addComponent(new GridFieldTitleHeader())
99		->addComponent($adder)
100		->addComponent(new GridFieldSortableRows('Sort'))
101		);
102
103		if($list) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-25 02:54 UTC by Report Bug Copy Issue Report The expression `$list` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
104		$autocomplete->setSearchList(BaseElement::get()->filter('ClassName', array_keys($list)));
105		}
106
107		$config = $gridField->getConfig();
108		$paginator = $config->getComponentByType('GridFieldPaginator');
109		$paginator->setItemsPerPage(100);
110
111		if (!$this->owner->config()->disable_element_publish_button) {
112		$config->removeComponentsByType('GridFieldDetailForm');
113		$config->addComponent($obj = new VersionedDataObjectDetailsForm());
114		}
115
116		if ($this->owner instanceof SiteTree && $fields->findOrMakeTab('Root.Main')->fieldByName('Metadata')) {
117		$fields->addFieldToTab('Root.Main', $gridField, 'Metadata');
118		} else {
119		$fields->addFieldToTab('Root.Main', $gridField);
120		}
121
122		return $fields;
123		}
124
125		/**
126		* @return array
127		*/
128		public function getAvailableTypes() {
129		if (is_array($this->owner->config()->get('allowed_elements'))) {
130		$list = $this->owner->config()->get('allowed_elements');
131
132	View Code Duplication	if($this->owner->config()->get('sort_types_alphabetically') !== false) {
		0 ignored issues – show Duplication introduced 2016-06-24 04:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
133		$sorted = array();
134
135		foreach ($list as $class) {
136		$inst = singleton($class);
137
138		if ($inst->canCreate()) {
139		$sorted[$class] = singleton($class)->i18n_singular_name();
140		}
141		}
142
143		$list = $sorted;
144		asort($list);
145		}
146	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
147		$classes = ClassInfo::subclassesFor('BaseElement');
148		$list = array();
149		unset($classes['BaseElement']);
150
151		$disallowedElements = (array) $this->owner->config()->get('disallowed_elements');
152
153		if (!in_array('ElementVirtualLinked', $disallowedElements)) {
154		array_push($disallowedElements, 'ElementVirtualLinked');
155		}
156
157		foreach ($classes as $class) {
		0 ignored issues – show Bug introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The expression `$classes` of type `null\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
158		$inst = singleton($class);
159
160		if (!in_array($class, $disallowedElements) && $inst->canCreate()) {
161		$list[$class] = singleton($class)->i18n_singular_name();
162		}
163		}
164
165		asort($list);
166		}
167
168		if (method_exists($this->owner, 'sortElementalOptions')) {
169		$this->owner->sortElementalOptions($list);
170		}
171
172		return $list;
173		}
174
175		/**
176		* Make sure there is always a WidgetArea sidebar for adding widgets
177		*
178		*/
179		public function onBeforeWrite()
180		{
181		if(!$this->supportsElemental()) {
182		return;
183		}
184
185		// enable theme in case elements are being rendered with templates stored in theme folder
186		$originalThemeEnabled = Config::inst()->get('SSViewer', 'theme_enabled');
187		Config::inst()->update('SSViewer', 'theme_enabled', true);
188
189
190		if ($this->owner->hasMethod('ElementArea') && Config::inst()->get(__CLASS__, 'copy_element_content_to_contentfield')) {
191		$elements = $this->owner->ElementArea();
192
193		if (!$elements->isInDB()) {
194		$elements->write();
195		$this->owner->ElementAreaID = $elements->ID;
196		} else {
197		// Copy widgets content to Content to enable search
198		$searchableContent = array();
199
200		Requirements::clear();
201
202		foreach ($elements->Elements() as $element) {
203		if ($element->config()->exclude_from_content) {
204		continue;
205		}
206
207		$controller = $element->getController();
208		$controller->init();
209
210		array_push($searchableContent, $controller->WidgetHolder());
211		}
212
213		Requirements::restore();
214
215		$this->owner->Content = trim(implode(' ', $searchableContent));
216		}
217		} else {
218		if(Config::inst()->get(__CLASS__, 'clear_contentfield')) {
219		$this->owner->Content = '';
220		}
221		}
222
223
224		// set theme_enabled back to what it was
225		Config::inst()->update('SSViewer', 'theme_enabled', $originalThemeEnabled);
226
227		parent::onBeforeWrite();
228		}
229
230		/**
231		* @return boolean
232		*/
233		public function supportsElemental() {
234		if (method_exists($this->owner, 'includeElemental')) {
235		return $this->owner->includeElemental();
236		}
237
238		if (is_a($this->owner, 'RedirectorPage')) {
239		return false;
240		} else if ($ignored = Config::inst()->get('ElementPageExtension', 'ignored_classes')) {
241		foreach ($ignored as $check) {
		0 ignored issues – show Bug introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The expression `$ignored` of type `array\|integer\|double\|string\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
242		if (is_a($this->owner, $check)) {
243		return false;
244		}
245		}
246		}
247
248		return true;
249		}
250
251		/**
252		* If the page is duplicated, copy the widgets across too.
253		*
254		* Gets called twice from either direction, due to bad DataObject and SiteTree code, hence the weird if statement
255		*
256		* @return Page The duplicated page
		0 ignored issues – show Documentation introduced 2016-06-08 02:52 UTC by Report Bug Copy Issue Report Should the return type not be `Page\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
257		*/
258		public function onAfterDuplicate($duplicatePage)
259		{
260		if ($this->owner->ID != 0 && $this->owner->ID < $duplicatePage->ID) {
261		$originalWidgetArea = $this->owner->getComponent('ElementArea');
262		$duplicateWidgetArea = $originalWidgetArea->duplicate(false);
263		$duplicateWidgetArea->write();
264		$duplicatePage->ElementAreaID = $duplicateWidgetArea->ID;
265		$duplicatePage->write();
266
267	View Code Duplication	foreach ($originalWidgetArea->Items() as $originalWidget) {
		0 ignored issues – show Duplication introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
268		$duplicateWidget = $originalWidget->duplicate(true);
269
270		// manually set the ParentID of each widget, so we don't get versioning issues
271		DB::query(sprintf("UPDATE Widget SET ParentID = %d WHERE ID = %d", $duplicateWidgetArea->ID, $duplicateWidget->ID));
272		}
273		}
274		}
275
276		/**
277		* If the page is duplicated across subsites, copy the widgets across too.
278		*
279		* @return Page The duplicated page
		0 ignored issues – show Documentation introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report Should the return type not be `Page\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
280		*/
281		public function onAfterDuplicateToSubsite($originalPage)
282		{
283		$originalWidgetArea = $originalPage->getComponent('ElementArea');
284		$duplicateWidgetArea = $originalWidgetArea->duplicate(false);
285		$duplicateWidgetArea->write();
286		$this->owner->ElementAreaID = $duplicateWidgetArea->ID;
287		$this->owner->write();
288
289	View Code Duplication	foreach ($originalWidgetArea->Items() as $originalWidget) {
		0 ignored issues – show Duplication introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
290		$duplicateWidget = $originalWidget->duplicate(true);
291
292		// manually set the ParentID of each widget, so we don't get versioning issues
293		DB::query(sprintf("UPDATE Widget SET ParentID = %d WHERE ID = %d", $duplicateWidgetArea->ID, $duplicateWidget->ID));
294		}
295		}
296
297		/**
298		* Publish
299		*/
300		public function onAfterPublish()
301		{
302		if ($id = $this->owner->ElementAreaID) {
303		$widgets = Versioned::get_by_stage('BaseElement', 'Stage', "ParentID = '$id'");
304		$staged = array();
305
306		foreach ($widgets as $widget) {
307		$staged[] = $widget->ID;
308
309		$widget->publish('Stage', 'Live');
310		}
311
312		// remove any elements that are on live but not in draft.
313		$widgets = Versioned::get_by_stage('BaseElement', 'Live', "ParentID = '$id'");
314
315		foreach ($widgets as $widget) {
316		if (!in_array($widget->ID, $staged)) {
317		$widget->deleteFromStage('Live');
318		}
319		}
320		}
321		}
322
323		/**
324		* Roll back all changes if the parent page has a rollback event
325		*
326		* Only do rollback if it's the 'cancel draft changes' rollback, not a specific version
327		* rollback.
328		*
329		* @param string $version
330		* @return null
331		*/
332		public function onBeforeRollback($version)
333		{
334		if ($version !== 'Live') {
335		// we don't yet have a smart way of rolling back to a specific version
336		return;
337		}
338		if ($id = $this->owner->ElementAreaID) {
339		$widgets = Versioned::get_by_stage('BaseElement', 'Live', "ParentID = '$id'");
340		$staged = array();
341
342		foreach ($widgets as $widget) {
343		$staged[] = $widget->ID;
344
345		$widget->invokeWithExtensions('onBeforeRollback', $widget);
346
347		$widget->publish("Live", "Stage", false);
348
349		$widget->invokeWithExtensions('onAfterRollback', $widget);
350		}
351		}
352		}
353		}
354

dnadesign / silverstripe-elemental

Pull Request — master (#50)

ElementPageExtension::onAfterDuplicate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like