FrameCollection.php

Go to the documentation of this file.

<?php
namespace Whoops\Exception;

use ArrayAccess;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use Serializable;
use UnexpectedValueException;

class FrameCollection implements ArrayAccess, IteratorAggregate, Serializable, Countable
{
    private $frames;

    public function __construct(array $frames)
    {
        $this->frames = array_map(function ($frame) {
            return new Frame($frame);
        }, $frames);
    }

    public function filter($callable)
    {
        $this->frames = array_filter($this->frames, $callable);
        return $this;
    }

    public function map($callable)
    {
        // Contain the map within a higher-order callable
        // that enforces type-correctness for the $callable
        $this->frames = array_map(function ($frame) use ($callable) {
            $frame = call_user_func($callable, $frame);

            if (!$frame instanceof Frame) {
                throw new UnexpectedValueException(
                    "Callable to " . __METHOD__ . " must return a Frame object"
                );
            }

            return $frame;
        }, $this->frames);

        return $this;
    }

    public function getArray()
    {
        return $this->frames;
    }

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

    public function offsetExists($offset)
    {
        return isset($this->frames[$offset]);
    }

    public function offsetGet($offset)
    {
        return $this->frames[$offset];
    }

    public function offsetSet($offset, $value)
    {
        throw new \Exception(__CLASS__ . ' is read only');
    }

    public function offsetUnset($offset)
    {
        throw new \Exception(__CLASS__ . ' is read only');
    }

    public function count()
    {
        return count($this->frames);
    }

    public function serialize()
    {
        return serialize($this->frames);
    }

    public function unserialize($serializedFrames)
    {
        $this->frames = unserialize($serializedFrames);
    }

    public function prependFrames(array $frames)
    {
        $this->frames = array_merge($frames, $this->frames);
    }

    public function topDiff(FrameCollection $parentFrames)
    {
        $diff = $this->frames;

        $parentFrames = $parentFrames->getArray();
        $p = count($parentFrames)-1;

        for ($i = count($diff)-1; $i >= 0 && $p >= 0; $i--) {
            $tailFrame = $diff[$i];
            if ($tailFrame->equals($parentFrames[$p])) {
                unset($diff[$i]);
            }
            $p--;
        }
        return $diff;
    }
}