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 ()
	setDumper (callable $dumper)
	Set var dumper callback function. More...
	addTraceToOutput ($addTraceToOutput=null)
	Add error trace to output. More...
	addTraceFunctionArgsToOutput ($addTraceFunctionArgsToOutput=null)
	Add error trace function arguments to output. More...
	setTraceFunctionArgsOutputLimit ($traceFunctionArgsOutputLimit)
	generateResponse ()
	Create plain text response and return it as a string. More...
	getTraceFunctionArgsOutputLimit ()
	Get the size limit in bytes of frame arguments var_dump output. More...
	loggerOnly ($loggerOnly=null)
	Only output to logger. More...
	handle ()
	contentType ()
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (RunInterface $run)
	setInspector (Inspector $inspector)
	setException ($exception)

Data Fields
const	VAR_DUMP_PREFIX = ' | '
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10
const	LAST_HANDLER = 0x20
	The Handler has handled the Throwable in some way, and wishes to skip any other Handler. More...
const	QUIT = 0x30
	The Handler has handled the Throwable in some way, and wishes to quit/stop execution. More...

Protected Member Functions
	dump ($var)
	Dump variable. More...
Protected Member Functions inherited from Whoops\Handler\Handler
	getRun ()
	getInspector ()
	getException ()

Protected Attributes
	$logger
	$dumper

Private Member Functions
	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
	$loggerOnly = false

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 59 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 123 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 107 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$addTraceToOutput.

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

    {
        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 193 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\loggerOnly().

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

    {
        return !$this->loggerOnly();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

contentType()

Whoops\Handler\PlainTextHandler::contentType

(

)

Returns

string

Definition at line 310 of file PlainTextHandler.php.

    {
        return 'text/plain';
    }

dump()

Whoops\Handler\PlainTextHandler::dump (   $var )

protected

Dump variable.

Parameters

mixed

$var

Returns

void

Definition at line 237 of file PlainTextHandler.php.

References Whoops\Handler\Handler\$inspector, $response, $template, Whoops\Handler\PlainTextHandler\addTraceToOutput(), Whoops\Handler\PlainTextHandler\getFrameArgsOutput(), and Whoops\Handler\Handler\getInspector().

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

    {
        if ($this->dumper) {
            call_user_func($this->dumper, $var);
        } else {
            var_dump($var);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generateResponse()

Whoops\Handler\PlainTextHandler::generateResponse

(

)

Create plain text response and return it as a string.

Returns

string

Definition at line 151 of file PlainTextHandler.php.

References Whoops\Handler\Handler\$exception, and Whoops\Handler\Handler\getException().

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

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

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 204 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\addTraceFunctionArgsToOutput(), Whoops\Handler\PlainTextHandler\dump(), Whoops\Exception\Frame\getArgs(), and Whoops\Handler\PlainTextHandler\getTraceFunctionArgsOutputLimit().

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

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

        // Dump the arguments:
        ob_start();
        $this->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:

Here is the caller graph for this function:

getLogger()

Whoops\Handler\PlainTextHandler::getLogger

(

)

Returns

|null

Definition at line 86 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 170 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 290 of file PlainTextHandler.php.

References $response, Whoops\Handler\PlainTextHandler\canOutput(), Whoops\Handler\Handler\DONE, Whoops\Handler\PlainTextHandler\generateResponse(), Whoops\Handler\PlainTextHandler\getLogger(), and Whoops\Handler\Handler\QUIT.

    {
        $response = $this->generateResponse();

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

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

        echo $response;

        return Handler::QUIT;
    }

Here is the call 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 180 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:

setDumper()

Whoops\Handler\PlainTextHandler::setDumper

(

callable

$dumper

)

Set var dumper callback function.

Parameters

callable

$dumper

Returns

void

Definition at line 97 of file PlainTextHandler.php.

References Whoops\Handler\PlainTextHandler\$dumper.

    {
        $this->dumper = $dumper;
    }

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 69 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 142 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 42 of file PlainTextHandler.php.

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

$addTraceToOutput

Whoops\Handler\PlainTextHandler::$addTraceToOutput = true

private

Definition at line 37 of file PlainTextHandler.php.

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

$dumper

Whoops\Handler\PlainTextHandler::$dumper

protected

Definition at line 32 of file PlainTextHandler.php.

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

$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 52 of file PlainTextHandler.php.

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

$traceFunctionArgsOutputLimit

Whoops\Handler\PlainTextHandler::$traceFunctionArgsOutputLimit = 1024

private

Definition at line 47 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:

• libs/composer/vendor/filp/whoops/src/Whoops/Handler/PlainTextHandler.php