\com\bmj\jnp\plugins\jnpLogger

Common Import Logger

Summary

Methods

Properties

Constants

init()
buffer()
getType()
getPlugin()
setSitePrefix()
clearSitePrefix()
start()
finish()
error()
quiet()
write()
verbose()

No public properties found

No constants found

clearBuffer()
printBuffer()
getErrors()

$type
$plugin
$buffer
$sitePrefix
$errors
$dtStart

N/A

No private methods found

No private properties found

N/A

abstract

File: jnp/jnp-logger.php
Package: jnp
Class hierarchy: \com\bmj\jnp\plugins\jnp\Logger

Properties

$type

$type : string

Type

string — Type of error i.e. category

$plugin

$plugin : string

Type

string — Calling plugin

$buffer

$buffer : array

Type

array — Message buffer

$sitePrefix

$sitePrefix : string

Type

string — Site prefix

$errors

$errors : integer

Type

integer — Number of errors logged

$dtStart

$dtStart : \DateTime

Type

\DateTime — Time logging started

Methods

init()

init(string  $type, string  $plugin)

Initialise

Parameters

string	$type	Import error type
string	$plugin	Import error plugin

buffer()

buffer(string  $fmt, \com\bmj\jnp\plugins\jnp\...  $args)

Buffer log entry

Parameters

string	$fmt	Format string
\com\bmj\jnp\plugins\jnp\...	$args	Variable args

getType()

getType() : string

slug getter

Returns

string

getPlugin()

getPlugin() : string

plugin getter

Returns

string

setSitePrefix()

setSitePrefix(string  $prefix)

Set site prefix

i.e. *.bmj.com

Parameters

string

$prefix

Site prefix

clearSitePrefix()

clearSitePrefix()

Clears site prefix

start()

start()

Log start of import

finish()

finish()

Log finish of import

error()

error(string  $fmt, \com\bmj\jnp\plugins\jnp\...  $args)

Log error level message

Parameters

string	$fmt	Message format string
\com\bmj\jnp\plugins\jnp\...	$args

quiet()

quiet(string  $fmt, \com\bmj\jnp\plugins\jnp\...  $args)

Log quiet level message

Parameters

string	$fmt	Message format string
\com\bmj\jnp\plugins\jnp\...	$args

write()

write(string  $fmt,   $args)

Log normal level message

Parameters

string	$fmt	Message format string
	$args

verbose()

verbose(string  $fmt, \com\bmj\jnp\plugins\jnp\...  $args)

Log verbose level message

Parameters

string	$fmt	Message format string
\com\bmj\jnp\plugins\jnp\...	$args

clearBuffer()

clearBuffer()

Clear current buffer

printBuffer()

printBuffer()

Output current buffer

Clears buffer after output

getErrors()

getErrors() : string

Textual representation of error count

Returns

string