# Class LogFile

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

Package: alpha::util
Copyright: Copyright (c) 2014, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: LogFile.inc 1756 2014-04-08 22:54:10Z alphadevx $
Since: 1.0
Located at util/LogFile.inc

Methods summary
`public` | # `__construct( string $path )` The constructor The constructor #### Parameters $path `string` $path #### Since 1.0
`public` | # `setMaxSize( integer $MaxSize )` Set the max log size in megabytes Set the max log size in megabytes #### Parameters $MaxSize `integer` $MaxSize #### Since 1.0
`public` | # `setSeperator( string $seperator )` Set the value seperator Set the value seperator #### Parameters $seperator `string` $seperator #### Since 1.0
`public` | # `writeLine( mixed $line )` Writes a line of data to the log file Writes a line of data to the log file $param array $line #### Since 1.0
`private float` | # `checkFileSize( )` Returns the size in megabytes of the log file on disc Returns the size in megabytes of the log file on disc #### Returns `float` #### Since 1.0
`private` | # `backupFile( )` Creates a backup of the log file, which has the same file name and location as the current file plus a timestamp appended Creates a backup of the log file, which has the same file name and location as the current file plus a timestamp appended #### Since 1.0
`public` | # `renderLog( mixed $cols )` Renders a log file as a HTML table Renders a log file as a HTML table $param array $cols The headings to use when rendering the log file #### Since 1.0

Properties summary
`private string` | $path | `` | # The log file path The log file path #### Since 1.0
`private array` | $columnHeadings | `` | # An array of column headers use when rendering the log file An array of column headers use when rendering the log file #### Since 1.0
`private string` | $seperator | `'|'` | # The value seperator to use in the file (default is a pipe) The value seperator to use in the file (default is a pipe) #### Since 1.0
`private integer` | $MaxSize | `5` | # The maximum size of the log file in megabytes before a backup is created and a new file is created, default is 5 The maximum size of the log file in megabytes before a backup is created and a new file is created, default is 5 #### Since 1.0