FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Handler Class Reference
Inheritance diagram for Handler:
Thing Console File Http Mem Stats Html Mail

Public Member Functions

 __construct ($log, $config, $name=null)
 
 add ($prio, $message, $context)
 
 periodMessages ($start, $end=null)
 Unique period messages within a period. More...
 
 periods ($message, $start, $end=null)
 Periods for a messages within a period. More...
 
- Public Member Functions inherited from Thing
 propertyExists ($property)
 Check if a property exists (public or published). More...
 
 constants ($prefix=null)
 Return all constants. More...
 
 get ($key)
 Get one or more properties. More...
 
 set ($key, $value=null)
 Set one or more properties. More...
 
 __get ($key)
 
 __set ($key, $value)
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from Thing
 publish ($property, $visibility=self::READABLE)
 Publish a property (or hide it again). More...
 
 alias ($alias, $property, $object=null)
 Define an alias for a property (of another object). More...
 
 configure ($config)
 Configure the object. More...
 
 _get ($key)
 Default getter if no specific setter is defined, and the property is also not published (readable). More...
 
 _set ($key, $value)
 Default setter if no specific setter is defined, and the property is also not published (writeable). More...
 

Protected Attributes

 $_log
 
 $_config = null
 
 $_name = null
 
- Protected Attributes inherited from Thing
 $_published = []
 Published properties (key = name of property, value = visibility). More...
 
 $_aliases = []
 Alias properties (key = alias, value = [object,property]). More...
 

Additional Inherited Members

- Data Fields inherited from Thing
const HIDDEN = 0
 Property is hidden. More...
 
const READABLE = 1
 Property is readable. More...
 
const WRITEABLE = 2
 Property is writeable. More...
 
const READWRITE = 3
 Property is readable and writeable. More...
 

Detailed Description

Definition at line 5 of file Handler.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $log,
  $config,
  $name = null 
)

Definition at line 11 of file Handler.php.

Member Function Documentation

◆ add()

add (   $prio,
  $message,
  $context 
)
abstract

Reimplemented in Mail, Html, Stats, File, Mem, Http, and Console.

◆ init()

init ( )
protected

Reimplemented in Mem.

Definition at line 19 of file Handler.php.

◆ periodMessages()

periodMessages (   $start,
  $end = null 
)

Unique period messages within a period.

Parameters
int$startTimestamp for start of period.
int$endTimestamp for end of period (empty = now).
Returns
array Unique messages.

Definition at line 29 of file Handler.php.

◆ periods()

periods (   $message,
  $start,
  $end = null 
)

Periods for a messages within a period.

Parameters
string$message
int$startTimestamp for start of period.
int$endTimestamp for end of period (empty = now).
Returns
array Array of records (in chronological order) with 'start', (optional) 'end' timestamp, and (optional) points array (records with time and message).

Definition at line 40 of file Handler.php.

Field Documentation

◆ $_config

$_config = null
protected

Definition at line 8 of file Handler.php.

◆ $_log

$_log
protected

Definition at line 7 of file Handler.php.

◆ $_name

$_name = null
protected

Definition at line 9 of file Handler.php.


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