phpDocumentor openbiz.bin.service
[ class tree: openbiz.bin.service ] [ index: openbiz.bin.service ] [ all elements ]

Class: logService

Source Location: /service/logService.php

Class logService

Class Overview

MetaObject class - MetaObject is the base class of all derived metadata-driven classes

Located in /service/logService.php [line 20]

MetaObject
   |
   --logService

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Method Summary
logService   __construct()   Create the log object
void   closeFile()   Close a file with the correct string depending on the configured format
boolean   log()   The primary log function that will take an incoming message and specified paramter and log in the appropriate location and format
boolean   logError()   The primary log function that will take an incoming message and specified paramter and log in the appropriate location and format
void   prepFile()   Either open a new file with the correct string or remove a previous closing string
void   ReadMetadata()  
void   SetExtension()   Set the extension based on the type of format selected in app.inc
void   SetFormatter()   Set the formatter based on the type of format selected in app.inc

[ Top ]
Methods
Constructor __construct  [line 70]

  logService __construct( mixed &$xmlArr  )

Create the log object


API Tags:
Access:  public


Redefinition of:
MetaObject::__construct()

[ Top ]
closeFile  [line 294]

  void closeFile( mixed $path  )

Close a file with the correct string depending on the configured format


API Tags:
Access:  public


[ Top ]
log  [line 96]

  boolean log( mixed $priority, string $package, string $message, int $level  )

The primary log function that will take an incoming message and specified paramter and log in the appropriate location and format

Parameters:
int   $level:  - Follow common BSD error levels
string   $package:  - A way to group log messages
string   $message:  - The actual message to log

API Tags:
Return:  -TRUE on success otherwise FALSE
Access:  public


[ Top ]
logError  [line 157]

  boolean logError( [int $level = 7], string $package, string $message, [string $file_name = NULL], [mixed $back_trace = ''], string $string  )

The primary log function that will take an incoming message and specified paramter and log in the appropriate location and format

Parameters:
int   $level:  - Follow common BSD error levels
string   $package:  - A way to group log messages
string   $message:  - The actual message to log
string   $file_name:  - An optional specific file name where the message should be logged
string   $string:  - An optional list of the Application stack at the time of error

API Tags:
Return:  -TRUE on success otherwise FALSE
Access:  public


[ Top ]
prepFile  [line 262]

  void prepFile( mixed $path  )

Either open a new file with the correct string or remove a previous closing string


API Tags:
Access:  public


[ Top ]
ReadMetadata  [line 79]

  void ReadMetadata( mixed &$xmlArr  )


API Tags:
Access:  protected


[ Top ]
SetExtension  [line 241]

  void SetExtension( )

Set the extension based on the type of format selected in app.inc


API Tags:
Access:  public


[ Top ]
SetFormatter  [line 216]

  void SetFormatter( )

Set the formatter based on the type of format selected in app.inc


API Tags:
Access:  public


[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:03:10 -0800 by phpDocumentor 1.3.0RC3