9.5/_driver_filtered_search_result_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Core\Resource\Search\Result;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Core\Resource\Driver\DriverInterface;

use ‪TYPO3\CMS\Core\Resource\File;

use ‪TYPO3\CMS\Core\Utility\PathUtility;


class ‪DriverFilteredSearchResult implements ‪FileSearchResultInterface

{

    private ‪$searchResult;


    private ‪$driver;


    private ‪$filters;


    private ‪$result;


    public function ‪__construct(‪FileSearchResultInterface ‪$searchResult, ‪DriverInterface ‪$driver, array ‪$filters)

    {

        $this->searchResult = ‪$searchResult;

        $this->driver = ‪$driver;

        $this->filters = ‪$filters;

    }


    public function ‪count(): int

    {

        $this->‪initialize();


        return ‪count($this->result);

    }


    public function ‪current(): ‪File

    {

        $this->‪initialize();


        return ‪current($this->result);

    }


    public function ‪key(): int

    {

        $this->‪initialize();


        return ‪key($this->result);

    }


    public function ‪next(): void

    {

        $this->‪initialize();

        ‪next($this->result);

    }


    public function ‪rewind(): void

    {

        $this->‪initialize();

        reset($this->result);

    }


    public function ‪valid(): bool

    {

        $this->‪initialize();


        return ‪current($this->result) !== false;

    }


    private function ‪initialize(): void

    {

        if ($this->result === null) {

            $this->result = $this->‪applyFilters(...iterator_to_array($this->searchResult));

        }

    }


    private function ‪applyFilters(‪File ...$files): array

    {

        $filteredFiles = [];

        foreach ($files as $file) {

            $itemIdentifier = $file->getIdentifier();

            $itemName = ‪PathUtility::basename($itemIdentifier);

            $parentIdentifier = ‪PathUtility::dirname($itemIdentifier);

            $matches = true;

            foreach ($this->filters as $filter) {

                if (!is_callable($filter)) {

                    continue;

                }

                ‪$result = $filter($itemName, $itemIdentifier, $parentIdentifier, [], $this->driver);

                // We have to use -1 as the „don't include“ return value, as call_user_func() will return FALSE

                // If calling the method succeeded and thus we can't use that as a return value.

                if (‪$result === -1) {

                    $matches = false;

                }

                if (‪$result === false) {

                    throw new \RuntimeException(

                        'Could not apply file/folder name filter ' . $filter[0] . '::' . $filter[1],

                        1543617278

                    );

                }

            }

            if ($matches) {

                $filteredFiles[] = $file;

            }

        }


        return $filteredFiles;

    }

}