wiki.techinc.nl/includes/api/ApiQuerySiteinfo.php

<?php


/*
 * Created on Sep 25, 2006
 *
 * API for MediaWiki 1.8+
 *
 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
 *
 * 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.,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 * http://www.gnu.org/copyleft/gpl.html
 */

if (!defined('MEDIAWIKI')) {
	// Eclipse helper - will be ignored in production
	require_once ("ApiQueryBase.php");
}

class ApiQuerySiteinfo extends ApiQueryBase {

	public function __construct($main, $query, $moduleName, $data) {
		parent :: __construct($main, $query, $moduleName, $data);
	}

	public function Execute() {
		$siprop = null;
		extract($this->ExtractRequestParams());

		foreach ($siprop as $prop) {
			switch ($prop) {

				case 'general' :

					global $wgSitename, $wgVersion, $wgCapitalLinks;
					$data = array ();
					$mainPage = Title :: newFromText(wfMsgForContent('mainpage'));
					$data['mainpage'] = $mainPage->getText();
					$data['base'] = $mainPage->getFullUrl();
					$data['sitename'] = $wgSitename;
					$data['generator'] = "MediaWiki $wgVersion";
					$data['case'] = $wgCapitalLinks ? 'first-letter' : 'case-sensitive'; // "case-insensitive" option is reserved for future
					$this->GetResult()->AddMessage('query', $prop, $data);
					break;

				case 'namespaces' :

					global $wgContLang;
					$data = array ();
					$data['_element'] = 'ns';
					foreach ($wgContLang->getFormattedNamespaces() as $ns => $title)
						$data[$ns] = array (
							'id' => $ns,
							'*' => $title
						);
					$this->GetResult()->AddMessage('query', $prop, $data);
					break;

				default :
					$this->DieDebug("Unknown siprop=$prop");
			}
		}
	}

	protected function GetAllowedParams() {
		return array (
			'siprop' => array (
				GN_ENUM_DFLT => 'general',
				GN_ENUM_ISMULTI => true,
				GN_ENUM_TYPE => array (
					'general',
					'namespaces'
				)
			)
		);
	}

	protected function GetParamDescription() {
		return array (
			'siprop' => array (
				'Which sysinfo properties to get:',
				' "general"    - Overall system information',
				' "namespaces" - List of registered namespaces (localized)'
			)
		);
	}

	protected function GetDescription() {
		return 'Return general information about the site.';
	}

	protected function GetExamples() {
		return 'api.php?action=query&meta=siteinfo&siprop=general|namespaces';
	}
}
?>