PHP Class Yii2Debug, yii2-debug

Since: 1.1.13
Author: Roman Zhuravlev ([email protected])
Inheritance: extends CApplicationComponent
Afficher le fichier Open project: zhuravljov/yii2-debug Class Usage Examples

Méthodes publiques

Свойство Type Description
$accessExpression Additional php expression for access evaluation.
$allowedIPs the list of IPs that are allowed to access this module. Each array element represents a single IP filter which can be either an IP address or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. The default value is ['127.0.0.1', '::1'], which means the module can only be accessed by localhost.
$enabled enable/disable component in application.
$hiddenConfigOptions list of unsecure component options (like login, passwords, secret keys) that will be hidden in application configuration page.
$highlightCode highlight code in debug logs.
$historySize the maximum number of debug data files to keep. If there are more files generated, the oldest ones will be removed.
$internalUrls use nice route rules in debug module.
$logPath the directory storing the debugger data files. This can be specified using a path alias.
$moduleId module ID for viewing stored debug logs.
$panels list debug panels. The array keys are the panel IDs, and values are the corresponding panel class names or configuration arrays. This will be merged with ::corePanels(). You may reconfigure a core panel via this property by using the same panel ID. You may also disable a core panel by setting it to be false in this property.
$showConfig show brief application configuration.

Méthodes publiques

Méthode Description
checkAccess ( ) : boolean Check access rights.
dump ( mixed $data ) Dump variable to debug log.
getLock ( string $tag ) : boolean
getTag ( ) : string
init ( ) Panel initialization.
prepareData ( mixed $data ) : array Convert data to plain array in recursive manner.
setLock ( string $tag, boolean $value )

Méthodes protégées

Méthode Description
corePanels ( ) : array
coreUrlRules ( )
initToolbar ( ) Register debug panel scripts.
onEndRequest ( CEvent $event )
processDebug ( ) Log processing routine.
resizeHistory ( &$manifest ) Debug files rotation according to {@link ::$historySize}.

Private Methods

Méthode Description
updateIndexFile ( string $indexFile, array $summary ) Updates index file with summary log data

Method Details

checkAccess() public méthode

Check access rights.
public checkAccess ( ) : boolean
Résultat boolean

corePanels() protected méthode

protected corePanels ( ) : array
Résultat array default panels

coreUrlRules() protected méthode

protected coreUrlRules ( )

dump() public static méthode

Dump variable to debug log.
public static dump ( mixed $data )
$data mixed

getLock() public méthode

public getLock ( string $tag ) : boolean
$tag string
Résultat boolean

getTag() public méthode

public getTag ( ) : string
Résultat string current page tag

init() public méthode

Generate unique tag for page. Attach panels, log watcher. Register scripts for printing debug panel.
public init ( )

initToolbar() protected méthode

Register debug panel scripts.
protected initToolbar ( )

onEndRequest() protected méthode

protected onEndRequest ( CEvent $event )
$event CEvent

prepareData() public static méthode

Convert data to plain array in recursive manner.
public static prepareData ( mixed $data ) : array
$data mixed
Résultat array

processDebug() protected méthode

Log processing routine.
protected processDebug ( )

resizeHistory() protected méthode

Debug files rotation according to {@link ::$historySize}.
protected resizeHistory ( &$manifest )
$manifest

setLock() public méthode

public setLock ( string $tag, boolean $value )
$tag string
$value boolean

Property Details

$accessExpression public_oe property

Additional php expression for access evaluation.
public $accessExpression

$allowedIPs public_oe property

the list of IPs that are allowed to access this module. Each array element represents a single IP filter which can be either an IP address or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. The default value is ['127.0.0.1', '::1'], which means the module can only be accessed by localhost.
public $allowedIPs

$enabled public_oe property

enable/disable component in application.
public $enabled

$hiddenConfigOptions public_oe property

list of unsecure component options (like login, passwords, secret keys) that will be hidden in application configuration page.
public $hiddenConfigOptions

$highlightCode public_oe property

highlight code in debug logs.
public $highlightCode

$historySize public_oe property

the maximum number of debug data files to keep. If there are more files generated, the oldest ones will be removed.
public $historySize

$internalUrls public_oe property

use nice route rules in debug module.
public $internalUrls

$logPath public_oe property

the directory storing the debugger data files. This can be specified using a path alias.
public $logPath

$moduleId public_oe property

module ID for viewing stored debug logs.
public $moduleId

$panels public_oe property

list debug panels. The array keys are the panel IDs, and values are the corresponding panel class names or configuration arrays. This will be merged with ::corePanels(). You may reconfigure a core panel via this property by using the same panel ID. You may also disable a core panel by setting it to be false in this property.
public $panels

$showConfig public_oe property

show brief application configuration.
public $showConfig