Whoops\Exception\FrameCollection Class Reference

Exposes a fluent interface for dealing with an ordered list of stack-trace frames. More...

Inheritance diagram for Whoops\Exception\FrameCollection:

Collaboration diagram for Whoops\Exception\FrameCollection:

Public Member Functions
	__construct (array $frames)
	filter ($callable)
	Filters frames using a callable, returns the same FrameCollection. More...
	map ($callable)
	Map the collection of frames. More...
	getArray ()
	Returns an array with all frames, does not affect the internal array. More...
	getIterator ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	count ()
	serialize ()
	unserialize ($serializedFrames)
	prependFrames (array $frames)

Private Attributes
	$frames

Detailed Description

Exposes a fluent interface for dealing with an ordered list of stack-trace frames.

Definition at line 20 of file FrameCollection.php.

Constructor & Destructor Documentation

__construct()

Whoops\Exception\FrameCollection::__construct

(

array

$frames

)

Parameters

array

$frames

Definition at line 30 of file FrameCollection.php.

References Whoops\Exception\FrameCollection\$frames.

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

Member Function Documentation

count()

Whoops\Exception\FrameCollection::count

(

)

See also

Countable::count

Returns

int

Definition at line 137 of file FrameCollection.php.

Referenced by Whoops\Exception\FrameCollection\prependFrames().

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

Here is the caller graph for this function:

filter()

Whoops\Exception\FrameCollection::filter

(

$callable

)

Filters frames using a callable, returns the same FrameCollection.

Parameters

callable

$callable

Returns

FrameCollection

Definition at line 43 of file FrameCollection.php.

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

getArray()

Whoops\Exception\FrameCollection::getArray

(

)

Returns an array with all frames, does not affect the internal array.

Todo:

If this gets any more complex than this, have getIterator use this method.

See also

FrameCollection::getIterator

Returns

array

Definition at line 83 of file FrameCollection.php.

References Whoops\Exception\FrameCollection\$frames.

Referenced by Whoops\Exception\FrameCollection\prependFrames().

    {
        return $this->frames;
    }

Here is the caller graph for this function:

getIterator()

Whoops\Exception\FrameCollection::getIterator

(

)

See also

IteratorAggregate::getIterator

Returns

ArrayIterator

Definition at line 92 of file FrameCollection.php.

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

map()

Whoops\Exception\FrameCollection::map

(

$callable

)

Map the collection of frames.

Parameters

callable

$callable

Returns

FrameCollection

Definition at line 55 of file FrameCollection.php.

References Whoops\Exception\FrameCollection\$frames.

    {
        // 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;
    }

offsetExists()

Whoops\Exception\FrameCollection::offsetExists

(

$offset

)

See also

ArrayAccess::offsetExists

Parameters

int

$offset

Definition at line 101 of file FrameCollection.php.

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

offsetGet()

Whoops\Exception\FrameCollection::offsetGet

(

$offset

)

See also

ArrayAccess::offsetGet

Parameters

int

$offset

Definition at line 110 of file FrameCollection.php.

    {
        return $this->frames[$offset];
    }

offsetSet()

Whoops\Exception\FrameCollection::offsetSet	(		$offset,
			$value
	)

See also

ArrayAccess::offsetSet

Parameters

int

$offset

Definition at line 119 of file FrameCollection.php.

    {
        throw new \Exception(__CLASS__ . ' is read only');
    }

offsetUnset()

Whoops\Exception\FrameCollection::offsetUnset

(

$offset

)

See also

ArrayAccess::offsetUnset

Parameters

int

$offset

Definition at line 128 of file FrameCollection.php.

    {
        throw new \Exception(__CLASS__ . ' is read only');
    }

prependFrames()

Whoops\Exception\FrameCollection::prependFrames

(

array

$frames

)

Parameters

Frame[]

$frames Array of Frame instances, usually from $e->getPrevious()

Definition at line 163 of file FrameCollection.php.

References Whoops\Exception\FrameCollection\$frames, Whoops\Exception\FrameCollection\count(), and Whoops\Exception\FrameCollection\getArray().

    {
        $this->frames = array_merge($frames, $this->frames);
    }

Here is the call graph for this function:

serialize()

Whoops\Exception\FrameCollection::serialize

(

)

See also

Serializable::serialize

Returns

string

Definition at line 146 of file FrameCollection.php.

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

unserialize()

Whoops\Exception\FrameCollection::unserialize

(

$serializedFrames

)

See also

Serializable::unserialize

Parameters

string

$serializedFrames

Definition at line 155 of file FrameCollection.php.

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

Field Documentation

$frames

Whoops\Exception\FrameCollection::$frames

private

Definition at line 25 of file FrameCollection.php.

Referenced by Whoops\Exception\FrameCollection\__construct(), Whoops\Exception\FrameCollection\getArray(), Whoops\Exception\FrameCollection\map(), and Whoops\Exception\FrameCollection\prependFrames().

---

The documentation for this class was generated from the following file:

• Services/Exceptions/lib/Whoops/Exception/FrameCollection.php