Documentation

RichRenderer extends Renderer
in package

Table of Contents

SORT_FULL  = 2
SORT_NONE  = 0
SORT_VISIBILITY  = 1
$access_paths  : bool
Whether or not to render access paths.
$always_pre_render  : mixed
$escape_types  : bool
Assume types and sizes don't need to be escaped.
$folder  : bool
Move all dumps to a folder at the bottom of the body.
$needs_folder_render  : mixed
$needs_pre_render  : mixed
$object_plugins  : mixed
RichRenderer object plugins should implement Kint\Renderer\Rich\ObjectPluginInterface.
$pre_render_sources  : mixed
$sort  : int
Sort mode for object properties.
$strlen_max  : int
The maximum length of a string before it is truncated.
$tab_plugins  : mixed
RichRenderer tab plugins should implement Kint\Renderer\Rich\TabPluginInterface.
$theme  : string
Path to the CSS file to load by default.
$call_info  : mixed
$expand  : mixed
$force_pre_render  : mixed
$plugin_objs  : mixed
$pre_render  : mixed
$show_trace  : mixed
$statics  : mixed
$use_folder  : mixed
__construct()  : mixed
escape()  : mixed
filterParserPlugins()  : mixed
getCallInfo()  : mixed
getExpand()  : mixed
getPreRender()  : mixed
getShowTrace()  : mixed
getStatics()  : mixed
getUseFolder()  : mixed
ideLink()  : mixed
matchPlugins()  : array<string|int, mixed>
Returns the first compatible plugin available.
postRender()  : mixed
preRender()  : mixed
render()  : mixed
renderChildren()  : mixed
renderHeader()  : mixed
renderHeaderWrapper()  : mixed
renderNothing()  : mixed
setCallInfo()  : mixed
setExpand()  : mixed
setForcePreRender()  : mixed
setPreRender()  : mixed
setShowTrace()  : mixed
setStatics()  : mixed
setUseFolder()  : mixed
sortProperties()  : array<string|int, BasicObject>
Sorts an array of BasicObject.
sortPropertiesFull()  : mixed
getPlugin()  : mixed
renderCss()  : mixed
renderFolder()  : mixed
renderJs()  : mixed
renderTab()  : mixed

Constants

SORT_VISIBILITY

public mixed SORT_VISIBILITY = 1

Properties

$access_paths

Whether or not to render access paths.

public static bool $access_paths = true

Access paths can become incredibly heavy with very deep and wide structures. Given mostly public variables it will typically make up one quarter of the output HTML size.

If this is an unacceptably large amount and your browser is groaning under the weight of the access paths - your first order of buisiness should be to get a new browser. Failing that, use this to turn them off.

$always_pre_render

public static mixed $always_pre_render = false

$escape_types

Assume types and sizes don't need to be escaped.

public static bool $escape_types = false

Turn this off if you use anything but ascii in your class names, but it'll cause a slowdown of around 10%

$folder

Move all dumps to a folder at the bottom of the body.

public static bool $folder = true

$needs_folder_render

public static mixed $needs_folder_render = true

$needs_pre_render

public static mixed $needs_pre_render = true

$object_plugins

RichRenderer object plugins should implement Kint\Renderer\Rich\ObjectPluginInterface.

public static mixed $object_plugins = array('blacklist' => 'Kint\Renderer\Rich\BlacklistPlugin', 'callable' => 'Kint\Renderer\Rich\CallablePlugin', 'closure' => 'Kint\Renderer\Rich\ClosurePlugin', 'color' => 'Kint\Renderer\Rich\ColorPlugin', 'depth_limit' => 'Kint\Renderer\Rich\DepthLimitPlugin', 'recursion' => 'Kint\Renderer\Rich\RecursionPlugin', 'simplexml_element' => 'Kint\Renderer\Rich\SimpleXMLElementPlugin', 'trace_frame' => 'Kint\Renderer\Rich\TraceFramePlugin')

$pre_render_sources

public static mixed $pre_render_sources = array('script' => array(array('Kint\Renderer\RichRenderer', 'renderJs'), array('Kint\Renderer\Rich\MicrotimePlugin', 'renderJs')), 'style' => array(array('Kint\Renderer\RichRenderer', 'renderCss')), 'raw' => array())

$sort

Sort mode for object properties.

public static int $sort = self::SORT_NONE

$strlen_max

The maximum length of a string before it is truncated.

public static int $strlen_max = 80

Falsey to disable

$tab_plugins

RichRenderer tab plugins should implement Kint\Renderer\Rich\TabPluginInterface.

public static mixed $tab_plugins = array('binary' => 'Kint\Renderer\Rich\BinaryPlugin', 'color' => 'Kint\Renderer\Rich\ColorPlugin', 'docstring' => 'Kint\Renderer\Rich\DocstringPlugin', 'microtime' => 'Kint\Renderer\Rich\MicrotimePlugin', 'source' => 'Kint\Renderer\Rich\SourcePlugin', 'table' => 'Kint\Renderer\Rich\TablePlugin', 'timestamp' => 'Kint\Renderer\Rich\TimestampPlugin')

$theme

Path to the CSS file to load by default.

public static string $theme = 'original.css'

$call_info

protected mixed $call_info = array()

$force_pre_render

protected mixed $force_pre_render = false

$show_trace

protected mixed $show_trace = true

$statics

protected mixed $statics = array()

Methods

__construct()

public __construct() : mixed
Return values
mixed —

escape()

public escape(mixed $string[, mixed $encoding = false ]) : mixed
Parameters
$string : mixed
$encoding : mixed = false
Return values
mixed —

filterParserPlugins()

public filterParserPlugins(array<string|int, mixed> $plugins) : mixed
Parameters
$plugins : array<string|int, mixed>
Return values
mixed —

getCallInfo()

public getCallInfo() : mixed
Return values
mixed —

getExpand()

public getExpand() : mixed
Return values
mixed —

getPreRender()

public getPreRender() : mixed
Return values
mixed —

getShowTrace()

public getShowTrace() : mixed
Return values
mixed —

getStatics()

public getStatics() : mixed
Return values
mixed —

getUseFolder()

public getUseFolder() : mixed
Return values
mixed —

ideLink()

public ideLink(mixed $file, mixed $line) : mixed
Parameters
$file : mixed
$line : mixed
Return values
mixed —

matchPlugins()

Returns the first compatible plugin available.

public matchPlugins(array<string|int, mixed> $plugins, array<string|int, mixed> $hints) : array<string|int, mixed>
Parameters
$plugins : array<string|int, mixed>

Array of hints to class strings

$hints : array<string|int, mixed>

Array of object hints

Return values
array<string|int, mixed> —

Array of hints to class strings filtered and sorted by object hints

postRender()

public postRender() : mixed
Return values
mixed —

preRender()

public preRender() : mixed
Return values
mixed —

renderHeaderWrapper()

public renderHeaderWrapper(BasicObject $o, mixed $has_children, mixed $contents) : mixed
Parameters
$o : BasicObject
$has_children : mixed
$contents : mixed
Return values
mixed —

renderNothing()

public renderNothing() : mixed
Return values
mixed —

setCallInfo()

public setCallInfo(array<string|int, mixed> $info) : mixed
Parameters
$info : array<string|int, mixed>
Return values
mixed —

setExpand()

public setExpand(mixed $expand) : mixed
Parameters
$expand : mixed
Return values
mixed —

setForcePreRender()

public setForcePreRender() : mixed
Return values
mixed —

setPreRender()

public setPreRender(mixed $pre_render) : mixed
Parameters
$pre_render : mixed
Return values
mixed —

setShowTrace()

public setShowTrace(mixed $show_trace) : mixed
Parameters
$show_trace : mixed
Return values
mixed —

setStatics()

public setStatics(array<string|int, mixed> $statics) : mixed
Parameters
$statics : array<string|int, mixed>
Return values
mixed —

setUseFolder()

public setUseFolder(mixed $use_folder) : mixed
Parameters
$use_folder : mixed
Return values
mixed —

sortProperties()

Sorts an array of BasicObject.

public static sortProperties(array<string|int, BasicObject> $contents, int $sort) : array<string|int, BasicObject>
Parameters
$contents : array<string|int, BasicObject>

Object properties to sort

$sort : int
Return values
array<string|int, BasicObject> —

getPlugin()

protected getPlugin(array<string|int, mixed> $plugins, array<string|int, mixed> $hints) : mixed
Parameters
$plugins : array<string|int, mixed>
$hints : array<string|int, mixed>
Return values
mixed —

renderCss()

protected static renderCss() : mixed
Return values
mixed —

renderFolder()

protected static renderFolder() : mixed
Return values
mixed —

renderJs()

protected static renderJs() : mixed
Return values
mixed —

Search results