Alpha Framework alpha--util
[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]

Class: LogFile

Source Location: /util/LogFile.inc

Class LogFile

Class Overview

Generic log file class to encapsulate common file I/O and rendering calls

Located in /util/LogFile.inc [line 48]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: LogFile.inc 1341 2011-03-17 15:02:02Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
LogFile   __construct()   The constructor
void   renderLog()   Renders a log file as a HTML table
void   setMaxSize()   Set the max log size in megabytes
void   setSeperator()   Set the value seperator
void   writeLine()   Writes a line of data to the log file

[ Top ]
Methods
Constructor __construct  [line 88]

  LogFile __construct( string $path  )

The constructor

Parameters:
string   $path: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
renderLog  [line 199]

  void renderLog( $cols  )

Renders a log file as a HTML table

$param array $cols The headings to use when rendering the log file

Parameters:
   $cols: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setMaxSize  [line 98]

  void setMaxSize( integer $MaxSize  )

Set the max log size in megabytes

Parameters:
integer   $MaxSize: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setSeperator  [line 108]

  void setSeperator( string $seperator  )

Set the value seperator

Parameters:
string   $seperator: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
writeLine  [line 118]

  void writeLine( $line  )

Writes a line of data to the log file

$param array $line

Parameters:
   $line: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Thu, 17 Mar 2011 16:44:32 +0000 by phpDocumentor 1.4.3