mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]

Class: Layout

Source Location: /logging/Layout.class.php

Class Overview

MojaviObject
   |
   --Layout

Layout allows you to specify a message layout for log messages.


Author(s):

  • Sean Kerr (skerr@mojavi.org)

Version:

  • $Id: Layout.class.php 762 2005-01-29 06:30:25Z seank $

Copyright:

Methods


Child classes:

Inherited Methods

Class: MojaviObject

MojaviObject::toString()
Retrieve a string representation of this object.

Class Details

[line 23]
Layout allows you to specify a message layout for log messages.



Tags:

abstract:  
version:  $Id: Layout.class.php 762 2005-01-29 06:30:25Z seank $
since:  1.0.0
copyright:  (c) Sean Kerr, http://www.mojavi.org
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]


Class Methods


method format [line 47]

string &format( Message $message)

Format a message.



Tags:

return:  A formatted message.
abstract:  
since:  1.0.0
author:  Sean Kerr (skerr@mojavi.org)


Overridden in child classes as:

PatternLayout::format()
Format a message.

Parameters:

Message   $message   A Message instance.

[ Top ]

method getLayout [line 59]

string getLayout( )

Retrieve the message layout.



Tags:

return:  A message layout.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method setLayout [line 78]

void setLayout( string $layout)

Set the message layout.



Tags:

access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


Parameters:

string   $layout   A message layout.

[ Top ]


Documentation generated on Tue, 21 Feb 2006 01:45:19 +0900 by phpDocumentor 1.3.0RC5