silverstripe / silverstripe-elemental

src/Extensions/ElementalPageExtension.php

<?php

namespace DNADesign\Elemental\Extensions;

use DNADesign\Elemental\Models\BaseElement;
use DNADesign\Elemental\Models\ElementalArea;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\View\Parsers\HTML4Value;
use SilverStripe\View\SSViewer;

/**
 * @method ElementalArea ElementalArea()
 * @property int ElementalAreaID
 */
class ElementalPageExtension extends ElementalAreasExtension
{
    private static $has_one = [

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

        'ElementalArea' => ElementalArea::class,
    ];

    private static $owns = [

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

        'ElementalArea',
    ];

    private static $cascade_duplicates = [

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

        'ElementalArea',
    ];

    /**
     * The delimiter to separate distinct elements in indexed content.
     *
     * When using the getElementsForSearch() method to index all elements in a single field,
     * a custom delimiter can be used help to avoid false positive results for phrase queries.
     *
     * @config
     * @var string
     */
    private static $search_index_element_delimiter = ' ';

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

    /**
     * Returns the contents of each ElementalArea has_one's markup for use in Solr or Elastic search indexing
     *
     * @return string
     */
    public function getElementsForSearch()
    {
        $oldThemes = SSViewer::get_themes();
        SSViewer::set_themes(SSViewer::config()->get('themes'));
        try {
            $output = [];
            $this->loopThroughElements(function (BaseElement $element) use (&$output) {
                if ($element->getSearchIndexable()) {
                    $content = $element->getContentForSearchIndex();
                    if ($content) {
                        $output[] = $content;
                    }
                }
            });
        } finally {
            // Reset theme if an exception occurs, if you don't have a
            // try / finally around code that might throw an Exception,
            // CMS layout can break on the response. (SilverStripe 4.1.1)
            SSViewer::set_themes($oldThemes);
        }
        return implode($this->owner->config()->get('search_index_element_delimiter') ?? '', $output);
    }

    /**
     * @see SiteTree::getAnchorsOnPage()
     */
    public function updateAnchorsOnPage(array &$anchors): void
    {
        if (!($this->owner instanceof SiteTree)) {
            return;
        }
        $this->loopThroughElements(function (BaseElement $element) use (&$anchors) {
            $anchors = array_merge($anchors, $element->getAnchorsInContent());
        });
    }

    public function MetaTags(&$tags)
    {
        if (!Controller::has_curr()) {
            return;
        }
        $controller = Controller::curr();
        $request = $controller->getRequest();
        if ($request->getVar('ElementalPreview') !== null) {
            $html = HTML4Value::create($tags);
            $xpath = "//meta[@name='x-page-id' or @name='x-cms-edit-link']";
            $removeTags = $html->query($xpath);
            $body = $html->getBody();
            foreach ($removeTags as $tag) {
                $body->removeChild($tag);
            }
            $tags = $html->getContent();
        }
    }

    /**
     * Call some function over all elements belonging to this page
     */
    private function loopThroughElements(callable $callback): void
    {
        foreach ($this->owner->hasOne() as $key => $class) {
            if ($class !== ElementalArea::class) {
                continue;
            }
            /** @var ElementalArea $area */
            $area = $this->owner->$key();
            if ($area) {
                foreach ($area->Elements() as $element) {
                    $callback($element);
                }
            }
        }
    }
}