[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * A title formatter service for %MediaWiki.
   4   *
   5   * This program is free software; you can redistribute it and/or modify
   6   * it under the terms of the GNU General Public License as published by
   7   * the Free Software Foundation; either version 2 of the License, or
   8   * (at your option) any later version.
   9   *
  10   * This program is distributed in the hope that it will be useful,
  11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13   * GNU General Public License for more details.
  14   *
  15   * You should have received a copy of the GNU General Public License along
  16   * with this program; if not, write to the Free Software Foundation, Inc.,
  17   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18   * http://www.gnu.org/copyleft/gpl.html
  19   *
  20   * @file
  21   * @license GPL 2+
  22   * @author Daniel Kinzler
  23   */
  24  
  25  /**
  26   * A title formatter service for MediaWiki.
  27   *
  28   * This is designed to encapsulate knowledge about conventions for the title
  29   * forms to be used in the database, in urls, in wikitext, etc.
  30   *
  31   * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
  32   */
  33  interface TitleFormatter {
  34      /**
  35       * Returns the title formatted for display.
  36       * Per default, this includes the namespace but not the fragment.
  37       *
  38       * @note Normalization is applied if $title is not in TitleValue::TITLE_FORM.
  39       *
  40       * @param int|bool $namespace The namespace ID (or false, if the namespace should be ignored)
  41       * @param string $text The page title
  42       * @param string $fragment The fragment name (may be empty).
  43       *
  44       * @return string
  45       */
  46  	public function formatTitle( $namespace, $text, $fragment = '' );
  47  
  48      /**
  49       * Returns the title text formatted for display, without namespace of fragment.
  50       *
  51       * @note Only minimal normalization is applied. Consider using TitleValue::getText() directly.
  52       *
  53       * @param TitleValue $title The title to format
  54       *
  55       * @return string
  56       */
  57  	public function getText( TitleValue $title );
  58  
  59      /**
  60       * Returns the title formatted for display, including the namespace name.
  61       *
  62       * @param TitleValue $title The title to format
  63       *
  64       * @return string
  65       */
  66  	public function getPrefixedText( TitleValue $title );
  67  
  68      /**
  69       * Returns the title formatted for display, with namespace and fragment.
  70       *
  71       * @param TitleValue $title The title to format
  72       *
  73       * @return string
  74       */
  75  	public function getFullText( TitleValue $title );
  76  
  77      /**
  78       * Returns the name of the namespace for the given title.
  79       *
  80       * @note This must take into account gender sensitive namespace names.
  81       * @todo Move this to a separate interface
  82       *
  83       * @param int $namespace
  84       * @param string $text
  85       *
  86       * @throws InvalidArgumentException
  87       * @return string
  88       */
  89  	public function getNamespaceName( $namespace, $text );
  90  }