diff options
Diffstat (limited to 'framework/Log/EventLog/structs')
-rw-r--r-- | framework/Log/EventLog/structs/log_filter.php | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/framework/Log/EventLog/structs/log_filter.php b/framework/Log/EventLog/structs/log_filter.php new file mode 100644 index 00000000..451b0c65 --- /dev/null +++ b/framework/Log/EventLog/structs/log_filter.php @@ -0,0 +1,74 @@ +<?php + +/** + * File containing the ezcLogFilter class. + * + * @package EventLog + * @version //autogentag// + * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved. + * @license BSD {@link http://ez.no/licenses/bsd} + */ + +/** + * The ezcLogFilter class provides a structure to set a log filter. + * + * ezcLogFilter has three public member variables: + * - severity, contains the severity of the log message. + * - source, contain the source of the log message. + * - category, contains the category of the log message. + * + * Severity is an integer mask that expects one more multiple ezcLog severity constants. + * Multiple values can be assigned by using a logical-or on the values. The value zero + * represents all possible severities. + * + * Source and category are an array. An empty array reprseents all possible sources + * and categories. + * + * The ezclogFilter class is mainly used by the {@link ezcLog::attach()} and {@link ezcLog::detach()} + * methods. + * + * @package EventLog + * @version //autogentag// + */ +class ezcLogFilter +{ + /** + * The severities that are accepted by the ezcLogFilter. + * + * The default value zero specifies that all severities are accepted. + * + * @var int + */ + public $severity = 0; + + + /** + * The source of the log message. + * + * The default empty array specifies that all sources are accepted by this filter. + * + * @var array(string) + */ + public $source = array(); + + /** + * The category of the log message. + * + * The default empty array specifies that all categories are accepted by this filter. + * + * @var array(string) + */ + public $category = array(); + + + /** + * Empty constructor + */ + public function __construct() + { + } +} + + + +?> |