tarlepp/symfony-flex-backend

<?php
declare(strict_types = 1);
/**
 * /src/Rest/SearchTerm.php
 *
 * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
 */

namespace App\Rest;

use App\Rest\Interfaces\SearchTermInterface;
use Closure;
use Override;
use function array_filter;
use function array_map;
use function array_merge;
use function array_unique;
use function array_values;
use function explode;
use function is_array;
use function is_string;
use function preg_match_all;
use function preg_replace;
use function str_contains;
use function str_replace;
use function trim;

/**
 * @package App\Rest
 * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
 */
final class SearchTerm implements SearchTermInterface
{
    #[Override]
    public static function getCriteria(
        array | string | null $column,
        array | string | null $search,
        ?string $operand = null,
        ?int $mode = null,
    ): ?array {
        $operand ??= self::OPERAND_OR;
        $mode ??= self::MODE_FULL;

        $columns = self::getColumns($column);
        $searchTerms = self::getSearchTerms($search);

        // Fallback to OR operand if not supported one given
        if ($operand !== self::OPERAND_AND && $operand !== self::OPERAND_OR) {
            $operand = self::OPERAND_OR;
        }

        return self::createCriteria($columns, $searchTerms, $operand, $mode);
    }

    /**
     * Helper method to create used criteria array with given columns and search terms.
     *
     * @param array<int, string> $columns
     * @param array<int, string> $searchTerms
     *
     * @return array<string, array<string, array<string, mixed>>>|null
     */
    private static function createCriteria(array $columns, array $searchTerms, string $operand, int $mode): ?array
    {
        $iteratorTerm = self::getTermIterator($columns, $mode);

        /**
         * Get criteria
         *
         * @var array<string, array<string, array<int, string>>> $criteria
         */
        $criteria = array_filter(array_map($iteratorTerm, $searchTerms));

        // Initialize output
        $output = null;

        // We have some generated criteria
        if ($criteria !== []) {
            // Create used criteria array
            $output = [
                'and' => [
                    $operand => array_merge(...array_values($criteria)),
                ],
            ];
        }

        return $output;
    }

    /**
     * Method to get term iterator closure.
     *
     * @param array<int, string> $columns
     */
    private static function getTermIterator(array $columns, int $mode): Closure
    {
        return static fn (string $term): ?array => $columns === []
            ? null
            : array_map(self::getColumnIterator($term, $mode), $columns);
    }

    /**
     * Method to get column iterator closure.
     */
    private static function getColumnIterator(string $term, int $mode): Closure
    {
        /*
         * Lambda function to create actual criteria for specified column + term + mode combo.
         *
         * @param string $column
         *
         * @return array<int, string>
         */
        return static fn (string $column): array => [
            str_contains($column, '.') ? $column : 'entity.' . $column, 'like', self::getTerm($mode, $term),
        ];
    }

    /**
     * Method to get search term clause for 'LIKE' query for specified mode.
     */
    private static function getTerm(int $mode, string $term): string
    {
        return match ($mode) {
            self::MODE_STARTS_WITH => $term . '%',
            self::MODE_ENDS_WITH => '%' . $term,
            default => '%' . $term . '%', // self::MODE_FULL
        };
    }

    /**
     * @param string|array<int, string|null>|null $column search column(s), could be a string or an array of strings
     *
     * @return array<int, string>
     */
    private static function getColumns(array | string | null $column): array
    {
        // Normalize columns
        return $column === null
            ? []
            : array_filter(
                array_map(
                    'trim',
                    (is_array($column)
                        ? array_filter($column, static fn (string | null $column): bool => is_string($column))
                        : (array)$column),
                ),
                static fn (string $value): bool => trim($value) !== '',
            );
    }

    /**
     * Method to get search terms.
     *
     * @param string|array<int, string|null>|null $search search term(s), could be a string or an array of strings
     *
     * @return array<int, string>
     */
    private static function getSearchTerms(array | string | null $search): array
    {
        if (is_string($search)) {
            preg_match_all('#([^\"]\S*|\".+?\")\s*#', trim($search), $matches);

            if ($matches[1]) {
                $search = array_map(
                    static fn (string $term): string => trim(str_replace('"', '', $term)),
                    $matches[1],
                );
            }
        }

        return $search === null
            ? []
            : array_unique(
                array_filter(
                    array_map(
                        static fn (string $term): string => (string)preg_replace('#\s+#', ' ', $term),
                        array_map(
                            'trim',
                            (is_array($search)
                                ? array_filter($search, static fn (string | null $term): bool => is_string($term))
                                : explode(' ', $search)),
                        ),
                    ),
                    static fn (string $value): bool => trim($value) !== ''
                )
            );
    }
}