Passed
Pull Request — master (#45)
by
unknown
02:09
created

ElementVirtual::inlineEditable()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 1
c 1
b 0
f 0
dl 0
loc 3
rs 10
cc 1
nc 1
nop 0
1
<?php
2
3
namespace DNADesign\ElementalVirtual\Model;
4
5
use TractorCow\AutoComplete\AutoCompleteField;
6
use SilverStripe\ElementalVirtual\Forms\ElementalGridFieldAddExistingAutocompleter;
0 ignored issues
show
Bug introduced by
The type SilverStripe\ElementalVi...ddExistingAutocompleter was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
7
use DNADesign\Elemental\Models\BaseElement;
8
use SilverStripe\Forms\FieldList;
9
use SilverStripe\Forms\LiteralField;
10
use SilverStripe\Forms\Tab;
11
use SilverStripe\Forms\TabSet;
12
use SilverStripe\ORM\FieldType\DBField;
13
use SilverStripe\ORM\FieldType\DBHTMLText;
14
15
/**
16
 * Virtual Linked Element.
17
 *
18
 * As elemental is based on a natural has_one relation to an object,
19
 * this allows the same element to be linked to multiple pages.
20
 *
21
 * {@see ElementalGridFieldAddExistingAutocompleter}
22
 */
23
class ElementVirtual extends BaseElement
24
{
25
    private static $icon = 'font-icon-block-link';
0 ignored issues
show
introduced by
The private property $icon is not used, and could be removed.
Loading history...
26
27
    private static $has_one = [
0 ignored issues
show
introduced by
The private property $has_one is not used, and could be removed.
Loading history...
28
        'LinkedElement' => BaseElement::class
29
    ];
30
31
    /**
32
     * @var string
33
     */
34
    private static $description = 'Reused element';
0 ignored issues
show
introduced by
The private property $description is not used, and could be removed.
Loading history...
35
36
    private static $table_name = 'ElementVirtual';
0 ignored issues
show
introduced by
The private property $table_name is not used, and could be removed.
Loading history...
37
38
    private static $singular_name = 'virtual block';
0 ignored issues
show
introduced by
The private property $singular_name is not used, and could be removed.
Loading history...
39
    
40
    private static $inline_editable = false;
0 ignored issues
show
introduced by
The private property $inline_editable is not used, and could be removed.
Loading history...
41
42
    /**
43
     * @param BaseElement
44
     * @param boolean $isSingleton
45
     * @param DataModel $model
0 ignored issues
show
Bug introduced by
The type DNADesign\ElementalVirtual\Model\DataModel was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
46
     */
47
    public function __construct($record = null, $isSingleton = false, $model = null)
48
    {
49
        parent::__construct($record, $isSingleton, $model);
0 ignored issues
show
Bug introduced by
It seems like $model can also be of type DNADesign\ElementalVirtual\Model\DataModel; however, parameter $queryParams of SilverStripe\ORM\DataObject::__construct() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

49
        parent::__construct($record, $isSingleton, /** @scrutinizer ignore-type */ $model);
Loading history...
50
51
        $this->LinkedElement()->setVirtualOwner($this);
0 ignored issues
show
Bug introduced by
The method LinkedElement() does not exist on DNADesign\ElementalVirtual\Model\ElementVirtual. Since you implemented __call, consider adding a @method annotation. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

51
        $this->/** @scrutinizer ignore-call */ 
52
               LinkedElement()->setVirtualOwner($this);
Loading history...
52
    }
53
54
    public function getCMSFields()
55
    {
56
        $invalid = $this->isInvalidPublishState();
57
58
        $this->beforeUpdateCMSFields(function (FieldList $fields) use ($invalid) {
59
            $fields->removeByName('Title');
60
61
            $message = sprintf(
62
                '<p>%s</p><p><a href="%2$s" target="_blank">Click here to edit the original</a></p>',
63
                _t(__CLASS__ . '.VirtualDescription', 'This is a virtual copy of an element.'),
64
                $this->LinkedElement()->getEditLink()
65
            );
66
67
            if ($invalid) {
68
                $warning = _t(
69
                    __CLASS__ . '.InvalidPublishStateWarning',
70
                    'Error: The original element is not published. This element will not work on the live site until you click the link below and publish it.'
71
                );
72
73
                $fields->addFieldToTab('Root.Main', LiteralField::create('WarningHeader', '<p class="message error">' . $warning . '</p>'));
74
            }
75
76
            $autocomplete = AutoCompleteField::create(
77
                'LinkedElementID',
78
                _t(__CLASS__ . '.LinkedElement', 'Linked Element'),
79
                '',
80
                BaseElement::class,
81
                'Title'
82
            );
83
84
            $autocomplete->setLabelField('VirtualLinkedSummary');
85
            $autocomplete->setDisplayField('VirtualLinkedSummary');
86
87
            $fields->replaceField(
88
                'LinkedElementID',
89
                $autocomplete
90
            );
91
            $fields->addFieldToTab('Root.Main', LiteralField::create('Existing', $message));
92
        });
93
94
        return parent::getCMSFields();
95
    }
96
97
    /**
98
     * @return string
99
     */
100
    public function getType()
101
    {
102
        return sprintf(
103
            _t(__CLASS__ . '.BlockType', 'Virtual Block')
104
        );
105
    }
106
107
    /**
108
     * Detect when a user has published a linked element but has not published
109
     * the LinkedElement.
110
     *
111
     * @return boolean
112
     */
113
    public function isInvalidPublishState()
114
    {
115
        $element = $this->LinkedElement();
116
117
        return (!$element->isPublished() && $this->isPublished());
0 ignored issues
show
Bug introduced by
The method isPublished() does not exist on DNADesign\ElementalVirtual\Model\ElementVirtual. Since you implemented __call, consider adding a @method annotation. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

117
        return (!$element->isPublished() && $this->/** @scrutinizer ignore-call */ isPublished());
Loading history...
118
    }
119
120
    /**
121
     * Get a unique anchor name.
122
     *
123
     * @return string
124
     */
125
    public function getAnchor()
126
    {
127
        $linkedElement = $this->LinkedElement();
128
129
        if ($linkedElement && $linkedElement->exists()) {
130
            return $linkedElement->getAnchor();
131
        }
132
133
        return 'e' . $this->ID;
134
    }
135
136
    /**
137
     * @return string
138
     */
139
    public function getSummary()
140
    {
141
        if ($linked = $this->LinkedElement()) {
142
            return $linked->getSummary();
143
        }
144
    }
145
146
    /**
147
     * @return string
148
     */
149
    public function getTitle()
150
    {
151
        if ($linked = $this->LinkedElement()) {
152
            return $linked->Title;
153
        }
154
    }
155
156
    /**
157
     * Override to render template based on LinkedElement
158
     *
159
     * @return string|null HTML
160
     */
161
    public function forTemplate($holder = true)
162
    {
163
        if ($linked = $this->LinkedElement()) {
164
            return $linked->forTemplate($holder);
165
        }
166
        return null;
167
    }
168
169
    protected function provideBlockSchema()
170
    {
171
        $blockSchema = parent::provideBlockSchema();
172
        $blockSchema['content'] = $this->getSummary();
173
        return $blockSchema;
174
    }
175
}
176