BackTrace.php

Go to the documentation of this file.

<?php
class BackTrace
{
    const SCOPE_FILE = "file";

    const SCOPE_FUNCTION = "function";

    const SCOPE_METHOD = "->";

    const SCOPE_STATIC = "::";

    private $aCurrent = array();

    private $aStack = array();

    private $iLevel = 0;

    public function __construct( array $aStack = array() )
    {
        $this->aStack = count( $aStack ) === 0 ? debug_backtrace() : $aStack;
        $this->levelTop();
    }

    public function explain()
    {
        return BackTraceExplain::perform( $this );
    }

    public function getAll()
    {
        return $this->aStack;
    }

    public function getArguments()
    {
        if ( array_key_exists( "args", $this->aCurrent ) === false )
        {
            return array();
        }
        return (array) $this->aCurrent["args"];
    }

    public function getClass()
    {
        if ( array_key_exists( "class", $this->aCurrent ) === false )
        {
            return "";
        }
        return (string) $this->aCurrent["class"];
    }

    public function getCurrent()
    {
        return $this->aCurrent;
    }

    public function getFile( $bOnlyName = false )
    {
        if ( array_key_exists( "file", $this->aCurrent ) === false )
        {
            return "";
        }
        if ( $bOnlyName === true )
        {
            return basename( (string) $this->aCurrent["file"] );
        }
        return (string) $this->aCurrent["file"];
    }

    public function getFunction()
    {
        if ( array_key_exists( "function", $this->aCurrent ) === false )
        {
            return "";
        }
        return (string) $this->aCurrent["function"];
    }

    public function getLevel()
    {
        return $this->iLevel;
    }

    public function getLine()
    {
        if ( array_key_exists( "line", $this->aCurrent ) === false )
        {
            return 0;
        }
        return (integer) $this->aCurrent["line"];
    }

    public function getScope()
    {
        $sType = $this->getType();
        if ( $sType === "" )
        {
            $sType = $this->getFunction() === "" ? self::SCOPE_FILE : self::SCOPE_FUNCTION;
        }
        return $sType;
    }

    public function getType()
    {
        if ( array_key_exists( "type", $this->aCurrent ) === false )
        {
            return "";
        }
        return (string) $this->aCurrent["type"];
    }

    public function levelBottom()
    {
        $this->setLevel( count( $this->aStack ) - 1 );
    }

    public function levelDown( $iDepth = 1, $bTry = false )
    {
        $iDepth = (integer) $iDepth;
        $bReturn = $this->setLevel( $this->iLevel + $iDepth );
        if ( $bReturn === false && $bTry === true )
        {
            $iDepth > 0 ? $this->levelTop() : $this->levelBottom();
        }
        return $bReturn;
    }

    public function levelTop()
    {
        $this->setLevel( 0 );
    }

    public function levelUp( $iDepth = 1, $bTry = false )
    {
        $iDepth = (integer) $iDepth;
        $bReturn = $this->setLevel( $this->iLevel - $iDepth );
        if ( $bReturn === false && $bTry === true )
        {
            $iDepth > 0 ? $this->levelBottom() : $this->levelTop();
        }
        return $bReturn;
    }

    public function setLevel( $iLevel )
    {
        $iLevel = (integer) $iLevel;
        if ( array_key_exists( $iLevel, $this->aStack ) === true )
        {
            $this->iLevel = $iLevel;
        }
        $this->aCurrent = &$this->aStack[$this->iLevel];
        return $this->iLevel === $iLevel;
    }
}