OMVLogFile Class Reference

Inheritance diagram for OMVLogFile:

Public Member Functions
	__construct ($id)
	isRegistered ()
	getFileName ()
	getFilePath ()
	getRegex ()
	getColumns ()
Public Member Functions inherited from OMVObject
	__construct ()
	getLastError ()

Static Public Member Functions
static	registerType ($id, $config)

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)
	debug ()

Detailed Description

This file is part of OpenMediaVault.

License:

http://www.gnu.org/licenses/gpl.html GPL Version 3

Author

Volker Theile volke.nosp@m.r.th.nosp@m.eile@.nosp@m.open.nosp@m.media.nosp@m.vaul.nosp@m.t.org

Copyright

Copyright (c) 2009-2014 Volker Theile

OpenMediaVault is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

OpenMediaVault is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with OpenMediaVault. If not, see http://www.gnu.org/licenses/. This class handles log file access and modifications.

Constructor & Destructor Documentation

OMVLogFile::__construct

(

$id

)

Constructor

Parameters

id	The identifier of the log file configuration.

Member Function Documentation

OMVLogFile::getColumns

(

)

Get the column configuration.

OMVLogFile::getFileName

(

)

Get the file name of the log file, e.g. 'syslog'.

Returns

The file name of the log file, otherwise FALSE.

OMVLogFile::getFilePath

(

)

Get the file path of the log file, e.g. '/var/log/syslog'.

Returns

The file path of the log file, otherwise FALSE.

OMVLogFile::getRegex

(

)

Get the regular expression used to parse a log file line.

OMVLogFile::isRegistered

(

)

Checks if a log file type is registered.

Returns

TRUE if the log file type is registered, otherwise FALSE.

static OMVLogFile::registerType (   $id,   $config  )

static

Register a new log file type.

Parameters

id	The identifier of the log file configuration, e.g. syslog or auth.
config	The type configuration.

Returns

None

---

The documentation for this class was generated from the following file:

• log.inc