File QueryString.php | ICanBoogie/Facets master

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Facets;

use ICanBoogie\Accessor\AccessorTrait;
use ICanBoogie\Facets\CriterionValue\SetCriterionValue;

/**
 * Representation of a query string.
 *
 * @property-read QueryStringWord[] $matched Query string words for which a match was found.
 * @property-read QueryStringWord[] $not_matched Query string words for which no match was found.
 * @property-read array $matches Unique matches.
 * @property-read array $conditions An array of conditions suitable for {@link Criterion::alter_query_with_conditions}.
 * @property-read string $remains What remains of the query string after removing matched words.
 */
class QueryString implements \IteratorAggregate
{
    use AccessorTrait;

    static private function parse_phrase($phrase)
    {
        $words = explode(' ', $phrase);
        $words = array_map('trim', $words);
        $words = array_filter($words);
        $words = array_unique($words);

        return $words;
    }

    protected $query_string;
    protected $words;

    public function __construct($query_string)
    {
        $this->query_string = (string) $query_string;

        $words = self::parse_phrase($query_string);

        foreach ($words as &$word)
        {
            $word = new QueryStringWord($word, $this);
        }

        $this->words = $words;
    }

    public function __toString()
    {
        return $this->query_string;
    }

    public function getIterator()
    {
        return new \ArrayIterator($this->words);
    }

    /**
     * Search the phrase in the query string.
     *
     * @param string $phrase
     *
     * @return QueryStringWord[]|null
     */
    public function search($phrase)
    {
        $words = self::parse_phrase($phrase);
        $normalized_words = array_map('ICanBoogie\normalize', $words);

        $i = 0;
        $count = count($normalized_words);
        $matches = [];

        foreach ($this->words as $word)
        {
            $normalized_word = $normalized_words[$i];

            if ($word->normalized != $normalized_word)
            {
                if ($matches) return null;

                continue;
            }

            $matches[] = $word;
            $i++;

            if ($i == $count) break;
        }

        if ($i != $count)
        {
            return null;
        }

        return $matches;
    }

    /**
     * Returns the word before the specified query string word, if any.
     *
     * @param QueryStringWord $word
     *
     * @return QueryStringWord|null
     */
    public function before(QueryStringWord $word)
    {
        $i = array_search($word, $this->words);

        if ($i == 0)
        {
            return null;
        }

        return $this->words[$i - 1];
    }

    /**
     * Returns the word after the specified query string word, if any.
     *
     * @param QueryStringWord $word
     *
     * @return QueryStringWord|null
     */
    public function after(QueryStringWord $word)
    {
        $i = array_search($word, $this->words);

        if ($i + 1 == count($this->words))
        {
            return null;
        }

        return $this->words[$i + 1];
    }

    /**
     * Returns the query string words that have a match.
     *
     * @return QueryStringWord[]
     */
    protected function get_matched()
    {
        $rc = [];

        foreach ($this->words as $word)
        {
            if (!$word->match)
            {
                continue;
            }

            $rc[] = $word;
        }

        return $rc;
    }

    /**
     * Returns the query string words that do not have a match.
     *
     * @return QueryStringWord[]
     */
    protected function get_not_matched()
    {
        $rc = [];

        foreach ($this->words as $word)
        {
            if ($word->match)
            {
                continue;
            }

            $rc[] = $word;
        }

        return $rc;
    }

    /**
     * Returns criterion values per criterion identifier.
     *
     * @return array
     */
    protected function get_matches()
    {
        $matches = [];

        foreach ($this->matched as $word)
        {
            foreach ($word->match as $criterion_id => $match)
            {
                $matches[$criterion_id][] = $match;
            }
        }

        return array_map('array_unique', $matches);
    }

    /**
     * Returns an array of facet conditions.
     *
     * @return array
     */
    protected function get_conditions()
    {
        return array_map(function($v) {

            if (count($v) === 1)
            {
                return reset($v);
            }

            return new SetCriterionValue($v);

        }, $this->matches);
    }

    /**
     * Returns what remains of the query string after removing matched words.
     */
    protected function get_remains()
    {
        return implode(' ', $this->not_matched);
    }
}

Namespaces

Classes

Interfaces

Traits