forked from doctrine/mongodb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LoggableCursor.php
177 lines (159 loc) · 4.78 KB
/
LoggableCursor.php
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?php
/*
* 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
* OWNER 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.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the MIT license. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\MongoDB;
/**
* Wrapper for the MongoCursor class with logging functionality.
*
* @since 1.0
* @author Jonathan H. Wage <jonwage@gmail.com>
*/
class LoggableCursor extends Cursor implements Loggable
{
/**
* The logger callable.
*
* @var callable
*/
protected $loggerCallable;
/**
* @var Logging\QueryLogger
*/
protected $queryLogger;
/**
* Constructor.
*
* @param Collection $collection Collection used to create this Cursor
* @param \MongoCursor $mongoCursor MongoCursor being wrapped
* @param array $query Query criteria
* @param array $fields Selected fields (projection)
* @param integer $numRetries Number of times to retry queries
* @param callable $loggerCallable Logger callable
* @param Logging\QueryLogger $queryLogger QueryLogger object
*/
public function __construct(Collection $collection, \MongoCursor $mongoCursor, array $query, array $fields, $numRetries, $loggerCallable = null, Logging\QueryLogger $queryLogger = null)
{
if ( ! is_callable($loggerCallable) && !($queryLogger instanceof Logging\QueryLogger)) {
throw new \InvalidArgumentException('$loggerCallable must be a valid callback or $queryLogger must be an instance of Doctrine\MongoDB\Logging\QueryLogger');
}
$this->loggerCallable = $loggerCallable;
parent::__construct($collection, $mongoCursor, $query, $fields, $numRetries);
$this->queryLogger = $queryLogger;
}
/**
* Log something using the configured logger callable.
*
* @see Loggable::log()
* @param array $data
*/
public function log(array $data)
{
$data['query'] = $this->query;
$data['fields'] = $this->fields;
if ($this->loggerCallable) {
call_user_func($this->loggerCallable, $data);
}
if ($this->queryLogger instanceof Logging\QueryLogger) {
$this->queryLogger->startQuery($data);
}
}
private function logAfter()
{
if ($this->queryLogger instanceof Logging\QueryLogger) {
$this->queryLogger->stopQuery();
}
}
/**
* Get the logger callable.
*
* @return callable
*/
public function getLoggerCallable()
{
return $this->loggerCallable;
}
/**
* @see Cursor::hint()
*/
public function hint(array $keyPattern)
{
$log = array(
'hint' => true,
'keyPattern' => $keyPattern,
);
$this->log($log);
$data = parent::hint($keyPattern);
$this->logAfter();
return $data;
}
/**
* @see Cursor::limit()
*/
public function limit($num)
{
$log = array(
'limit' => true,
'limitNum' => $num,
);
$this->log($log);
$data = parent::limit($num);
$this->logAfter();
return $data;
}
/**
* @see Cursor::skip()
*/
public function skip($num)
{
$log = array(
'skip' => true,
'skipNum' => $num,
);
$this->log($log);
$data = parent::skip($num);
$this->logAfter();
return $data;
}
/**
* @see Cursor::snapshot()
*/
public function snapshot()
{
$log = array(
'snapshot' => true,
);
$this->log($log);
$data = parent::snapshot();
$this->logAfter();
return $data;
}
/**
* @see Cursor::sort()
*/
public function sort($fields)
{
$log = array(
'sort' => true,
'sortFields' => $fields,
);
$this->log($log);
$data = parent::sort($fields);
$this->logAfter();
return $data;
}
}