Log_sqlite Class Reference

Inheritance diagram for Log_sqlite:

Collaboration diagram for Log_sqlite:

Public Member Functions
	Log_sqlite ($name, $ident= '', &$conf, $level=PEAR_LOG_DEBUG)
	Constructs a new sql logging object.
	open ()
	Opens a connection to the database, if it has not already been opened.
	close ()
	Closes the connection to the database if it is still open and we were the ones that opened it.
	log ($message, $priority=null)
	Inserts $message to the currently open database.
	_createTable ()
	Checks whether the log table exists and creates it if necessary.
Public Member Functions inherited from Log
	_classExists ($class)
	Utility function which wraps PHP's class_exists() function to ensure consistent behavior between PHP versions 4 and 5.
&	factory ($handler, $name= '', $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a concrete Log instance of type $handler.
&	singleton ($handler, $name= '', $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a reference to a concrete Log instance of type $handler, only creating a new instance if no log instance with the same parameters currently exists.
	flush ()
	Abstract implementation of the flush() method.
	emerg ($message)
	A convenience function for logging a emergency event.
	alert ($message)
	A convenience function for logging an alert event.
	crit ($message)
	A convenience function for logging a critical event.
	err ($message)
	A convenience function for logging a error event.
	warning ($message)
	A convenience function for logging a warning event.
	notice ($message)
	A convenience function for logging a notice event.
	info ($message)
	A convenience function for logging a information event.
	debug ($message)
	A convenience function for logging a debug event.
	_extractMessage ($message)
	Returns the string representation of the message data.
	_getBacktraceVars ($depth)
	Using debug_backtrace(), returns the file, line, and enclosing function name of the source code context from which log() was invoked.
	_format ($format, $timestamp, $priority, $message)
	Produces a formatted log line based on a format string and a set of variables representing the current log record and state.
	priorityToString ($priority)
	Returns the string representation of a PEAR_LOG_* integer constant.
	stringToPriority ($name)
	Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name.
	MASK ($priority)
	Calculate the log mask for the given priority.
	UPTO ($priority)
	Calculate the log mask for all priorities up to the given priority.
	MIN ($priority)
	Calculate the log mask for all priorities greater than or equal to the given priority.
	MAX ($priority)
	Calculate the log mask for all priorities less than or equal to the given priority.
	setMask ($mask)
	Set and return the level mask for the current Log instance.
	getMask ()
	Returns the current level mask.
	_isMasked ($priority)
	Check if the given priority is included in the current level mask.
	getPriority ()
	Returns the current default priority.
	setPriority ($priority)
	Sets the default priority to the specified value.
	attach (&$observer)
	Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance.
	detach ($observer)
	Removes a Log_observer instance from the list of observers.
	_announce ($event)
	Informs each registered observer instance that a new message has been logged.
	isComposite ()
	Indicates whether this is a composite class.
	setIdent ($ident)
	Sets this Log instance's identification string.
	getIdent ()
	Returns the current identification string.

Data Fields
	$_options
	$_db = null
	$_existingConnection = false
	$_table = 'log_table'
Data Fields inherited from Log
	$_opened = false
	$_id = 0
	$_ident = ''
	$_priority = PEAR_LOG_INFO
	$_mask = PEAR_LOG_ALL
	$_listeners = array()
	$_formatMap

Detailed Description

Definition at line 31 of file sqlite.php.

Member Function Documentation

Log_sqlite::_createTable

(

)

Checks whether the log table exists and creates it if necessary.

Returns

boolean True on success or false on failure. private

Definition at line 202 of file sqlite.php.

References $res.

Referenced by open().

    {
        $q = "SELECT name FROM sqlite_master WHERE name='" . $this->_table .
             "' AND type='table'";

        $res = sqlite_query($this->_db, $q);

        if (sqlite_num_rows($res) == 0) {
            $q = 'CREATE TABLE [' . $this->_table . '] (' .
                 'id INTEGER PRIMARY KEY NOT NULL, ' .
                 'logtime NOT NULL, ' .
                 'ident CHAR(16) NOT NULL, ' .
                 'priority INT NOT NULL, ' .
                 'message)';

            if (!($res = sqlite_unbuffered_query($this->_db, $q))) {
                return false;
            }
        }

        return true;
    }

Here is the caller graph for this function:

Log_sqlite::close

(

)

Closes the connection to the database if it is still open and we were the ones that opened it.

It is the caller's responsible to close an existing connection that was passed to us via $conf['db'].

Returns

boolean True on success, false on failure. public

Reimplemented from Log.

Definition at line 132 of file sqlite.php.

    {
        /* We never close existing connections. */
        if ($this->_existingConnection) {
            return false;
        }

        if ($this->_opened) {
            $this->_opened = false;
            sqlite_close($this->_db);
        }

        return ($this->_opened === false);
    }

Log_sqlite::log	(		$message,
			$priority = null
	)

Inserts $message to the currently open database.

Calls open(), if necessary. Also passes the message along to any Log_observer instances that are observing this Log.

Parameters

mixed	$message	String or object containing the message to log.
string	$priority	The priority of the message. Valid values are: PEAR_LOG_EMERG, PEAR_LOG_ALERT, PEAR_LOG_CRIT, PEAR_LOG_ERR, PEAR_LOG_WARNING, PEAR_LOG_NOTICE, PEAR_LOG_INFO, and PEAR_LOG_DEBUG.

Returns

boolean True on success or false on failure. public

Reimplemented from Log.

Definition at line 160 of file sqlite.php.

References Log\$_priority, $res, Log\_announce(), Log\_extractMessage(), Log\_isMasked(), and open().

    {
        /* If a priority hasn't been specified, use the default value. */
        if ($priority === null) {
            $priority = $this->_priority;
        }

        /* Abort early if the priority is above the maximum logging level. */
        if (!$this->_isMasked($priority)) {
            return false;
        }

        /* If the connection isn't open and can't be opened, return failure. */
        if (!$this->_opened && !$this->open()) {
            return false;
        }

        // Extract the string representation of the message.
        $message = $this->_extractMessage($message);

        // Build the SQL query for this log entry insertion.
        $q = sprintf('INSERT INTO [%s] (logtime, ident, priority, message) ' .
                     "VALUES ('%s', '%s', %d, '%s')",
                     $this->_table,
                     strftime('%Y-%m-%d %H:%M:%S', time()),
                     sqlite_escape_string($this->_ident),
                     $priority,
                     sqlite_escape_string($message));
        if (!($res = @sqlite_unbuffered_query($this->_db, $q))) {
            return false;
        }
        $this->_announce(array('priority' => $priority, 'message' => $message));

        return true;
    }

Here is the call graph for this function:

Log_sqlite::Log_sqlite	(		$name,
			$ident = '',
		&	$conf,
			$level = PEAR_LOG_DEBUG
	)

Constructs a new sql logging object.

Parameters

string	$name	The target SQL table.
string	$ident	The identification field.
mixed	$conf	Can be an array of configuration options used to open a new database connection or an already opened sqlite connection.
int	$level	Log messages up to and including this level. public

Definition at line 74 of file sqlite.php.

References Log\UPTO().

    {
        $this->_id = md5(microtime());
        $this->_table = $name;
        $this->_ident = $ident;
        $this->_mask = Log::UPTO($level);

        if (is_array($conf)) {
            foreach ($conf as $k => $opt) {
                $this->_options[$k] = $opt;
            }
        } else {
            // If an existing database connection was provided, use it.
            $this->_db =& $conf;
            $this->_existingConnection = true;
        }
    }

Here is the call graph for this function:

Log_sqlite::open

(

)

Opens a connection to the database, if it has not already been opened.

This is implicitly called by log(), if necessary.

Returns

boolean True on success, false on failure. public

Reimplemented from Log.

Definition at line 99 of file sqlite.php.

References Log\$_opened, and _createTable().

Referenced by log().

    {
        if (is_resource($this->_db)) {
            $this->_opened = true;
            return $this->_createTable();
        } else {
            /* Set the connection function based on the 'persistent' option. */
            if (empty($this->_options['persistent'])) {
                $connectFunction = 'sqlite_open';
            } else {
                $connectFunction = 'sqlite_popen';
            }

            /* Attempt to connect to the database. */
            if ($this->_db = $connectFunction($this->_options['filename'],
                                              (int)$this->_options['mode'],
                                              $error)) {
                $this->_opened = true;
                return $this->_createTable();
            }
        }

        return $this->_opened;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

Log_sqlite::$_db = null

Definition at line 46 of file sqlite.php.

Log_sqlite::$_existingConnection = false

Definition at line 53 of file sqlite.php.

Log_sqlite::$_options

Initial value:

 array('mode'       => 0666,
                          'persistent' => false)

Definition at line 38 of file sqlite.php.

Log_sqlite::$_table = 'log_table'

Definition at line 60 of file sqlite.php.

---

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

• Services/PEAR/lib/Log/sqlite.php