Source

VersionControl_Hg / Trunk / Documentation / API / Html / Hg / Command / VersionControl_Hg_Command_Log.html

The default branch has multiple heads

  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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class VersionControl_Hg_Command_Log</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class VersionControl_Hg_Command_Log</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
                <p class="implements">
            Implements interfaces:
            <ul>
                <li><a href="../../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></li>            </ul>
        </p>
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Implements the log command.</p>
<p class="description"><p>The hg command-line client also uses 'history' as an alias.  * <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-inc">include_once&nbsp;</span><span class="src-str">'VersionControl/Hg.php'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span><span class="src-sym">(</span><span class="src-str">'/path/to/repository'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-str">'verbose'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Show only log entries for the following dates:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodon">on</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodbefore">before</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodafter">after</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodbetween">between</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'2010-12-31'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Show only log entries for revision 2:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodrevision">revision</a><span class="src-sym">(</span><span class="src-str">'2'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodformat">format</a><span class="src-sym">(</span><span class="src-str">'raw'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-str">'verbose'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodrevision">revision</a><span class="src-sym">(</span><span class="src-str">'2'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-str">'verbose'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Show only log entries for specific files:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodfiles">files</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'index.php'</span><span class="src-sym">))</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Exclude log entries for certain files:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodexcluding">excluding</a><span class="src-sym">(</span><span class="src-str">'**.php'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>This displays nothing; excluding takes precedence. Remove excluding() to  get only index.php:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodfiles">files</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'index.php'</span><span class="src-sym">))</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodexcluding">excluding</a><span class="src-sym">(</span><span class="src-str">'**.php'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Include specific files, which might not show up otherwise. Using this with  files can lead to unexpected results:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodincluding">including</a><span class="src-sym">(</span><span class="src-str">'**.php'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>Patching and diffing options are not available in this class as they might  be when using the command line Mercurial client.</p><p>PHP version 5</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Michael Gatto &lt;<a href="mailto:mgatto@lisantra.com">mgatto@lisantra.com</a>&gt;</li>
				<li><span class="field">copyright:</span> 2011 Lisantra Technologies, LLC</li>
				<li><span class="field">link:</span> <a href="http://pear.php.net/package/VersionControl_Hg">http://pear.php.net/package/VersionControl_Hg</a></li>
				<li><span class="field">example:</span> <a href="../../__examplesource/exsource_pment__Webroot_Trunk_Tests_Functional_test_Log.php_2e12c79f6a4bbd6976f0b2eb6b2d7413.html">Some examples to use</a></li>
				<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">MIT License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Hg---Command---Log.php.html">/Hg/Command/Log.php</a> (line <span class="field">92</span>)
		</p>
		
				
		<pre><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html">VersionControl_Hg_Command_Abstract</a>
   |
   --VersionControl_Hg_Command_Log</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$allowed_options" title="details" class="var-name">$allowed_options</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$command" title="details" class="var-name">$command</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$required_options" title="details" class="var-name">$required_options</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$template" title="details" class="var-name">$template</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																				
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
										<a href="#after" title="details" class="method-name">after</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
										<a href="#before" title="details" class="method-name">before</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
										<a href="#between" title="details" class="method-name">between</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#copied" title="details" class="method-name">copied</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#execute" title="details" class="method-name">execute</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#files" title="details" class="method-name">files</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$files</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
										<a href="#on" title="details" class="method-name">on</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#removed" title="details" class="method-name">removed</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#revision" title="details" class="method-name">revision</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$revision</span> = <span class="var-default">'tip'</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$allowed_options" id="$allowed_options"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$allowed_options</span>
			 = <span class="var-default">array(<br />        'follow' =&gt; null,<br />        'at' =&gt; null,<br />        'on' =&gt; null,<br />        'between' =&gt; null,<br />        'files' =&gt; null, // implement with search_for() / searchFor / search<br />        'keyword' =&gt; null,<br />        'limit' =&gt; null,<br />        'branch' =&gt; null, //or should we force a branch selection first?<br />        'copies' =&gt; null, //show copied files<br />        'removed' =&gt; null, //show removed files<br />        'date' =&gt; null,<br />        'rev' =&gt; null,<br />    )</span>			(line <span class="line-number">132</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Allowed options for this specific command</p>
<p class="description"><p>The actual option must be the key, while 'null' is a value here to  accommodate the current implementation of setting options.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$command" id="$command"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$command</span>
			 = <span class="var-default"> 'log'</span>			(line <span class="line-number">101</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The name of the mercurial command implemented here</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$required_options" id="$required_options"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$required_options</span>
			 = <span class="var-default">array(<br />        'noninteractive' =&gt; null,<br />        'repository' =&gt; null,<br />        'template' =&gt; null,<br />    )</span>			(line <span class="line-number">118</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Required options for this specific command</p>
<p class="description"><p>These may not be required by Mercurial itself, but are required for the  proper functioning of VersionControl_Hg.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$required_options">VersionControl_Hg_Command_Abstract::$required_options</a></dt>
						<dd>Required options this command needs</dd>
					</dl>
		
		

</div>
<a name="var$template" id="$template"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$template</span>
			 = <span class="var-default"> '{rev}##{branch}##{files}##{date}##{author}##{desc}\r\n'</span>			(line <span class="line-number">108</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template which Mercurial uses to ouput data</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html">VersionControl_Hg_Command_Abstract</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$command_string">VersionControl_Hg_Command_Abstract::$command_string</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$global_options">VersionControl_Hg_Command_Abstract::$global_options</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$hg">VersionControl_Hg_Command_Abstract::$hg</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$optional_options">VersionControl_Hg_Command_Abstract::$optional_options</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$options">VersionControl_Hg_Command_Abstract::$options</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$output">VersionControl_Hg_Command_Abstract::$output</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$output_format">VersionControl_Hg_Command_Abstract::$output_format</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$status">VersionControl_Hg_Command_Abstract::$status</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#var$valid_options">VersionControl_Hg_Command_Abstract::$valid_options</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">155</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$params</span><span class="var-description">: One or more parameters for the command</span>			</li>
					<li>
				<span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>
				<span class="var-name">$hg</span><span class="var-description">: Instance of the base object</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#method__construct">VersionControl_Hg_Command_Abstract::__construct()</a></dt>
						<dd>Class constructors must be redefined in each Command parent class,  since it must have its dependencies for $hg injected.</dd>
					</dl>
			
	</div>
<a name="methodafter" id="after"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">after</span> (line <span class="line-number">354</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts the log to changesets only commited after $date</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodafter">after</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
		<span class="method-name">
			after
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: Show log entries only after this date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbefore" id="before"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">before</span> (line <span class="line-number">333</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts the log to changesets only commited before $date</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line">&nbsp;*&nbsp;<span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodbefore">before</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
		<span class="method-name">
			before
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: Show log entries only before this date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbetween" id="between"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">between</span> (line <span class="line-number">375</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts log output to changesets between dates $from and $to</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodbetween">between</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'2010-12-31'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
		<span class="method-name">
			between
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$from</span><span class="var-description">: Show log entries from this date forward</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$to</span><span class="var-description">: Show log entries only before this date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcopied" id="copied"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">copied</span> (line <span class="line-number">272</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns only files copied within the working copy</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodcopied">copied</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div>  or  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-str">'copied'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			copied
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">execute</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute the command and return the results.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			execute
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$params</span><span class="var-description">: Options passed to the Log command</span>			</li>
					<li>
				<span class="var-type"><a href="../../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>
				<span class="var-name">$hg</span><span class="var-description">: Instance of the base object</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../../Hg/Command/VersionControl_Hg_Command_Interface.html#methodexecute">VersionControl_Hg_Command_Interface::execute()</a></dt>
						<dd>Main method encapsulating the logic to run the command</dd>
					</dl>
			
	</div>
<a name="methodfiles" id="files"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">files</span> (line <span class="line-number">294</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List status information for only the files specified.</p>
<p class="description"><p>VersionControl_Hg_Command_Abstract::formatOptions will automatically  make this the last option since a files list must be the last item on  the command line.</p><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodfiles">files</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'index.php'</span><span class="src-sym">))</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div>  or  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'files'&nbsp;</span>=&gt;&nbsp;<span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'index.php'</span><span class="src-sym">)))</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			files
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$files</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$files</span><span class="var-description">: the list of files as a simple array</span>			</li>
				</ul>
		
			
	</div>
<a name="methodon" id="on"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">on</span> (line <span class="line-number">312</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts the log to changesets only commited on $date</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodon">on</a><span class="src-sym">(</span><span class="src-str">'Dec&nbsp;27,&nbsp;2010'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html">VersionControl_Hg_Command_Log</a></span>
		<span class="method-name">
			on
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: Show log entries only for this exact date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoved" id="removed"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removed</span> (line <span class="line-number">256</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns only files which have been removed from the working copy  and are no longer tracked by Mercurial.</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodremoved">removed</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div>  or  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-str">'removed'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			removed
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodrevision" id="revision"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">revision</span> (line <span class="line-number">224</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Specified the revision to restrict the log operation to</p>
<p class="description"><p>Usage:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-str">'all'</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><a href="../../Hg/Command/VersionControl_Hg_Command_Log.html#methodrevision">revision</a><span class="src-sym">(</span><span class="src-num">7</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div>  or  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$hg</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/log">log</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'revision'&nbsp;</span>=&gt;&nbsp;<span class="src-num">7&nbsp;</span><span class="src-sym">))</span><span class="src-sym">-&gt;</span><span class="src-id">all</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			revision
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$revision</span> = <span class="var-default">'tip'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$revision</span><span class="var-description">: The revision for which to show the log for</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html">VersionControl_Hg_Command_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#method__construct">VersionControl_Hg_Command_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodaddOption">VersionControl_Hg_Command_Abstract::addOption()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodaddOptions">VersionControl_Hg_Command_Abstract::addOptions()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodchangeset">VersionControl_Hg_Command_Abstract::changeset()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodexcluding">VersionControl_Hg_Command_Abstract::excluding()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodformat">VersionControl_Hg_Command_Abstract::format()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodformatOptions">VersionControl_Hg_Command_Abstract::formatOptions()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodgetCommandString">VersionControl_Hg_Command_Abstract::getCommandString()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodgetOption">VersionControl_Hg_Command_Abstract::getOption()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodgetOptions">VersionControl_Hg_Command_Abstract::getOptions()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodincluding">VersionControl_Hg_Command_Abstract::including()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodparseOutput">VersionControl_Hg_Command_Abstract::parseOutput()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodsetCommandString">VersionControl_Hg_Command_Abstract::setCommandString()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodsetOptions">VersionControl_Hg_Command_Abstract::setOptions()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#methodunsetOption">VersionControl_Hg_Command_Abstract::unsetOption()</a></span><br>
													<span class="method-name"><a href="../../Hg/Command/VersionControl_Hg_Command_Abstract.html#method__call">VersionControl_Hg_Command_Abstract::__call()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Mon, 27 Jun 2011 14:22:54 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>