Classes List

Symfony\Component\Routing\Matcher\Dumper\StaticPrefixCollection

 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 
 238 
 239 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Routing\Matcher\Dumper;

/** * Prefix tree of routes preserving routes order. * * @author Frank de Jonge <info@frankdejonge.nl> * * @internal */
class StaticPrefixCollection
{
    /** * @var string */
    private $prefix;

    /** * @var array[]|StaticPrefixCollection[] */
    private $items = array();

    /** * @var int */
    private $matchStart = 0;

    public function __construct($prefix = '')
    {
        $this->prefix = $prefix;
    }

    public function getPrefix()
    {
        return $this->prefix;
    }

    /** * @return mixed[]|StaticPrefixCollection[] */
    public function getItems()
    {
        return $this->items;
    }

    /** * Adds a route to a group. * * @param string $prefix * @param mixed $route */
    public function addRoute($prefix$route)
    {
        $prefix = '/' === $prefix ? $prefix : rtrim($prefix'/');
        $this->guardAgainstAddingNotAcceptedRoutes($prefix);

        if ($this->prefix === $prefix) {
            // When a prefix is exactly the same as the base we move up the match start position.
            // This is needed because otherwise routes that come afterwards have higher precedence
            // than a possible regular expression, which goes against the input order sorting.
            $this->items[] = array($prefix$route);
            $this->matchStart = count($this->items);

            return;
        }

        foreach ($this->items as $i => $item) {
            if ($i < $this->matchStart) {
                continue;
            }

            if ($item instanceof self && $item->accepts($prefix)) {
                $item->addRoute($prefix$route);

                return;
            }

            $group = $this->groupWithItem($item$prefix$route);

            if ($group instanceof self) {
                $this->items[$i] = $group;

                return;
            }
        }

        // No optimised case was found, in this case we simple add the route for possible
        // grouping when new routes are added.
        $this->items[] = array($prefix$route);
    }

    /** * Tries to combine a route with another route or group. * * @param StaticPrefixCollection|array $item * @param string $prefix * @param mixed $route * * @return null|StaticPrefixCollection */
    private function groupWithItem($item$prefix$route)
    {
        $itemPrefix = $item instanceof self ? $item->prefix : $item[0];
        $commonPrefix = $this->detectCommonPrefix($prefix$itemPrefix);

        if (!$commonPrefix) {
            return;
        }

        $child = new self($commonPrefix);

        if ($item instanceof self) {
            $child->items = array($item);
        } else {
            $child->addRoute($item[0], $item[1]);
        }

        $child->addRoute($prefix$route);

        return $child;
    }

    /** * Checks whether a prefix can be contained within the group. * * @param string $prefix * * @return bool Whether a prefix could belong in a given group */
    private function accepts($prefix)
    {
        return '' === $this->prefix || 0 === strpos($prefix$this->prefix);
    }

    /** * Detects whether there's a common prefix relative to the group prefix and returns it. * * @param string $prefix * @param string $anotherPrefix * * @return false|string A common prefix, longer than the base/group prefix, or false when none available */
    private function detectCommonPrefix($prefix$anotherPrefix)
    {
        $baseLength = strlen($this->prefix);
        $commonLength = $baseLength;
        $end = min(strlen($prefix), strlen($anotherPrefix));

        for ($i = $baseLength$i <= $end++$i) {
            if (substr($prefix0$i!== substr($anotherPrefix0$i)) {
                break;
            }

            $commonLength = $i;
        }

        $commonPrefix = rtrim(substr($prefix0$commonLength), '/');

        if (strlen($commonPrefix) > $baseLength) {
            return $commonPrefix;
        }

        return false;
    }

    /** * Optimizes the tree by inlining items from groups with less than 3 items. */
    public function optimizeGroups()
    {
        $index = -1;

        while (isset($this->items[++$index])) {
            $item = $this->items[$index];

            if ($item instanceof self) {
                $item->optimizeGroups();

                // When a group contains only two items there's no reason to optimize because at minimum
                // the amount of prefix check is 2. In this case inline the group.
                if ($item->shouldBeInlined()) {
                    array_splice($this->items$index1$item->items);

                    // Lower index to pass through the same index again after optimizing.
                    // The first item of the replacements might be a group needing optimization.
                    --$index;
                }
            }
        }
    }

    private function shouldBeInlined()
    {
        if (count($this->items>= 3) {
            return false;
        }

        foreach ($this->items as $item) {
            if ($item instanceof self) {
                return true;
            }
        }

        foreach ($this->items as $item) {
            if (is_array($item&& $item[0=== $this->prefix) {
                return false;
            }
        }

        return true;
    }

    /** * Guards against adding incompatible prefixes in a group. * * @param string $prefix * * @throws \LogicException when a prefix does not belong in a group */
    private function guardAgainstAddingNotAcceptedRoutes($prefix)
    {
        if (!$this->accepts($prefix)) {
            $message = sprintf('Could not add route with prefix %s to collection with prefix %s'$prefix$this->prefix);

            throw new \LogicException($message);
        }
    }
}