mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-12-13 08:08:39 +00:00
bffa3178d5
Our documentation generator Doxygen is not able to understand @var tags on constants. A constant is neither a "variable", nor is it possibly to specify an allowed type for a constant. The type of a constant is strictly derived from it's value. There is no way to change it, other than changing the constant itself. There is not much value in repeating the type either. If it's critical to know the type of a constant (which is a very rare situation), that should be better explained in the comment. Doxygen strips all @… tags it does not understand, and renders everything else as a plain string. This makes it possible to use something like: /** * @const Description… */ But this is not different from: /** * Description… */ Change-Id: I4531d4f6b2ab2aca7a62f13f10a655f31c4d6a7a
37 lines
1,022 B
PHP
37 lines
1,022 B
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;
|
|
|
|
interface EventLogger {
|
|
/**
|
|
* Page Previews Event logging schema name
|
|
*/
|
|
const PREVIEWS_SCHEMA_NAME = 'Popups';
|
|
|
|
/**
|
|
* Log event
|
|
*
|
|
* @param array $event An associative array containing event data
|
|
*/
|
|
public function log( array $event );
|
|
|
|
}
|