mediawiki-extensions-Popups/includes/EventLogging/MWEventLogger.php
Piotr Miazga c0052fcb08 Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff
Bug: T168384
Change-Id: I4d4681121df974a8471d7c4c8df8a6158f8df22a
2017-07-13 21:14:29 +02:00

79 lines
1.9 KiB
PHP

<?php
/*
* This file is part of the MediaWiki extension Popups.
*
* Popups is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* Popups is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Popups. If not, see <http://www.gnu.org/licenses/>.
*
* @file
* @ingroup extensions
*/
namespace Popups\EventLogging;
use Config;
use ExtensionRegistry;
class MWEventLogger implements EventLogger {
/**
* @var Config
*/
private $config;
/**
* @var ExtensionRegistry
*/
private $registry;
/**
* Module constructor.
* @param Config $config MediaWiki configuration
* @param ExtensionRegistry $registry MediaWiki extension registry
*/
public function __construct( Config $config, ExtensionRegistry $registry ) {
$this->config = $config;
$this->registry = $registry;
}
/**
* @return bool
*/
public function shouldLog() {
// 1 fully enabled, 0 disabled
$samplingRate = $this->config->get( 'PopupsSchemaSamplingRate' );
if ( $samplingRate == 0 ) {
return false;
}
return (float)wfRandom() <= (float)$samplingRate;
}
/**
* Log event
*
* @param array $event An associative array containing event data
*/
public function log( array $event ) {
if ( !$this->shouldLog() ) {
return;
}
$eventLoggingSchemas = $this->registry->getAttribute( 'EventLoggingSchemas' );
\EventLogging::logEvent(
self::PREVIEWS_SCHEMA_NAME,
$eventLoggingSchemas[ self::PREVIEWS_SCHEMA_NAME ],
$event
);
}
}