Inheritance diagram for Whoops\Exception\Frame:

Collaboration diagram for Whoops\Exception\Frame:

Public Member Functions
	__construct (array $frame)

	getFile ($shortened=false)

	getLine ()

	getClass ()

	getFunction ()

	getArgs ()

	getFileContents ()
	Returns the full contents of the file for this frame, if it's known. More...

	addComment ($comment, $context='global')
	Adds a comment to this frame, that can be received and used by other handlers. More...

	getComments ($filter=null)
	Returns all comments for this frame. More...

	getRawFrame ()
	Returns the array containing the raw frame data from which this Frame object was built. More...

	getFileLines ($start=0, $length=null)

	serialize ()
	Implements the Serializable interface, with special steps to also save the existing comments. More...

	unserialize ($serializedFrame)
	Unserializes the frame data, while also preserving any existing comment data. More...

	equals (Frame $frame)
	Compares Frame against one another. More...

	isApplication ()
	Returns whether this frame belongs to the application or not. More...

	setApplication ($application)
	Mark as an frame belonging to the application. More...

Protected Attributes
	$frame

	$fileContentsCache

	$comments = []

	$application

Detailed Description

Definition at line 12 of file Frame.php.

Constructor & Destructor Documentation

◆ __construct()

Whoops\Exception\Frame::__construct ( array $frame )

Parameters

array[]

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 37 of file Frame.php.

References Whoops\Exception\Frame\$frame.

     {
         $this->frame = $frame;
     }

Member Function Documentation

◆ addComment()

Whoops\Exception\Frame::addComment	(	$comment,
		$context = `'global'`
	)

Adds a comment to this frame, that can be received and used by other handlers.

For example, the PrettyPage handler can attach these comments under the code for each frame.

An interesting use for this would be, for example, code analysis & annotations.

Parameters

string	$comment
string	$context	Optional string identifying the origin of the comment

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 144 of file Frame.php.

References $comment, and comments.

     {
         $this->comments[] = [
             'comment' => $comment,
             'context' => $context,
         ];
     }

◆ equals()

Whoops\Exception\Frame::equals ( Frame $frame )

Compares Frame against one another.

Parameters

Frame $frame

Returns: bool

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 269 of file Frame.php.

References Whoops\Exception\Frame\getFile(), and Whoops\Exception\Frame\getLine().

     {
         if (!$this->getFile() || $this->getFile() === 'Unknown' || !$this->getLine()) {
             return false;
         }
         return $frame->getFile() === $this->getFile() && $frame->getLine() === $this->getLine();
     }

Here is the call graph for this function:

◆ getArgs()

Whoops\Exception\Frame::getArgs ( )

Returns: array

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 102 of file Frame.php.

References array.

Referenced by Whoops\Util\TemplateHelper\dumpArgs(), and Whoops\Handler\PlainTextHandler\getFrameArgsOutput().

     {
         return isset($this->frame['args']) ? (array) $this->frame['args'] : [];
     }

Here is the caller graph for this function:

◆ getClass()

Whoops\Exception\Frame::getClass ( )

Returns: string|null

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 86 of file Frame.php.

     {
         return isset($this->frame['class']) ? $this->frame['class'] : null;
     }

◆ getComments()

Whoops\Exception\Frame::getComments ( $filter = null )

Returns all comments for this frame.

Optionally allows a filter to only retrieve comments from a specific context.

Parameters

string $filter

Returns: array[]

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 160 of file Frame.php.

References Whoops\Exception\Frame\$comments.

     {
         $comments = $this->comments;
 
         if ($filter !== null) {
             $comments = array_filter($comments, function ($c) use ($filter) {
                 return $c['context'] == $filter;
             });
         }
 
         return $comments;
     }

◆ getFile()

Whoops\Exception\Frame::getFile ( $shortened = false )

Parameters

bool $shortened

Returns: string|null

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 46 of file Frame.php.

References $file.

Referenced by Whoops\Exception\Frame\equals(), and Whoops\Exception\Frame\getFileContents().

     {
         if (empty($this->frame['file'])) {
             return null;
         }
 
         $file = $this->frame['file'];
 
         // Check if this frame occurred within an eval().
         // @todo: This can be made more reliable by checking if we've entered
         // eval() in a previous trace, but will need some more work on the upper
         // trace collector(s).
         if (preg_match('/^(.*)\((\d+)\) : (?:eval\(\)\'d|assert) code$/', $file, $matches)) {
             $file = $this->frame['file'] = $matches[1];
             $this->frame['line'] = (int) $matches[2];
         }
 
         if ($shortened && is_string($file)) {
             // Replace the part of the path that all frames have in common, and add 'soft hyphens' for smoother line-breaks.
             $dirname = dirname(dirname(dirname(dirname(dirname(dirname(__DIR__))))));
             if ($dirname !== '/') {
                 $file = str_replace($dirname, "&hellip;", $file);
             }
             $file = str_replace("/", "/&shy;", $file);
         }
 
         return $file;
     }

Here is the caller graph for this function:

◆ getFileContents()

Whoops\Exception\Frame::getFileContents ( )

Returns the full contents of the file for this frame, if it's known.

Returns: string|null

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 112 of file Frame.php.

References Whoops\Exception\Frame\$fileContentsCache, and Whoops\Exception\Frame\getFile().

Referenced by Whoops\Exception\Frame\getFileLines().

     {
         if ($this->fileContentsCache === null && $filePath = $this->getFile()) {
             // Leave the stage early when 'Unknown' is passed
             // this would otherwise raise an exception when
             // open_basedir is enabled.
             if ($filePath === "Unknown") {
                 return null;
             }
 
             // Return null if the file doesn't actually exist.
             if (!is_file($filePath)) {
                 return null;
             }
 
             $this->fileContentsCache = file_get_contents($filePath);
         }
 
         return $this->fileContentsCache;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileLines()

Whoops\Exception\Frame::getFileLines	(	$start = `0`,
		$length = `null`
	)

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 202 of file Frame.php.

References $contents, and Whoops\Exception\Frame\getFileContents().

     {
         if (null !== ($contents = $this->getFileContents())) {
             $lines = explode("\n", $contents);
 
             // Get a subset of lines from $start to $end
             if ($length !== null) {
                 $start  = (int) $start;
                 $length = (int) $length;
                 if ($start < 0) {
                     $start = 0;
                 }
 
                 if ($length <= 0) {
                     throw new InvalidArgumentException(
                         "\$length($length) cannot be lower or equal to 0"
                     );
                 }
 
                 $lines = array_slice($lines, $start, $length, true);
             }
 
             return $lines;
         }
     }

Here is the call graph for this function:

◆ getFunction()

Whoops\Exception\Frame::getFunction ( )

Returns: string|null

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 94 of file Frame.php.

     {
         return isset($this->frame['function']) ? $this->frame['function'] : null;
     }

◆ getLine()

Whoops\Exception\Frame::getLine ( )

Returns: int|null

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 78 of file Frame.php.

Referenced by Whoops\Exception\Frame\equals().

     {
         return isset($this->frame['line']) ? $this->frame['line'] : null;
     }

Here is the caller graph for this function:

◆ getRawFrame()

Whoops\Exception\Frame::getRawFrame ( )

Returns the array containing the raw frame data from which this Frame object was built.

Returns: array

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 179 of file Frame.php.

References Whoops\Exception\Frame\$frame.

     {
         return $this->frame;
     }

◆ isApplication()

Whoops\Exception\Frame::isApplication ( )

Returns whether this frame belongs to the application or not.

Returns: boolean

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 282 of file Frame.php.

References Whoops\Exception\Frame\$application.

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

     {
         return $this->application;
     }

Here is the caller graph for this function:

◆ serialize()

Whoops\Exception\Frame::serialize ( )

Implements the Serializable interface, with special steps to also save the existing comments.

See also: Serializable::serialize

Returns: string

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 235 of file Frame.php.

References Whoops\Exception\Frame\$comments, Whoops\Exception\Frame\$frame, and comments.

     {
         $frame = $this->frame;
         if (!empty($this->comments)) {
             $frame['_comments'] = $this->comments;
         }
 
         return serialize($frame);
     }

◆ setApplication()

Whoops\Exception\Frame::setApplication ( $application )

Mark as an frame belonging to the application.

Parameters

boolean $application

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 292 of file Frame.php.

References Whoops\Exception\Frame\$application.

     {
         $this->application = $application;
     }

◆ unserialize()

Whoops\Exception\Frame::unserialize ( $serializedFrame )

Unserializes the frame data, while also preserving any existing comment data.

See also: Serializable::unserialize

Parameters

string $serializedFrame

Examples:: /usr/local/src/ilias/release_5-3/libs/composer/vendor/filp/whoops/src/Whoops/Exception/Frame.php.

Definition at line 252 of file Frame.php.

References Whoops\Exception\Frame\$frame, and comments.

     {
         $frame = unserialize($serializedFrame);
 
         if (!empty($frame['_comments'])) {
             $this->comments = $frame['_comments'];
             unset($frame['_comments']);
         }
 
         $this->frame = $frame;
     }