summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/ManualEntryLogger.php
blob: a8e92649c6dd36fa4700f3ac21eb9a2d0379a170 (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
75
76
77
78
79
80
81
82
83
84
85
<?php

namespace SMW\MediaWiki;

use LogEntry;
use ManualLogEntry;
use Title;
use User;

/**
 * @license GNU GPL v2+
 * @since 2.1
 *
 * @author mwjames
 */
class ManualEntryLogger {

	/**
	 * @var logEntry
	 */
	private $logEntry = null;

	/**
	 * @var array
	 */
	private $eventTypes = [];

	/**
	 * @since 2.4
	 *
	 * @param LogEntry|null $logEntry
	 */
	public function __construct( LogEntry $logEntry = null ) {
		$this->logEntry = $logEntry;
	}

	/**
	 * @since 2.4
	 *
	 * @param string $eventTypes
	 */
	public function registerLoggableEventType( $eventType ) {
		$this->eventTypes[$eventType] = true;
	}

	/**
	 * @since 2.1
	 *
	 * @param string $type
	 * @param string $performer
	 * @param string $target
	 * @param string $comment
	 *
	 * @return integer|null
	 */
	public function log( $type, $performer, $target, $comment ) {

		if ( !isset( $this->eventTypes[$type] ) || !$this->eventTypes[$type] ) {
			return null;
		}

		$logEntry = $this->newManualLogEntryForType( $type );
		$logEntry->setTarget( Title::newFromText( $target ) );

		if ( is_string( $performer) ) {
			$performer = User::newFromName( $performer );
		}

		$logEntry->setPerformer( $performer );
		$logEntry->setParameters( [] );
		$logEntry->setComment( $comment );

		return $logEntry->insert();
	}

	protected function newManualLogEntryForType( $type ) {

		if ( $this->logEntry !== null ) {
			return $this->logEntry;
		}

		return new ManualLogEntry( 'smw', $type );
	}

}