[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/title/ -> TitleValue.php (summary)

Representation of a page title within %MediaWiki. 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.

Author: Daniel Kinzler
License: GPL 2+
File Size: 161 lines (5 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

TitleValue:: (7 methods):
  __construct()
  getNamespace()
  getFragment()
  getDBkey()
  getText()
  createFragmentTitle()
  __toString()


Class: TitleValue  - X-Ref

Represents a page (or page fragment) title within %MediaWiki.

__construct( $namespace, $dbkey, $fragment = '' )   X-Ref
Constructs a TitleValue.

param: int $namespace The namespace ID. This is not validated.
param: string $dbkey The page title in valid DBkey form. No normalization is applied.
param: string $fragment The fragment title. Use '' to represent the whole page.

getNamespace()   X-Ref

return: int

getFragment()   X-Ref

return: string

getDBkey()   X-Ref
Returns the title's DB key, as supplied to the constructor,
without namespace prefix or fragment.

return: string

getText()   X-Ref
Returns the title in text form,
without namespace prefix or fragment.

This is computed from the DB key by replacing any underscores with spaces.

return: string

createFragmentTitle( $fragment )   X-Ref
Creates a new TitleValue for a different fragment of the same page.

param: string $fragment The fragment name, or "" for the entire page.
return: TitleValue

__toString()   X-Ref
Returns a string representation of the title, for logging. This is purely informative
and must not be used programmatically. Use the appropriate TitleFormatter to generate
the correct string representation for a given use.

return: string



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1