>> YANA 4 PHP Framework >> Docs For Class Report

Class Report

Description

«abstract» Report

This is an abstract super class for all kinds of messages.

  • access: public
  • abstract:

Located in /includes/class_report.php


    
            
Variable Summary
mixed $data
string $message
Method Summary
  • Report Report (string $message, [mixed $data = null])
  • string getLog ([string $prefix = ""])
  • string getMessage ()

Direct descendents

Class Description
Log Log
Message Message

Variables

mixed $data = null

any kind of data that might help to understand the context in which the message was created

  • access: public
string $message = ""

the message that should be reported

  • access: public

Methods

constructor
Report Report (
string $message, [mixed $data = null]
)
List of parameters:
Name Type Description
$message string the message that should be reported
$data mixed (optional) any kind of data that might help to understand context in which the message was created
Description:

Create a new instance, representing a system message. To report this message to the framework, just call $YANA->report($report_object).

create log
string getLog (
[string $prefix = ""]
)
List of parameters:
Name Type Description
$prefix string string to put before each key string
Description:

This creates a log entry that is supposed to be written to a log-file.

The result is an associative array or bool(false) on error.

  • access: public
returns the message string of this event
string getMessage ()
Description:

This creates a string of at most 1000 characters containing the text in the message attribute and a serialized representation of the data attribute.

  • access: public

Redefined in descendants as:

Documentation generated on Sun, 11 Mar 2007 15:02:40 +0100 by phpDocumentor 1.3.1

yana author: Thomas MeyerHomepage: www.yanaframework.net