Whoops\Handler\PlainTextHandler Class Reference

Handler outputing plaintext error messages. More...

Inheritance diagram for Whoops\Handler\PlainTextHandler:

Collaboration diagram for Whoops\Handler\PlainTextHandler:

Public Member Functions
	__construct ($logger=null)
	Constructor. More...
	setLogger ($logger=null)
	Set the output logger interface. More...
	getLogger ()
	addTraceToOutput ($addTraceToOutput=null)
	Add error trace to output. More...
	addTraceFunctionArgsToOutput ($addTraceFunctionArgsToOutput=null)
	Add error trace function arguments to output. More...
	setTraceFunctionArgsOutputLimit ($traceFunctionArgsOutputLimit)
	getTraceFunctionArgsOutputLimit ()
	Get the size limit in bytes of frame arguments var_dump output. More...
	onlyForCommandLine ($onlyForCommandLine=null)
	Restrict error handling to command line calls. More...
	outputOnlyIfCommandLine ($outputOnlyIfCommandLine=null)
	Output the error message only if using command line. More...
	loggerOnly ($loggerOnly=null)
	Only output to logger. More...
	handle ()
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (Run $run)
	setInspector (Inspector $inspector)
	setException (Exception $exception)

Data Fields
const	VAR_DUMP_PREFIX = ' | '
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10
	Return constants that can be returned from Handler::handle to message the handler walker. More...
const	LAST_HANDLER = 0x20
const	QUIT = 0x30

Protected Attributes
	$logger

Private Member Functions
	isCommandLine ()
	Check, if possible, that this execution was triggered by a command line. More...
	canProcess ()
	Test if handler can process the exception. More...
	canOutput ()
	Test if handler can output to stdout. More...
	getFrameArgsOutput (Frame $frame, $line)
	Get the frame args var_dump. More...

Private Attributes
	$addTraceToOutput = true
	$addTraceFunctionArgsToOutput = false
	$traceFunctionArgsOutputLimit = 1024
	$onlyForCommandLine = false
	$outputOnlyIfCommandLine = true
	$loggerOnly = false

Additional Inherited Members
Protected Member Functions inherited from Whoops\Handler\Handler
	getRun ()
	getInspector ()
	getException ()

Detailed Description

Handler outputing plaintext error messages.

Can be used directly, or will be instantiated automagically by Whoops if passed to Run::pushHandler

Definition at line 20 of file PlainTextHandler.php.

Constructor & Destructor Documentation

__construct()

Whoops\Handler\PlainTextHandler::__construct

(

$logger = null

)

Constructor.

Exceptions

InvalidArgumentException

If argument is not null or a LoggerInterface

Parameters

\Psr\Log\LoggerInterface | null

$logger

Definition at line 64 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$logger, and Whoops\Handler\PlainTextHandler\setLogger().

    {
        $this->setLogger($logger);
    }

Here is the call graph for this function:

Member Function Documentation

addTraceFunctionArgsToOutput()

Whoops\Handler\PlainTextHandler::addTraceFunctionArgsToOutput

(

$addTraceFunctionArgsToOutput = null

)

Add error trace function arguments to output.

Set to True for all frame args, or integer for the n first frame args.

Parameters

bool | integer | null

$addTraceFunctionArgsToOutput

Returns

null|bool|integer

Definition at line 117 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$addTraceFunctionArgsToOutput.

Referenced by Whoops\Handler\PlainTextHandler\getFrameArgsOutput().

    {
        if (func_num_args() == 0) {
            return $this->addTraceFunctionArgsToOutput;
        }

        if (! is_integer($addTraceFunctionArgsToOutput)) {
            $this->addTraceFunctionArgsToOutput = (bool) $addTraceFunctionArgsToOutput;
        } else {
            $this->addTraceFunctionArgsToOutput = $addTraceFunctionArgsToOutput;
        }
    }

Here is the caller graph for this function:

addTraceToOutput()

Whoops\Handler\PlainTextHandler::addTraceToOutput

(

$addTraceToOutput = null

)

Add error trace to output.

Parameters

bool | null

$addTraceToOutput

Returns

bool|$this

Definition at line 101 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$addTraceToOutput.

Referenced by Whoops\Handler\PlainTextHandler\getFrameArgsOutput().

    {
        if (func_num_args() == 0) {
            return $this->addTraceToOutput;
        }

        $this->addTraceToOutput = (bool) $addTraceToOutput;
        return $this;
    }

Here is the caller graph for this function:

canOutput()

Whoops\Handler\PlainTextHandler::canOutput ( )

private

Test if handler can output to stdout.

Returns

bool

Definition at line 216 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\isCommandLine(), Whoops\Handler\PlainTextHandler\loggerOnly(), and Whoops\Handler\PlainTextHandler\outputOnlyIfCommandLine().

Referenced by Whoops\Handler\PlainTextHandler\handle().

    {
        return ($this->isCommandLine() || ! $this->outputOnlyIfCommandLine())
            && ! $this->loggerOnly();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

canProcess()

Whoops\Handler\PlainTextHandler::canProcess ( )

private

Test if handler can process the exception.

Returns

bool

Definition at line 207 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\isCommandLine(), and Whoops\Handler\PlainTextHandler\onlyForCommandLine().

Referenced by Whoops\Handler\PlainTextHandler\handle().

    {
        return $this->isCommandLine() || !$this->onlyForCommandLine();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFrameArgsOutput()

Whoops\Handler\PlainTextHandler::getFrameArgsOutput ( Frame  $frame,   $line  )

private

Get the frame args var_dump.

Parameters

\Whoops\Exception\Frame	$frame	[description]
integer	$line	[description]

Returns

string

Definition at line 228 of file PlainTextHandler.php.

References Whoops\Handler\Handler\$inspector, Whoops\Handler\PlainTextHandler\addTraceFunctionArgsToOutput(), Whoops\Handler\PlainTextHandler\addTraceToOutput(), Whoops\Exception\Frame\getArgs(), Whoops\Handler\Handler\getInspector(), and Whoops\Handler\PlainTextHandler\getTraceFunctionArgsOutputLimit().

    {
        if ($this->addTraceFunctionArgsToOutput() === false
            || $this->addTraceFunctionArgsToOutput() < $line) {
            return '';
        }

        // Dump the arguments:
        ob_start();
        var_dump($frame->getArgs());
        if (ob_get_length() > $this->getTraceFunctionArgsOutputLimit()) {
            // The argument var_dump is to big.
            // Discarded to limit memory usage.
            ob_clean();
            return sprintf(
                "\n%sArguments dump length greater than %d Bytes. Discarded.",
                self::VAR_DUMP_PREFIX,
                $this->getTraceFunctionArgsOutputLimit()
            );
        }

        return sprintf("\n%s",
            preg_replace('/^/m', self::VAR_DUMP_PREFIX, ob_get_clean())
        );
    }

Here is the call graph for this function:

getLogger()

Whoops\Handler\PlainTextHandler::getLogger

(

)

Returns

|null

Definition at line 91 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$logger.

Referenced by Whoops\Handler\PlainTextHandler\handle().

    {
        return $this->logger;
    }

Here is the caller graph for this function:

getTraceFunctionArgsOutputLimit()

Whoops\Handler\PlainTextHandler::getTraceFunctionArgsOutputLimit

(

)

Get the size limit in bytes of frame arguments var_dump output.

If the limit is reached, the var_dump output is discarded. Prevent memory limit errors.

Returns

integer

Definition at line 147 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$traceFunctionArgsOutputLimit.

Referenced by Whoops\Handler\PlainTextHandler\getFrameArgsOutput().

    {
        return $this->traceFunctionArgsOutputLimit;
    }

Here is the caller graph for this function:

handle()

Whoops\Handler\PlainTextHandler::handle

(

)

Returns

int

Implements Whoops\Handler\HandlerInterface.

Definition at line 298 of file PlainTextHandler.php.

References Whoops\Handler\Handler\$exception, Whoops\Handler\PlainTextHandler\canOutput(), Whoops\Handler\PlainTextHandler\canProcess(), Whoops\Util\Misc\canSendHeaders(), Whoops\Handler\Handler\DONE, Whoops\Handler\Handler\getException(), Whoops\Handler\PlainTextHandler\getLogger(), and Whoops\Handler\Handler\QUIT.

    {
        if (! $this->canProcess()) {
            return Handler::DONE;
        }

        $exception = $this->getException();

        $response = sprintf("%s: %s in file %s on line %d%s\n",
                get_class($exception),
                $exception->getMessage(),
                $exception->getFile(),
                $exception->getLine(),
                $this->getTraceOutput()
            );

        if ($this->getLogger()) {
            $this->getLogger()->error($response);
        }

        if (! $this->canOutput()) {
            return Handler::DONE;
        }

        if (class_exists('\Whoops\Util\Misc')
            && \Whoops\Util\Misc::canSendHeaders()) {
            header('Content-Type: text/plain');
        }

        echo $response;

        return Handler::QUIT;
    }

Here is the call graph for this function:

isCommandLine()

Whoops\Handler\PlainTextHandler::isCommandLine ( )

private

Check, if possible, that this execution was triggered by a command line.

Returns

bool

Definition at line 198 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\canOutput(), and Whoops\Handler\PlainTextHandler\canProcess().

    {
        return PHP_SAPI == 'cli';
    }

Here is the caller graph for this function:

loggerOnly()

Whoops\Handler\PlainTextHandler::loggerOnly

(

$loggerOnly = null

)

Only output to logger.

Parameters

bool | null

$loggerOnly

Returns

null|bool

Definition at line 185 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$loggerOnly.

Referenced by Whoops\Handler\PlainTextHandler\canOutput().

    {
        if (func_num_args() == 0) {
            return $this->loggerOnly;
        }

        $this->loggerOnly = (bool) $loggerOnly;
    }

Here is the caller graph for this function:

onlyForCommandLine()

Whoops\Handler\PlainTextHandler::onlyForCommandLine

(

$onlyForCommandLine = null

)

Restrict error handling to command line calls.

Parameters

bool | null

$onlyForCommandLine

Returns

null|bool

Definition at line 157 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$onlyForCommandLine.

Referenced by Whoops\Handler\PlainTextHandler\canProcess().

    {
        if (func_num_args() == 0) {
            return $this->onlyForCommandLine;
        }
        $this->onlyForCommandLine = (bool) $onlyForCommandLine;
    }

Here is the caller graph for this function:

outputOnlyIfCommandLine()

Whoops\Handler\PlainTextHandler::outputOnlyIfCommandLine

(

$outputOnlyIfCommandLine = null

)

Output the error message only if using command line.

else, output to logger if available. Allow to safely add this handler to web pages.

Parameters

bool | null

$outputOnlyIfCommandLine

Returns

null|bool

Definition at line 172 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$outputOnlyIfCommandLine.

Referenced by Whoops\Handler\PlainTextHandler\canOutput().

    {
        if (func_num_args() == 0) {
            return $this->outputOnlyIfCommandLine;
        }
        $this->outputOnlyIfCommandLine = (bool) $outputOnlyIfCommandLine;
    }

Here is the caller graph for this function:

setLogger()

Whoops\Handler\PlainTextHandler::setLogger

(

$logger = null

)

Set the output logger interface.

Exceptions

InvalidArgumentException

If argument is not null or a LoggerInterface

Parameters

\Psr\Log\LoggerInterface | null

$logger

Definition at line 74 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$logger.

Referenced by Whoops\Handler\PlainTextHandler\__construct().

    {
        if (! (is_null($logger)
            || $logger instanceof LoggerInterface)) {
            throw new InvalidArgumentException(
                'Argument to ' . __METHOD__ .
                " must be a valid Logger Interface (aka. Monolog), " .
                get_class($logger) . ' given.'
            );
        }

        $this->logger = $logger;
    }

Here is the caller graph for this function:

setTraceFunctionArgsOutputLimit()

Whoops\Handler\PlainTextHandler::setTraceFunctionArgsOutputLimit

(

$traceFunctionArgsOutputLimit

)

Definition at line 136 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$traceFunctionArgsOutputLimit.

    {
        $this->traceFunctionArgsOutputLimit = (integer) $traceFunctionArgsOutputLimit;
    }

Field Documentation

$addTraceFunctionArgsToOutput

Whoops\Handler\PlainTextHandler::$addTraceFunctionArgsToOutput = false

private

Definition at line 37 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\addTraceFunctionArgsToOutput().

$addTraceToOutput

Whoops\Handler\PlainTextHandler::$addTraceToOutput = true

private

Definition at line 32 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\addTraceToOutput().

$logger

Whoops\Handler\PlainTextHandler::$logger

protected

Definition at line 27 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\__construct(), Whoops\Handler\PlainTextHandler\getLogger(), and Whoops\Handler\PlainTextHandler\setLogger().

$loggerOnly

Whoops\Handler\PlainTextHandler::$loggerOnly = false

private

Definition at line 57 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\loggerOnly().

$onlyForCommandLine

Whoops\Handler\PlainTextHandler::$onlyForCommandLine = false

private

Definition at line 47 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\onlyForCommandLine().

$outputOnlyIfCommandLine

Whoops\Handler\PlainTextHandler::$outputOnlyIfCommandLine = true

private

Definition at line 52 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\outputOnlyIfCommandLine().

$traceFunctionArgsOutputLimit

Whoops\Handler\PlainTextHandler::$traceFunctionArgsOutputLimit = 1024

private

Definition at line 42 of file PlainTextHandler.php.

Referenced by Whoops\Handler\PlainTextHandler\getTraceFunctionArgsOutputLimit(), and Whoops\Handler\PlainTextHandler\setTraceFunctionArgsOutputLimit().

VAR_DUMP_PREFIX

const Whoops\Handler\PlainTextHandler::VAR_DUMP_PREFIX = ' | '

Definition at line 22 of file PlainTextHandler.php.

---

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

• Services/Exceptions/lib/Whoops/Handler/PlainTextHandler.php