Documentation

AbstractHandler
in package
implements HandlerInterface

AbstractYes

Debug handler abstract class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
2.2.0

Table of Contents

Interfaces

HandlerInterface
Debug handler interface

Properties

$logger  : Logger|null
Logger object
$loggingParams  : array<string|int, mixed>
Logging params
$name  : string|null
Name of time measurement

Methods

__construct()  : mixed
Constructor
getLogger()  : Logger|null
Get logger
getLoggingParams()  : array<string|int, mixed>
Get logging params
getName()  : string|null
Get name
hasLogger()  : bool
Has logger
hasLoggingParams()  : bool
Has logging parameters
hasName()  : bool
Has name
log()  : void
Trigger handle logging
prepare()  : array<string|int, mixed>
Prepare handler data for storage
prepareAsString()  : string
Prepare handler data as string
prepareHeaderAsString()  : string
Prepare header string
setLogger()  : AbstractHandler
Set logger
setLoggingParams()  : AbstractHandler
Set logger
setName()  : AbstractHandler
Set name

Properties

$loggingParams

Logging params

protected array<string|int, mixed> $loggingParams = []

Methods

__construct()

Constructor

public __construct([string|null $name = null ][, Logger|null $logger = null ][, array<string|int, mixed> $loggingParams = [] ]) : mixed

Instantiate a handler object

Parameters
$name : string|null = null
$logger : Logger|null = null
$loggingParams : array<string|int, mixed> = []

getLoggingParams()

Get logging params

public getLoggingParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getName()

Get name

public getName() : string|null
Return values
string|null

hasLogger()

Has logger

public hasLogger() : bool
Return values
bool

hasLoggingParams()

Has logging parameters

public hasLoggingParams() : bool
Return values
bool

prepare()

Prepare handler data for storage

public abstract prepare() : array<string|int, mixed>
Return values
array<string|int, mixed>

prepareAsString()

Prepare handler data as string

public abstract prepareAsString() : string
Return values
string

prepareHeaderAsString()

Prepare header string

public abstract prepareHeaderAsString() : string
Return values
string

        
On this page

Search results