Monolog handler for Google Chrome extension "PHP Console". More...

Inheritance diagram for Monolog\Handler\PHPConsoleHandler:

Collaboration diagram for Monolog\Handler\PHPConsoleHandler:

Public Member Functions

__construct (array $options=array(), Connector $connector=null, $level=Logger::DEBUG, $bubble=true)

getConnector ()

getOptions ()

handle (array $record)

{{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

}} More...

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: Boolean

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

{Removes the processor on top of the stack and returns it.

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

Sets minimum logging level at which this handler will be triggered. More...

getLevel ()

Gets minimum logging level at which this handler will be triggered. More...

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

isHandling (array $record)

Checks whether the given record will be handled by this handler. More...

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

Removes the processor on top of the stack and returns it. More...

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

Protected Member Functions
	write (array $record)
	Writes the record down to the log of the implementing handler. More...

	getDefaultFormatter ()
	Gets the default formatter. Returns FormatterInterface More...

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...

	processRecord (array $record)
	Processes a record. More...

	getDefaultFormatter ()
	Gets the default formatter. More...

Private Member Functions
	initOptions (array $options)

	initConnector (Connector $connector=null)

	handleDebugRecord (array $record)

	handleExceptionRecord (array $record)

	handleErrorRecord (array $record)

	getRecordTags (array &$record)

Private Attributes
	$options

	$connector

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

Monolog handler for Google Chrome extension "PHP Console".

Display PHP error/debug log messages in Google Chrome console and notification popups, executes PHP code remotely

Usage:

Install Google Chrome extension https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef
See overview https://github.com/barbushin/php-console#overview
Install PHP Console library https://github.com/barbushin/php-console#installation
Example (result will looks like http://i.hizliresim.com/vg3Pz4.png)

$logger = new \Monolog\Logger('all', array(new \Monolog\Handler\PHPConsoleHandler())); \Monolog\ErrorHandler::register($logger); echo $undefinedVar; $logger->addDebug('SELECT * FROM users', array('db', 'time' => 0.012)); PC::debug($_SERVER); // PHP Console debugger for any type of vars

Author: Sergey Barbushin https://www.linkedin.com/in/barbushin

Definition at line 40 of file PHPConsoleHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\PHPConsoleHandler::__construct	(	array	$options = `array()`,
		Connector	$connector = `null`,
			$level = `Logger::DEBUG`,
			$bubble = `true`
	)

Parameters

array	$options	See \Monolog\Handler\PHPConsoleHandler$options for more details
Connector \| null	$connector	Instance of \PhpConsole\Connector class (optional)
int	$level
bool	$bubble

Exceptions

Exception

Definition at line 75 of file PHPConsoleHandler.php.

    {
        if (!class_exists('PhpConsole\Connector')) {
            throw new Exception('PHP Console library not found. See https://github.com/barbushin/php-console#installation');
        }
        parent::__construct($level, $bubble);
        $this->options = $this->initOptions($options);
        $this->connector = $this->initConnector($connector);
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\PHPConsoleHandler\$connector, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\PHPConsoleHandler\$options, Monolog\Handler\PHPConsoleHandler\initConnector(), and Monolog\Handler\PHPConsoleHandler\initOptions().

Here is the call graph for this function:

Member Function Documentation

◆ getConnector()

Monolog\Handler\PHPConsoleHandler::getConnector ( )

Definition at line 150 of file PHPConsoleHandler.php.

    {
        return $this->connector;
    }

References Monolog\Handler\PHPConsoleHandler\$connector.

◆ getDefaultFormatter()

Monolog\Handler\PHPConsoleHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns: FormatterInterface

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 238 of file PHPConsoleHandler.php.

    {
        return new LineFormatter('%message%');
    }

◆ getOptions()

Monolog\Handler\PHPConsoleHandler::getOptions ( )

Definition at line 155 of file PHPConsoleHandler.php.

    {
        return $this->options;
    }

References Monolog\Handler\PHPConsoleHandler\$options.

◆ getRecordTags()

Monolog\Handler\PHPConsoleHandler::getRecordTags ( array & $record )

private

Definition at line 214 of file PHPConsoleHandler.php.

    {
        $tags = null;
        if (!empty($record['context'])) {
            $context =& $record['context'];
            foreach ($this->options['debugTagsKeysInContext'] as $key) {
                if (!empty($context[$key])) {
                    $tags = $context[$key];
                    if ($key === 0) {
                        array_shift($context);
                    } else {
                        unset($context[$key]);
                    }
                    break;
                }
            }
        }
 
        return $tags ?: strtolower($record['level_name']);
    }

Referenced by Monolog\Handler\PHPConsoleHandler\handleDebugRecord().

Here is the caller graph for this function:

◆ handle()

Monolog\Handler\PHPConsoleHandler::handle ( array $record )

{{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

}}

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 160 of file PHPConsoleHandler.php.

    {
        if ($this->options['enabled'] && $this->connector->isActiveClient()) {
            return parent::handle($record);
        }
 
        return !$this->bubble;
    }

References Monolog\Handler\AbstractHandler\$bubble.

◆ handleDebugRecord()

Monolog\Handler\PHPConsoleHandler::handleDebugRecord ( array $record )

private

Definition at line 186 of file PHPConsoleHandler.php.

    {
        $tags = $this->getRecordTags($record);
        $message = $record['message'];
        if ($record['context']) {
            $message .= ' ' . json_encode($this->connector->getDumper()->dump(array_filter($record['context'])));
        }
        $this->connector->getDebugDispatcher()->dispatchDebug($message, $tags, $this->options['classesPartialsTraceIgnore']);
    }

References Monolog\Handler\PHPConsoleHandler\getRecordTags().

Referenced by Monolog\Handler\PHPConsoleHandler\write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleErrorRecord()

Monolog\Handler\PHPConsoleHandler::handleErrorRecord ( array $record )

private

Definition at line 201 of file PHPConsoleHandler.php.

    {
        $context = $record['context'];
 
        $this->connector->getErrorsDispatcher()->dispatchError(
            isset($context['code']) ? $context['code'] : null,
            isset($context['message']) ? $context['message'] : $record['message'],
            isset($context['file']) ? $context['file'] : null,
            isset($context['line']) ? $context['line'] : null,
            $this->options['classesPartialsTraceIgnore']
        );
    }

Referenced by Monolog\Handler\PHPConsoleHandler\write().

Here is the caller graph for this function:

◆ handleExceptionRecord()

Monolog\Handler\PHPConsoleHandler::handleExceptionRecord ( array $record )

private

Definition at line 196 of file PHPConsoleHandler.php.

    {
        $this->connector->getErrorsDispatcher()->dispatchException($record['context']['exception']);
    }

Referenced by Monolog\Handler\PHPConsoleHandler\write().

Here is the caller graph for this function:

◆ initConnector()

Monolog\Handler\PHPConsoleHandler::initConnector ( Connector $connector = null )

private

Definition at line 95 of file PHPConsoleHandler.php.

    {
        if (!$connector) {
            if ($this->options['dataStorage']) {
                Connector::setPostponeStorage($this->options['dataStorage']);
            }
            $connector = Connector::getInstance();
        }
 
        if ($this->options['registerHelper'] && !Helper::isRegistered()) {
            Helper::register();
        }
 
        if ($this->options['enabled'] && $connector->isActiveClient()) {
            if ($this->options['useOwnErrorsHandler'] || $this->options['useOwnExceptionsHandler']) {
                $handler = Handler::getInstance();
                $handler->setHandleErrors($this->options['useOwnErrorsHandler']);
                $handler->setHandleExceptions($this->options['useOwnExceptionsHandler']);
                $handler->start();
            }
            if ($this->options['sourcesBasePath']) {
                $connector->setSourcesBasePath($this->options['sourcesBasePath']);
            }
            if ($this->options['serverEncoding']) {
                $connector->setServerEncoding($this->options['serverEncoding']);
            }
            if ($this->options['password']) {
                $connector->setPassword($this->options['password']);
            }
            if ($this->options['enableSslOnlyMode']) {
                $connector->enableSslOnlyMode();
            }
            if ($this->options['ipMasks']) {
                $connector->setAllowedIpMasks($this->options['ipMasks']);
            }
            if ($this->options['headersLimit']) {
                $connector->setHeadersLimit($this->options['headersLimit']);
            }
            if ($this->options['detectDumpTraceAndSource']) {
                $connector->getDebugDispatcher()->detectTraceAndSource = true;
            }
            $dumper = $connector->getDumper();
            $dumper->levelLimit = $this->options['dumperLevelLimit'];
            $dumper->itemsCountLimit = $this->options['dumperItemsCountLimit'];
            $dumper->itemSizeLimit = $this->options['dumperItemSizeLimit'];
            $dumper->dumpSizeLimit = $this->options['dumperDumpSizeLimit'];
            $dumper->detectCallbacks = $this->options['dumperDetectCallbacks'];
            if ($this->options['enableEvalListener']) {
                $connector->startEvalRequestsListener();
            }
        }
 
        return $connector;
    }

References Monolog\Handler\PHPConsoleHandler\$connector.

Referenced by Monolog\Handler\PHPConsoleHandler\__construct().

Here is the caller graph for this function:

◆ initOptions()

Monolog\Handler\PHPConsoleHandler::initOptions ( array $options )

private

Definition at line 85 of file PHPConsoleHandler.php.

    {
        $wrongOptions = array_diff(array_keys($options), array_keys($this->options));
        if ($wrongOptions) {
            throw new Exception('Unknown options: ' . implode(', ', $wrongOptions));
        }
 
        return array_replace($this->options, $options);
    }

References Monolog\Handler\PHPConsoleHandler\$options.

Referenced by Monolog\Handler\PHPConsoleHandler\__construct().

Here is the caller graph for this function:

◆ write()

Monolog\Handler\PHPConsoleHandler::write ( array $record )

protected

Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 175 of file PHPConsoleHandler.php.

    {
        if ($record['level'] < Logger::NOTICE) {
            $this->handleDebugRecord($record);
        } elseif (isset($record['context']['exception']) && $record['context']['exception'] instanceof Exception) {
            $this->handleExceptionRecord($record);
        } else {
            $this->handleErrorRecord($record);
        }
    }

References Monolog\Handler\PHPConsoleHandler\handleDebugRecord(), Monolog\Handler\PHPConsoleHandler\handleErrorRecord(), Monolog\Handler\PHPConsoleHandler\handleExceptionRecord(), and Monolog\Logger\NOTICE.

Here is the call graph for this function:

Field Documentation

◆ $connector

Monolog\Handler\PHPConsoleHandler::$connector

private

Definition at line 66 of file PHPConsoleHandler.php.

Referenced by Monolog\Handler\PHPConsoleHandler\__construct(), Monolog\Handler\PHPConsoleHandler\getConnector(), and Monolog\Handler\PHPConsoleHandler\initConnector().

◆ $options

Monolog\Handler\PHPConsoleHandler::$options

private

Initial value:

= array(
        'enabled' => true, 
        'classesPartialsTraceIgnore' => array('Monolog\\'), 
        'debugTagsKeysInContext' => array(0, 'tag'), 
        'useOwnErrorsHandler' => false, 
        'useOwnExceptionsHandler' => false, 
        'sourcesBasePath' => null, 
        'registerHelper' => true, 
        'serverEncoding' => null, 
        'headersLimit' => null, 
        'password' => null, 
        'enableSslOnlyMode' => false, 
        'ipMasks' => array(), 
        'enableEvalListener' => false, 
        'dumperDetectCallbacks' => false, 
        'dumperLevelLimit' => 5, 
        'dumperItemsCountLimit' => 100, 
        'dumperItemSizeLimit' => 5000, 
        'dumperDumpSizeLimit' => 500000, 
        'detectDumpTraceAndSource' => false, 
        'dataStorage' => null, 
    )

Definition at line 42 of file PHPConsoleHandler.php.

Referenced by Monolog\Handler\PHPConsoleHandler\__construct(), Monolog\Handler\PHPConsoleHandler\getOptions(), and Monolog\Handler\PHPConsoleHandler\initOptions().

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

Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/PHPConsoleHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getConnector()

◆ getDefaultFormatter()

◆ getOptions()

◆ getRecordTags()

◆ handle()

◆ handleDebugRecord()

◆ handleErrorRecord()

◆ handleExceptionRecord()

◆ initConnector()

◆ initOptions()

◆ write()

Field Documentation

◆ $connector

◆ $options