\CGExtensionslogger

An abstract class to assist with logging. An instance of this class will typically be passed into a functional class to assist with logging and debugging.

This class can also handle displaying progress.

Summary

Methods

Properties

Constants

__construct()
advance()
done()
get_percent_complete()
reset()
debug()
verbose()
info()
warning()
error()
fatal()
display_progress()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

abstract

File: lib/abstract.logger.php
Package: CGExtensions
Class hierarchy: \CGExtensions\logger

Methods

__construct()

__construct(integer  $total_steps = 1)

Constructor

Parameters

integer

$total_steps

advance()

advance()

Advance the progress meter.

done()

done() : boolean

Test if the operation is complete.

Returns

boolean

get_percent_complete()

get_percent_complete() : float

Get the progress as a percentage.

Returns

float —

A value between 0 and 100

reset()

reset()

Reset the progress meter

debug()

debug(string  $str)

Display a debug message.

Parameters

string

$str

The message to display.

verbose()

verbose(string  $str)

display_progress(float  $percent)

Displa the current progress

Parameters

float

$percent

The progress percentage.