ilPlainTextHandler Class Reference

Inheritance diagram for ilPlainTextHandler:

Collaboration diagram for ilPlainTextHandler:

Public Member Functions
	withExclusionList (array $exclusion_list)
	handle ()
	Last missing method from HandlerInterface. More...

Data Fields
const	KEY_SPACE = 25

Protected Member Functions
	content ()
	Assemble the output for this handler. More...
	pageHeader ()
	Get the header for the page. More...
	exceptionContent ()
	Get a short info about the exception. More...
	tablesContent ()
	Get the header for the page. More...
	tables ()
	Get the tables that should be rendered. More...

Private Member Functions
	hideSensitiveData (array $super_global)
	shortenPHPSessionId (array $server)
	Shorts the php session id. More...

Private Attributes
	$exclusion_list = []

Detailed Description

Definition at line 17 of file class.ilPlainTextHandler.php.

Member Function Documentation

content()

ilPlainTextHandler::content ( )

protected

Assemble the output for this handler.

Returns

string

Definition at line 52 of file class.ilPlainTextHandler.php.

References exceptionContent(), pageHeader(), and tablesContent().

Referenced by handle().

    {
        return $this->pageHeader()
              . $this->exceptionContent()
              . $this->tablesContent()
              ;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exceptionContent()

ilPlainTextHandler::exceptionContent ( )

protected

Get a short info about the exception.

Returns

string

Definition at line 75 of file class.ilPlainTextHandler.php.

Referenced by content().

    {
        return Formatter::formatExceptionPlain($this->getInspector());
    }

Here is the caller graph for this function:

handle()

ilPlainTextHandler::handle

(

)

Last missing method from HandlerInterface.

Returns

null

Definition at line 39 of file class.ilPlainTextHandler.php.

References content().

    {
        header("Content-Type: text/plain");
        echo "<pre>\n";
        echo $this->content();
        echo "</pre>\n";
    }

Here is the call graph for this function:

hideSensitiveData()

ilPlainTextHandler::hideSensitiveData ( array  $super_global )

private

Parameters

array<string,mixed>

$super_global

Returns

array<string, mixed>

Definition at line 143 of file class.ilPlainTextHandler.php.

Referenced by tables().

                                                            : array
    {
        foreach ($this->exclusion_list as $parameter) {
            if (isset($super_global[$parameter])) {
                $super_global[$parameter] = 'REMOVED FOR SECURITY';
            }

            if (isset($super_global['post_vars'][$parameter])) {
                $super_global['post_vars'][$parameter] = 'REMOVED FOR SECURITY';
            }
        }

        return $super_global;
    }

Here is the caller graph for this function:

pageHeader()

ilPlainTextHandler::pageHeader ( )

protected

Get the header for the page.

Returns

string

Definition at line 65 of file class.ilPlainTextHandler.php.

Referenced by content().

    {
        return "";
    }

Here is the caller graph for this function:

shortenPHPSessionId()

ilPlainTextHandler::shortenPHPSessionId ( array  $server )

private

Shorts the php session id.

Parameters

array

$server

Returns

array

Definition at line 165 of file class.ilPlainTextHandler.php.

References $server.

Referenced by tables().

    {
        $cookie_content = $server["HTTP_COOKIE"];
        $cookie_content = explode(";", $cookie_content);

        foreach ($cookie_content as $key => $content) {
            $content_array = explode("=", $content);
            if (trim($content_array[0]) == session_name()) {
                $content_array[1] = substr($content_array[1], 0, 5) . " (SHORTENED FOR SECURITY)";
                $cookie_content[$key] = implode("=", $content_array);
            }
        }

        $server["HTTP_COOKIE"] = implode(";", $cookie_content);

        return $server;
    }

Here is the caller graph for this function:

tables()

ilPlainTextHandler::tables ( )

protected

Get the tables that should be rendered.

Returns

array $title => $table

Definition at line 120 of file class.ilPlainTextHandler.php.

References $_COOKIE, $_GET, $_POST, $_SERVER, $_SESSION, $server, hideSensitiveData(), and shortenPHPSessionId().

Referenced by tablesContent().

    {
        $post = $_POST;
        $server = $_SERVER;

        $post = $this->hideSensitiveData($post);
        $server = $this->hideSensitiveData($server);
        $server = $this->shortenPHPSessionId($server);

        return array( "GET Data" => $_GET
            , "POST Data" => $post
            , "Files" => $_FILES
            , "Cookies" => $_COOKIE
            , "Session" => isset($_SESSION) ? $_SESSION : array()
            , "Server/Request Data" => $server
            , "Environment Variables" => $_ENV
            );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

tablesContent()

ilPlainTextHandler::tablesContent ( )

protected

Get the header for the page.

Returns

string

Definition at line 85 of file class.ilPlainTextHandler.php.

References $ret, and tables().

Referenced by content().

    {
        $ret = "";
        foreach ($this->tables() as $title => $content) {
            $ret .= "\n\n-- $title --\n\n";
            if (count($content) > 0) {
                foreach ($content as $key => $value) {
                    $key = str_pad($key, self::KEY_SPACE);

                    // indent multiline values, first print_r, split in lines,
                    // indent all but first line, then implode again.
                    $first = true;
                    $indentation = str_pad("", self::KEY_SPACE);
                    $value = implode("\n", array_map(function ($line) use (&$first, $indentation) {
                        if ($first) {
                            $first = false;
                            return $line;
                        }
                        return $indentation . $line;
                    }, explode("\n", print_r($value, true))));

                    $ret .= "$key: $value\n";
                }
            } else {
                $ret .= "empty\n";
            }
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withExclusionList()

ilPlainTextHandler::withExclusionList

(

array

$exclusion_list

)

Parameters

list<string>

$exclusion_list

Definition at line 27 of file class.ilPlainTextHandler.php.

References $exclusion_list.

                                                             : self
    {
        $clone = clone $this;
        $clone->exclusion_list = $exclusion_list;
        return $clone;
    }

Field Documentation

$exclusion_list

ilPlainTextHandler::$exclusion_list = []

private

Definition at line 22 of file class.ilPlainTextHandler.php.

Referenced by withExclusionList().

KEY_SPACE

const ilPlainTextHandler::KEY_SPACE = 25

Definition at line 19 of file class.ilPlainTextHandler.php.

---

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

• Services/Exceptions/classes/class.ilPlainTextHandler.php