[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/interwiki/ -> Interwiki.php (summary)

Interwiki table entry. 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.

File Size: 476 lines (12 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

Interwiki:: (18 methods):
  __construct()
  isValidInterwiki()
  fetch()
  getInterwikiCached()
  getInterwikiCacheEntry()
  load()
  loadFromArray()
  getAllPrefixesCached()
  getAllPrefixesDB()
  getAllPrefixes()
  getURL()
  getAPI()
  getWikiID()
  isLocal()
  isTranscludable()
  getName()
  getDescription()
  selectFields()


Class: Interwiki  - X-Ref

The interwiki class
All information is loaded on creation when called by Interwiki::fetch( $prefix ).
All work is done on slave, because this should *never* change (except during
schema updates etc, which aren't wiki-related)

__construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0,$trans = 0)   X-Ref
No description

isValidInterwiki( $prefix )   X-Ref
Check whether an interwiki prefix exists

param: string $prefix Interwiki prefix to use
return: bool Whether it exists

fetch( $prefix )   X-Ref
Fetch an Interwiki object

param: string $prefix Interwiki prefix to use
return: Interwiki|null|bool

getInterwikiCached( $prefix )   X-Ref
Fetch interwiki prefix data from local cache in constant database.

param: string $prefix Interwiki prefix
return: Interwiki

getInterwikiCacheEntry( $prefix )   X-Ref
Get entry from interwiki cache

param: string $prefix Database key
return: string The interwiki entry

load( $prefix )   X-Ref
Load the interwiki, trying first memcached then the DB

param: string $prefix The interwiki prefix
return: Interwiki|bool Interwiki if $prefix is valid, otherwise false

loadFromArray( $mc )   X-Ref
Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)

param: array $mc Associative array: row from the interwiki table
return: Interwiki|bool Interwiki object or false if $mc['iw_url'] is not set

getAllPrefixesCached( $local )   X-Ref
Fetch all interwiki prefixes from interwiki cache

param: null|string $local If not null, limits output to local/non-local interwikis
return: array List of prefixes

getAllPrefixesDB( $local )   X-Ref
Fetch all interwiki prefixes from DB

param: string|null $local If not null, limits output to local/non-local interwikis
return: array List of prefixes

getAllPrefixes( $local = null )   X-Ref
Returns all interwiki prefixes

param: string|null $local If set, limits output to local/non-local interwikis
return: array List of prefixes

getURL( $title = null )   X-Ref
Get the URL for a particular title (or with $1 if no title given)

param: string $title What text to put for the article name
return: string The URL

getAPI()   X-Ref
Get the API URL for this wiki

return: string The URL

getWikiID()   X-Ref
Get the DB name for this wiki

return: string The DB name

isLocal()   X-Ref
Is this a local link from a sister project, or is
it something outside, like Google

return: bool

isTranscludable()   X-Ref
Can pages from this wiki be transcluded?
Still requires $wgEnableScaryTransclusion

return: bool

getName()   X-Ref
Get the name for the interwiki site

return: string

getDescription()   X-Ref
Get a description for this interwiki

return: string

selectFields()   X-Ref
Return the list of interwiki fields that should be selected to create
a new Interwiki object.

return: string[]



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