ElementSiteTreeFilterSearch.php

<?php

namespace DNADesign\Elemental\Controllers;

use DNADesign\Elemental\Extensions\ElementalPageExtension;
use SilverStripe\CMS\Controllers\CMSSiteTreeFilter_Search;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Convert;
use SilverStripe\Forms\DateField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;

class ElementSiteTreeFilterSearch extends CMSSiteTreeFilter_Search
{
    use Configurable;

    /**
     * @var boolean
     */
    private static $search_for_term_in_content = true;

    /**
     * Whether to render elements with templates when doing a CMS SiteTree search
     */
    private static bool $render_elements = true;

    /**
     * @var array
     */
    private $extraTermFilters = [];

    /**
     * We can't use ORM filtering for PHP methods, so we'll perform our own PHP "search" and get a list of
     * matching SiteTree record IDs, then add that to the original ORM query.
     *
     * @param DataList $query Unfiltered query
     * @return DataList
     */
    protected function applyDefaultFilters($query)
    {
        // If not filtering by a Term then skip this altogether
        if (empty($this->params['Term']) || $this->config()->get('search_for_term_in_content') === false) {
            return parent::applyDefaultFilters($query);
        }

        // Get an array of SiteTree record IDs that match the search term in nested element data
        $siteTrees = $query->filterByCallback(function (SiteTree $siteTree) {
            // Filter by elemental PHP
            if (!$siteTree->hasExtension(ElementalPageExtension::class)) {
                return false;
            }

            if ($this->config()->get('render_elements') === true) {
                // Check whether the search term exists in the nested page content
                $pageContent = $siteTree->getElementsForSearch();
            } else {
                $pageContent = $siteTree->getContentFromElementsForCmsSearch();
            }

            return stripos($pageContent ?? '', $this->params['Term'] ?? '') !== false;
        });

        if ($siteTrees->count()) {
            // Apply the list of IDs as an extra filter
            $this->extraTermFilters['ID:ExactMatch'] = $siteTrees->column('ID');
        }

        return $this->applyWithExtraTermFilters($query);
    }

    /**
     * Method is a copy of {@link CMSSiteTreeFilter::applyDefaultFilters} with one line added to the Term
     * filter array to merge in a custom array of "extra term filters", since we cannot modify the list
     * after the filters have been applied by the parent class.
     *
     * PLEASE NOTE: This method is likely to be removed in a future minor version of the module. Do not rely
     * on it.
     *
     * @internal
     *
     * @param DataList $query
     * @return DataList
     */
    private function applyWithExtraTermFilters($query)
    {
        $sng = SiteTree::singleton();
        foreach ($this->params as $name => $val) {
            if (empty($val)) {
                continue;
            }

            switch ($name) {
                case 'Term':
                    $query = $query->filterAny([
                        'URLSegment:PartialMatch' => Convert::raw2url($val),
                        'Title:PartialMatch' => $val,
                        'MenuTitle:PartialMatch' => $val,
                        'Content:PartialMatch' => $val
                        ] + $this->extraTermFilters); // NB: only modified line
                    break;

                case 'URLSegment':
                    $query = $query->filter([
                        'URLSegment:PartialMatch' => Convert::raw2url($val),
                    ]);
                    break;

                case 'LastEditedFrom':
                    $fromDate = DateField::create(null, null, $val);
                    $query = $query->filter("LastEdited:GreaterThanOrEqual", $fromDate->dataValue().' 00:00:00');
                    break;

                case 'LastEditedTo':
                    $toDate = DateField::create(null, null, $val);
                    $query = $query->filter("LastEdited:LessThanOrEqual", $toDate->dataValue().' 23:59:59');
                    break;

                case 'ClassName':
                    if ($val != 'All') {
                        $query = $query->filter('ClassName', $val);
                    }
                    break;

                default:
                    $field = $sng->dbObject($name);
                    if ($field) {
                        $filter = $field->defaultSearchFilter();
                        $filter->setValue($val);
                        $query = $query->alterDataQuery([$filter, 'apply']);
                    }
            }
        }
        return $query;
    }
}