1	<?php
2	/**
3	* This program is free software; you can redistribute it and/or modify
4	* it under the terms of the GNU General Public License as published by
5	* the Free Software Foundation; either version 2 of the License, or
6	* (at your option) any later version.
7	*
8	* This program is distributed in the hope that it will be useful,
9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11	* GNU General Public License for more details.
12	*
13	* You should have received a copy of the GNU General Public License along
14	* with this program; if not, write to the Free Software Foundation, Inc.,
15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16	*
17	* @file
18	*/
19
20	namespace MediaWiki\Extension\WikiSEO\Generator;
21
22	use OutputPage;
23
24	/**
25	* Interface for metadata generators
26	*
27	* @package MediaWiki\Extension\WikiSEO\Generator
28	*/
29	interface GeneratorInterface {
30	/**
31	* Initialize the generator with all metadata and the page to output the metadata onto
32	*
33	* @param array $metadata All metadata
34	* @param OutputPage $out The page to add the metadata to
35	*
36	* @return void
37	*/
38	public function init( array $metadata, OutputPage $out ): void;
39
40	/**
41	* Add the metadata to the OutputPage
42	*
43	* @return void
44	*/
45	public function addMetadata(): void;
46
47	/**
48	* The meta tag names allowed by this generator
49	*
50	* @return array
51	*/
52	public function getAllowedParameterNames(): array;
53	}