Classes List

Symfony\Component\BrowserKit\History

 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 
<?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\BrowserKit;

/** * History. * * @author Fabien Potencier <fabien@symfony.com> */
class History
{
    protected $stack = array();
    protected $position = -1;

    /** * Clears the history. */
    public function clear()
    {
        $this->stack = array();
        $this->position = -1;
    }

    /** * Adds a Request to the history. */
    public function add(Request $request)
    {
        $this->stack = array_slice($this->stack0$this->position + 1);
        $this->stack[] = clone $request;
        $this->position = count($this->stack) - 1;
    }

    /** * Returns true if the history is empty. * * @return bool true if the history is empty, false otherwise */
    public function isEmpty()
    {
        return 0 == count($this->stack);
    }

    /** * Goes back in the history. * * @return Request A Request instance * * @throws \LogicException if the stack is already on the first page */
    public function back()
    {
        if ($this->position < 1) {
            throw new \LogicException('You are already on the first page.');
        }

        return clone $this->stack[--$this->position];
    }

    /** * Goes forward in the history. * * @return Request A Request instance * * @throws \LogicException if the stack is already on the last page */
    public function forward()
    {
        if ($this->position > count($this->stack) - 2) {
            throw new \LogicException('You are already on the last page.');
        }

        return clone $this->stack[++$this->position];
    }

    /** * Returns the current element in the history. * * @return Request A Request instance * * @throws \LogicException if the stack is empty */
    public function current()
    {
        if (-1 == $this->position) {
            throw new \LogicException('The page history is empty.');
        }

        return clone $this->stack[$this->position];
    }
}