raise timeout for CdbTest::testCdb()
[lhc/web/wiklou.git] / includes / api / ApiFormatJson.php
index ec23968..19c5e5f 100644 (file)
@@ -1,12 +1,10 @@
 <?php
-
-
-/*
- * Created on Sep 19, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Created on Sep 19, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@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
  *
  * 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.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ("ApiFormatBase.php");
-}
-
+/**
+ * API JSON output formatter
+ * @ingroup API
+ */
 class ApiFormatJson extends ApiFormatBase {
 
-       public function __construct($main, $format) {
-               parent :: __construct($main, $format);
+       private $mIsRaw;
+
+       public function __construct( $main, $format ) {
+               parent::__construct( $main, $format );
+               $this->mIsRaw = ( $format === 'rawfm' );
        }
 
-       public function GetMimeType() {
+       public function getMimeType() {
+               $params = $this->extractRequestParams();
+               // callback:
+               if ( $params['callback'] ) {
+                       return 'text/javascript';
+               }
                return 'application/json';
        }
 
-       public function Execute() {
-               require_once ('ApiFormatJson_json.php');
-               $json = new Services_JSON();
-               $this->PrintText( $json->encode( $this->GetResult()->GetData(), true ));
+       public function getNeedsRawData() {
+               return $this->mIsRaw;
+       }
+
+       public function getWantsHelp() {
+               // Help is always ugly in JSON
+               return false;
+       }
+
+       public function execute() {
+               $prefix = $suffix = '';
+
+               $params = $this->extractRequestParams();
+               $callback = $params['callback'];
+               if ( !is_null( $callback ) ) {
+                       $prefix = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $callback ) . '(';
+                       $suffix = ')';
+               }
+               $this->printText(
+                       $prefix .
+                       FormatJson::encode( $this->getResultData(), $this->getIsHtml() ) .
+                       $suffix
+               );
+       }
+
+       public function getAllowedParams() {
+               return array(
+                       'callback'  => null,
+               );
+       }
+
+       public function getParamDescription() {
+               return array(
+                       'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
+               );
        }
 
-       protected function GetDescription() {
-               return 'Output data in JSON format';
+       public function getDescription() {
+               if ( $this->mIsRaw ) {
+                       return 'Output data with the debuging elements in JSON format' . parent::getDescription();
+               } else {
+                       return 'Output data in JSON format' . parent::getDescription();
+               }
        }
 }
-?>
\ No newline at end of file