summaryrefslogtreecommitdiff
path: root/framework/Log/EventLog/structs/log_filter.php
blob: 451b0c65ca0ac8b77b6e45e6ee7f4c17793fbbca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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()
   {
   }
}



?>