Kint Class Reference

Public Member Functions
	__construct (Parser $p, Renderer $r)
	setParser (Parser $p)
	getParser ()
	setRenderer (Renderer $r)
	getRenderer ()
	setStatesFromStatics (array $statics)
	setStatesFromCallInfo (array $info)
	dumpAll (array $vars, array $base)
	dumpVar (&$var, BasicObject $base)

Static Public Member Functions
static	getStatics ()
static	getBasesFromParamInfo (array $params, $argc)
static	trace ()
static	dump ()
static	shortenPath ($file)
static	getIdeLink ($file, $line)

Data Fields
const	MODE_RICH = 'r'
const	MODE_TEXT = 't'
const	MODE_CLI = 'c'
const	MODE_PLAIN = 'p'

Static Public Attributes
static	$enabled_mode = true
static	$mode_default = self::MODE_RICH
static	$mode_default_cli = self::MODE_CLI
static	$return
static	$file_link_format = ''
static	$display_called_from = true
static	$app_root_dirs = array()
static	$max_depth = 6
static	$expanded = false
static	$cli_detection = true
static	$aliases
static	$renderers
static	$plugins

Static Protected Member Functions
static	getSingleCall (array $frame, $argc)

Protected Attributes
	$parser
	$renderer

Static Protected Attributes
static	$plugin_pool = array()

Constructor & Destructor Documentation

__construct()

__construct	(	Parser	$p,
		Renderer	$r
	)

Member Function Documentation

dump()

static dump ( )

static

Dumps some data.

Functionally equivalent to Kint::dump(1) or Kint::dump(debug_backtrace(true))

Returns

int|string

Here is the call graph for this function:

dumpAll()

dumpAll	(	array	$vars,
		array	$base
	)

Renders a list of vars including the pre and post renders.

Parameters

array	$vars	Data to dump
BasicObject[]	$base	Base objects

Returns

string

dumpVar()

dumpVar	(	&	$var,
		BasicObject	$base
	)

Dumps and renders a var.

Parameters

mixed	$var	Data to dump
BasicObject	$base	Base object

Returns

string

getBasesFromParamInfo()

static getBasesFromParamInfo ( array  $params,   $argc  )

static

Creates base objects given parameter info.

Parameters

array	$params	Parameters as returned from getCallInfo
int	$argc	Number of arguments the helper was called with

Returns

BasicObject[] Base objects for the arguments

Here is the call graph for this function:

getIdeLink()

static getIdeLink (   $file,   $line  )

static

Here is the caller graph for this function:

getParser()

getParser

(

)

getRenderer()

getRenderer

(

)

getSingleCall()

static getSingleCall ( array  $frame,   $argc  )

staticprotected

Returns specific function call info from a stack trace frame, or null if no match could be found.

Parameters

array	$frame	The stack trace frame in question
int	$argc	The amount of arguments received

Returns

null|array{parameters:array, modifiers:array} params and modifiers, or null if a specific call could not be determined

getStatics()

static getStatics ( )

static

Gets all static settings at once.

Returns

array Current static settings

setParser()

setParser

(

Parser

$p

)

setRenderer()

setRenderer

(

Renderer

$r

)

setStatesFromCallInfo()

setStatesFromCallInfo

(

array

$info

)

setStatesFromStatics()

setStatesFromStatics

(

array

$statics

)

shortenPath()

static shortenPath (   $file )

static

generic path display callback, can be configured in app_root_dirs; purpose is to show relevant path info and hide as much of the path as possible.

Parameters

string

$file

Returns

string

Here is the caller graph for this function:

trace()

static trace ( )

static

Dumps a backtrace.

Functionally equivalent to Kint::dump(1) or Kint::dump(debug_backtrace(true))

Returns

int|string

Here is the call graph for this function:

Field Documentation

$aliases

$aliases

static

Initial value:

= array(
        array('Kint\\Kint', 'dump'),
        array('Kint\\Kint', 'trace'),
        array('Kint\\Kint', 'dumpArray'),
    )

$app_root_dirs

$app_root_dirs = array()

static

$cli_detection

$cli_detection = true

static

$display_called_from

$display_called_from = true

static

$enabled_mode

$enabled_mode = true

static

$expanded

$expanded = false

static

$file_link_format

$file_link_format = ''

static

$max_depth

$max_depth = 6

static

$mode_default

$mode_default = self::MODE_RICH

static

$mode_default_cli

$mode_default_cli = self::MODE_CLI

static

$parser

$parser

protected

$plugin_pool

$plugin_pool = array()

staticprotected

$plugins

$plugins

static

Initial value:

= array(
        'Kint\\Parser\\ArrayObjectPlugin',
        'Kint\\Parser\\Base64Plugin',
        'Kint\\Parser\\BlacklistPlugin',
        'Kint\\Parser\\ClassMethodsPlugin',
        'Kint\\Parser\\ClassStaticsPlugin',
        'Kint\\Parser\\ClosurePlugin',
        'Kint\\Parser\\ColorPlugin',
        'Kint\\Parser\\DateTimePlugin',
        'Kint\\Parser\\FsPathPlugin',
        'Kint\\Parser\\IteratorPlugin',
        'Kint\\Parser\\JsonPlugin',
        'Kint\\Parser\\MicrotimePlugin',
        'Kint\\Parser\\SimpleXMLElementPlugin',
        'Kint\\Parser\\SplFileInfoPlugin',
        'Kint\\Parser\\SplObjectStoragePlugin',
        'Kint\\Parser\\StreamPlugin',
        'Kint\\Parser\\TablePlugin',
        'Kint\\Parser\\ThrowablePlugin',
        'Kint\\Parser\\TimestampPlugin',
        'Kint\\Parser\\TracePlugin',
        'Kint\\Parser\\XmlPlugin',
    )

$renderer

$renderer

protected

$renderers

$renderers

static

Initial value:

= array(
        self::MODE_RICH => 'Kint\\Renderer\\RichRenderer',
        self::MODE_PLAIN => 'Kint\\Renderer\\PlainRenderer',
        self::MODE_TEXT => 'Kint\\Renderer\\TextRenderer',
        self::MODE_CLI => 'Kint\\Renderer\\CliRenderer',
    )

$return

$return

static

MODE_CLI

const MODE_CLI = 'c'

MODE_PLAIN

const MODE_PLAIN = 'p'

MODE_RICH

const MODE_RICH = 'r'

MODE_TEXT

const MODE_TEXT = 't'

---

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

• C:/xoops2511b2/htdocs/class/libraries/vendor/kint-php/kint/src/Kint.php