ElementVirtualLinked::getCMSPublishedState() - Code Metrics - Inspection of "Merge pull request #57 from SilbinaryWolf/fix-virt..." - dnadesign/silverstripe-elemental - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fe52ea...5cca73 )

by Will

created 2016-11-29 04:28 UTC

ElementVirtualLinked::getCMSPublishedState() B

↳ Parent: ElementVirtualLinked

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.6845
c	0
b	0
f	0
cc	4
eloc	18
nc	4
nop	0

<?php

/**
 * Virtual Linked Element.
 *
 * As elemental is based on widgets which have a natural has_one relation to an
 * object, this is a workaround for allowing the same element to be linked to
 * multiple pages.
 *
 * {@see ElementalGridFieldAddExistingAutocompleter}
 *
 * @package elemental
 */
class ElementVirtualLinked extends BaseElement {
namespace YourVendor;

class YourClass { }
    /**
     * @var string
     */
    private static $title = 'Virtual linked Block';


    /**
     * @var string
     */
    private static $singular_name = 'Virtual linked Block';


    private static $has_one = array(

        'LinkedElement' => 'BaseElement'
    );

    public function getTitle()

    {
        return $this->LinkedElement()->getTitle();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function i18n_singular_name()
    {
        return _t(__CLASS__, $this->LinkedElement()->config()->title);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function getCMSFields() {

        $message = sprintf('<p>%s</p><p><a href="%2$s">%2$s</a></p>',
             _t('ElementVirtualLinked.DESCRIBE', 'This is a virtual copy of a block. To edit, visit'),
             $this->LinkedElement()->getEditLink()
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        );

        $fields = new FieldList(
            new TabSet('Root', $main = new Tab('Main'))
        );

        if ($this->isInvalidPublishState()) {
            $warning = 'Error: The original block is not published. This block will not work on the live site until you click the link below and publish it.';
            $main->push(new LiteralField('WarningHeader', '<p class="message error">' .$warning. '</p>'));
        }
        $main->push(new LiteralField('Existing', $message));

        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    public function getExtraClass() {
        return $this->LinkedElement()->ClassName . ' ' . $this->getField('ExtraClass');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Detect when a user has published a ElementVirtualLinked block
     * but has not published the LinkedElement block. 
     */
    public function isInvalidPublishState() {
        $block = $this->LinkedElement();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        return (!$block->isPublished() && $this->isPublished());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function getCMSPublishedState() {

        if ($this->isInvalidPublishState()) {
            $colour = '#C00';
            $text = 'Error';
            $html = new HTMLText('PublishedState');
            $html->setValue(sprintf(
                '<span style="color: %s;">%s</span>',
                $colour,
                htmlentities($text)
            ));
            return $html;
        }

        $publishedState = null;
        foreach($this->extension_instances as $instance) {
            if (method_exists($instance, 'getCMSPublishedState')) {
                $instance->setOwner($this);
                $publishedState = $instance->getCMSPublishedState();
                $instance->clearOwner();
                break;
            }
        }
        return $publishedState;
    }
}


1			<?php
2
3			/**
4			* Virtual Linked Element.
5			*
6			* As elemental is based on widgets which have a natural has_one relation to an
7			* object, this is a workaround for allowing the same element to be linked to
8			* multiple pages.
9			*
10			* {@see ElementalGridFieldAddExistingAutocompleter}
11			*
12			* @package elemental
13			*/
14			class ElementVirtualLinked extends BaseElement {
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-24 00:01 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...
15			/**
16			* @var string
17			*/
18			private static $title = 'Virtual linked Block';
			0 ignored issues – show Comprehensibility introduced 2016-09-14 22:51 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-09-14 22:51 UTC by Report Bug Copy Issue Report The property `$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...
19
20			/**
21			* @var string
22			*/
23			private static $singular_name = 'Virtual linked Block';
			0 ignored issues – show Comprehensibility introduced 2016-09-14 22:51 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-09-14 22:51 UTC by Report Bug Copy Issue Report The property `$singular_name` 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			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-05-24 00:01 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...
26			'LinkedElement' => 'BaseElement'
27			);
28
29			public function getTitle()
			0 ignored issues – show Documentation introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
30			{
31			return $this->LinkedElement()->getTitle();
			0 ignored issues – show Documentation Bug introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report The method `LinkedElement` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
32			}
33
34			public function i18n_singular_name()
35			{
36			return _t(__CLASS__, $this->LinkedElement()->config()->title);
			0 ignored issues – show Documentation Bug introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report The method `LinkedElement` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
37			}
38
39			public function getCMSFields() {
			0 ignored issues – show Documentation introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
40			$message = sprintf('<p>%s</p><p><a href="%2$s">%2$s</a></p>',
41			_t('ElementVirtualLinked.DESCRIBE', 'This is a virtual copy of a block. To edit, visit'),
42			$this->LinkedElement()->getEditLink()
			0 ignored issues – show Documentation Bug introduced 2016-05-24 00:01 UTC by Report Bug Copy Issue Report The method `LinkedElement` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
43			);
44
45			$fields = new FieldList(
46			new TabSet('Root', $main = new Tab('Main'))
47			);
48
49			if ($this->isInvalidPublishState()) {
50			$warning = 'Error: The original block is not published. This block will not work on the live site until you click the link below and publish it.';
51			$main->push(new LiteralField('WarningHeader', '<p class="message error">' .$warning. '</p>'));
52			}
53			$main->push(new LiteralField('Existing', $message));
54
55			$this->extend('updateCMSFields', $fields);
56
57			return $fields;
58			}
59
60			public function getExtraClass() {
61			return $this->LinkedElement()->ClassName . ' ' . $this->getField('ExtraClass');
			0 ignored issues – show Documentation Bug introduced 2016-09-25 22:52 UTC by Report Bug Copy Issue Report The method `LinkedElement` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
62			}
63
64			/**
65			* Detect when a user has published a ElementVirtualLinked block
66			* but has not published the LinkedElement block.
67			*/
68			public function isInvalidPublishState() {
69			$block = $this->LinkedElement();
			0 ignored issues – show Documentation Bug introduced 2016-11-03 01:07 UTC by Report Bug Copy Issue Report The method `LinkedElement` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
70			return (!$block->isPublished() && $this->isPublished());
			0 ignored issues – show Documentation Bug introduced 2016-11-03 01:07 UTC by Report Bug Copy Issue Report The method `isPublished` does not exist on `object<ElementVirtualLinked>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
71			}
72
73			public function getCMSPublishedState() {
			0 ignored issues – show Documentation introduced 2016-11-03 01:07 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
74			if ($this->isInvalidPublishState()) {
75			$colour = '#C00';
76			$text = 'Error';
77			$html = new HTMLText('PublishedState');
78			$html->setValue(sprintf(
79			'<span style="color: %s;">%s</span>',
80			$colour,
81			htmlentities($text)
82			));
83			return $html;
84			}
85
86			$publishedState = null;
87			foreach($this->extension_instances as $instance) {
88			if (method_exists($instance, 'getCMSPublishedState')) {
89			$instance->setOwner($this);
90			$publishedState = $instance->getCMSPublishedState();
91			$instance->clearOwner();
92			break;
93			}
94			}
95			return $publishedState;
96			}
97			}
98

dnadesign / silverstripe-elemental

Push — master ( fe52ea...5cca73 )

ElementVirtualLinked::getCMSPublishedState() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like