Whoops\Handler\XmlResponseHandler Class Reference

Catches an exception and converts it to an XML response. More...

Inheritance diagram for Whoops\Handler\XmlResponseHandler:

Collaboration diagram for Whoops\Handler\XmlResponseHandler:

Public Member Functions
	addTraceToOutput ($returnFrames=null)
	handle ()
	contentType ()
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (RunInterface $run)
	setInspector (Inspector $inspector)
	setException ($exception)

Static Private Member Functions
static	addDataToNode (\SimpleXMLElement $node, $data)
static	toXml ($data)
	The main function for converting to an XML document. More...

Private Attributes
	$returnFrames = false

Additional Inherited Members
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 inherited from Whoops\Handler\Handler
	getRun ()
	getInspector ()
	getException ()

Detailed Description

Catches an exception and converts it to an XML response.

Additionally can also return exception frames for consumption by an API.

Definition at line 17 of file XmlResponseHandler.php.

Member Function Documentation

addDataToNode()

static Whoops\Handler\XmlResponseHandler::addDataToNode ( \SimpleXMLElement  $node,   $data  )

staticprivate

Parameters

SimpleXMLElement	$node	Node to append data to, will be modified in place
array | \Traversable	$data

Returns

SimpleXMLElement The modified node, for chaining

Definition at line 68 of file XmlResponseHandler.php.

References $data, and $key.

    {
        assert('is_array($data) || $node instanceof Traversable');

        foreach ($data as $key => $value) {
            if (is_numeric($key)) {
                // Convert the key to a valid string
                $key = "unknownNode_". (string) $key;
            }

            // Delete any char not allowed in XML element names
            $key = preg_replace('/[^a-z0-9\-\_\.\:]/i', '', $key);

            if (is_array($value)) {
                $child = $node->addChild($key);
                self::addDataToNode($child, $value);
            } else {
                $value = str_replace('&', '&', print_r($value, true));
                $node->addChild($key, $value);
            }
        }

        return $node;
    }

addTraceToOutput()

Whoops\Handler\XmlResponseHandler::addTraceToOutput

(

$returnFrames = null

)

Parameters

bool | null

$returnFrames

Returns

bool|$this

Definition at line 28 of file XmlResponseHandler.php.

References Whoops\Handler\XmlResponseHandler\$returnFrames.

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

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

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

Here is the caller graph for this function:

contentType()

Whoops\Handler\XmlResponseHandler::contentType

(

)

Returns

string

Definition at line 58 of file XmlResponseHandler.php.

    {
        return 'application/xml';
    }

handle()

Whoops\Handler\XmlResponseHandler::handle

(

)

Returns

int

Implements Whoops\Handler\HandlerInterface.

Definition at line 41 of file XmlResponseHandler.php.

References $response, Whoops\Handler\XmlResponseHandler\addTraceToOutput(), Whoops\Handler\Handler\getInspector(), Whoops\Handler\Handler\QUIT, and Whoops\Handler\XmlResponseHandler\toXml().

    {
        $response = [
            'error' => Formatter::formatExceptionAsDataArray(
                $this->getInspector(),
                $this->addTraceToOutput()
            ),
        ];

        echo $this->toXml($response);

        return Handler::QUIT;
    }

Here is the call graph for this function:

toXml()

static Whoops\Handler\XmlResponseHandler::toXml (   $data )

staticprivate

The main function for converting to an XML document.

Parameters

array | \Traversable

$data

Returns

string XML

Definition at line 99 of file XmlResponseHandler.php.

References $data.

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

    {
        assert('is_array($data) || $node instanceof Traversable');

        $node = simplexml_load_string("<?xml version='1.0' encoding='utf-8'?><root />");

        return self::addDataToNode($node, $data)->asXML();
    }

Here is the caller graph for this function:

Field Documentation

$returnFrames

Whoops\Handler\XmlResponseHandler::$returnFrames = false

private

Definition at line 22 of file XmlResponseHandler.php.

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

---

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

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