Documentation

CliRenderer extends TextRenderer
in package

Table of Contents

SORT_FULL  = 2
SORT_NONE  = 0
SORT_VISIBILITY  = 1
$cli_colors  : bool
$decorations  : bool
Decorate the header and footer.
$default_indent  : int
Indentation width.
$default_width  : int
The default width of the terminal for headers.
$detect_width  : bool
Detects the terminal width on startup.
$force_utf8  : bool
Forces utf8 output on windows.
$header_width  : mixed
$indent_width  : mixed
$min_terminal_width  : int
The minimum width to detect terminal size as.
$parser_plugin_whitelist  : mixed
Parser plugins must be instanceof one of these or it will be removed for performance reasons.
$plugins  : mixed
TextRenderer plugins should be instances of Kint\Renderer\Text\Plugin.
$sort  : int
Sort mode for object properties.
$strlen_max  : int
The maximum length of a string before it is truncated.
$call_info  : mixed
$colors  : mixed
$plugin_objs  : mixed
$show_trace  : mixed
$statics  : mixed
$terminal_width  : mixed
$windows_output  : mixed
__construct()  : mixed
boxText()  : mixed
colorTitle()  : mixed
colorType()  : mixed
colorValue()  : mixed
escape()  : mixed
filterParserPlugins()  : mixed
getCallInfo()  : mixed
getShowTrace()  : mixed
getStatics()  : mixed
ideLink()  : mixed
matchPlugins()  : array<string|int, mixed>
Returns the first compatible plugin available.
postRender()  : mixed
preRender()  : mixed
render()  : mixed
renderChildren()  : mixed
renderHeader()  : mixed
renderNothing()  : mixed
renderTitle()  : mixed
setCallInfo()  : mixed
setShowTrace()  : mixed
setStatics()  : mixed
sortProperties()  : array<string|int, BasicObject>
Sorts an array of BasicObject.
sortPropertiesFull()  : mixed
calledFrom()  : mixed
getPlugin()  : mixed
utf8ToWindows()  : mixed

Constants

SORT_VISIBILITY

public mixed SORT_VISIBILITY = 1

Properties

$cli_colors

public static bool $cli_colors = true

enable colors when Kint is run in UNIX command line

$decorations

Decorate the header and footer.

public static bool $decorations = true

$default_indent

Indentation width.

public static int $default_indent = 4

$default_width

The default width of the terminal for headers.

public static int $default_width = 80

$detect_width

Detects the terminal width on startup.

public static bool $detect_width = true

$force_utf8

Forces utf8 output on windows.

public static bool $force_utf8 = false

$min_terminal_width

The minimum width to detect terminal size as.

public static int $min_terminal_width = 40

Less than this is ignored and falls back to default width.

$parser_plugin_whitelist

Parser plugins must be instanceof one of these or it will be removed for performance reasons.

public static mixed $parser_plugin_whitelist = array('Kint\Parser\BlacklistPlugin', 'Kint\Parser\MicrotimePlugin', 'Kint\Parser\StreamPlugin', 'Kint\Parser\TracePlugin')

$plugins

TextRenderer plugins should be instances of Kint\Renderer\Text\Plugin.

public static mixed $plugins = array('blacklist' => 'Kint\Renderer\Text\BlacklistPlugin', 'depth_limit' => 'Kint\Renderer\Text\DepthLimitPlugin', 'microtime' => 'Kint\Renderer\Text\MicrotimePlugin', 'recursion' => 'Kint\Renderer\Text\RecursionPlugin', 'trace' => 'Kint\Renderer\Text\TracePlugin')

$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 = 0

Falsey to disable

$call_info

protected mixed $call_info = array()

$show_trace

protected mixed $show_trace = true

$statics

protected mixed $statics = array()

$terminal_width

protected static mixed $terminal_width = null

$windows_output

protected mixed $windows_output = false

Methods

__construct()

public __construct() : mixed
Return values
mixed —

boxText()

public boxText(mixed $text, mixed $width) : mixed
Parameters
$text : mixed
$width : mixed
Return values
mixed —

colorTitle()

public colorTitle(mixed $string) : mixed
Parameters
$string : mixed
Return values
mixed —

colorType()

public colorType(mixed $string) : mixed
Parameters
$string : mixed
Return values
mixed —

colorValue()

public colorValue(mixed $string) : mixed
Parameters
$string : 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 —

getShowTrace()

public getShowTrace() : mixed
Return values
mixed —

getStatics()

public getStatics() : 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 —

renderNothing()

public abstract renderNothing() : mixed
Return values
mixed —

setCallInfo()

public setCallInfo(array<string|int, mixed> $info) : mixed
Parameters
$info : array<string|int, 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 —

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> —

calledFrom()

protected calledFrom() : mixed
Return values
mixed —

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 —

utf8ToWindows()

protected utf8ToWindows(mixed $string) : mixed
Parameters
$string : mixed
Return values
mixed —

Search results