diff options
Diffstat (limited to 'includes/title/ImportTitleFactory.php')
-rw-r--r-- | includes/title/ImportTitleFactory.php | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/includes/title/ImportTitleFactory.php b/includes/title/ImportTitleFactory.php new file mode 100644 index 00000000..629616d8 --- /dev/null +++ b/includes/title/ImportTitleFactory.php @@ -0,0 +1,36 @@ +<?php +/** + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @license GPL 2+ + */ + +/** + * Represents an object that can convert page titles on a foreign wiki + * (ForeignTitle objects) into page titles on the local wiki (Title objects). + */ +interface ImportTitleFactory { + /** + * Determines which local title best corresponds to the given foreign title. + * If such a title can't be found or would be locally invalid, null is + * returned. + * + * @param ForeignTitle $foreignTitle The ForeignTitle to convert + * @return Title|null + */ + public function createTitleFromForeignTitle( ForeignTitle $foreignTitle ); +} |