dnadesign / silverstripe-elemental-virtual

src/Model/ElementVirtual.php

<?php

namespace DNADesign\ElementalVirtual\Model;

use TractorCow\AutoComplete\AutoCompleteField;
use SilverStripe\ElementalVirtual\Forms\ElementalGridFieldAddExistingAutocompleter;

The type SilverStripe\ElementalVirtual\Forms\ElementalGridFieldAddExistingAutocompleter was not found. Maybe you did not declare it correctly or list all dependencies?

use DNADesign\Elemental\Models\BaseElement;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\FieldType\DBHTMLText;

/**
 * Virtual Linked Element.
 *
 * As elemental is based on a natural has_one relation to an object,
 * this allows the same element to be linked to multiple pages.
 *
 * {@see ElementalGridFieldAddExistingAutocompleter}
 */
class ElementVirtual extends BaseElement
{
    private static $icon = 'font-icon-block-link';

The private property $icon is not used, and could be removed.

    private static $has_one = [

The private property $has_one is not used, and could be removed.

        'LinkedElement' => BaseElement::class
    ];

    /**
     * @var string
     */
    private static $description = 'Reused element';

The private property $description is not used, and could be removed.

    private static $table_name = 'ElementVirtual';

The private property $table_name is not used, and could be removed.

    private static $singular_name = 'virtual block';

The private property $singular_name is not used, and could be removed.

    
    private static $inline_editable = false;

The private property $inline_editable is not used, and could be removed.

    /**
     * @param BaseElement
     * @param boolean $isSingleton
     * @param DataModel $model

The type DNADesign\ElementalVirtual\Model\DataModel was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function __construct($record = null, $isSingleton = false, $model = null)
    {
        parent::__construct($record, $isSingleton, $model);

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?

        $this->LinkedElement()->setVirtualOwner($this);

The method LinkedElement() does not exist on DNADesign\ElementalVirtual\Model\ElementVirtual. Since you implemented __call, consider adding a @method annotation.

    }

    public function getCMSFields()
    {
        $invalid = $this->isInvalidPublishState();

        $this->beforeUpdateCMSFields(function (FieldList $fields) use ($invalid) {
            $fields->removeByName('Title');

            if ($invalid) {
                $warning = _t(
                    __CLASS__ . '.InvalidPublishStateWarning',
                    '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.'
                );

                $fields->addFieldToTab('Root.Main', LiteralField::create('WarningHeader', '<p class="message error">' . $warning . '</p>'));
            }

            $autocomplete = AutoCompleteField::create(
                'LinkedElementID',
                _t(__CLASS__ . '.LinkedElement', 'Linked Element'),
                '',
                BaseElement::class,
                'Title'
            );

            $autocomplete->setLabelField('VirtualLinkedSummary');
            $autocomplete->setDisplayField('VirtualLinkedSummary');
            $autocomplete->setSourceFilter(['AvailableGlobally' => 1]);

            $fields->replaceField(
                'LinkedElementID',
                $autocomplete
            );
            
            if($this->LinkedElementID){

The property LinkedElementID does not exist on DNADesign\ElementalVirtual\Model\ElementVirtual. Since you implemented __get, consider adding a @property annotation.

                $message = sprintf(
                    '<p>%s</p><p><a href="%2$s" target="_blank">Click here to edit the original</a></p>',
                    _t(__CLASS__ . '.VirtualDescription', 'This is a virtual copy of an element.'),
                    $this->LinkedElement()->getEditLink()
                );
                $fields->addFieldToTab('Root.Main', LiteralField::create('Existing', $message));
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return string
     */
    public function getType()
    {
        return sprintf(
            _t(__CLASS__ . '.BlockType', 'Virtual Block')
        );
    }

    /**
     * Detect when a user has published a linked element but has not published
     * the LinkedElement.
     *
     * @return boolean
     */
    public function isInvalidPublishState()
    {
        $element = $this->LinkedElement();

        return (!$element->isPublished() && $this->isPublished());

The method isPublished() does not exist on DNADesign\ElementalVirtual\Model\ElementVirtual. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * Get a unique anchor name.
     *
     * @return string
     */
    public function getAnchor()
    {
        $linkedElement = $this->LinkedElement();

        if ($linkedElement && $linkedElement->exists()) {
            return $linkedElement->getAnchor();
        }

        return 'e' . $this->ID;
    }

    /**
     * @return string
     */
    public function getSummary()
    {
        if ($linked = $this->LinkedElement()) {
            return $linked->getSummary();
        }
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        if ($linked = $this->LinkedElement()) {
            return $linked->Title;
        }
    }

    /**
     * Override to render template based on LinkedElement
     *
     * @return string|null HTML
     */
    public function forTemplate($holder = true)
    {
        if ($linked = $this->LinkedElement()) {
            return $linked->forTemplate($holder);
        }
        return null;
    }

    protected function provideBlockSchema()
    {
        $blockSchema = parent::provideBlockSchema();
        $blockSchema['content'] = $this->getSummary();
        return $blockSchema;
    }
}