API


Classes

class  ApiBase
 This abstract class implements many basic API functions, and is the base of all API classes. More...
class  ApiBlock
 API module that facilitates the blocking of users. More...
class  ApiDelete
 API module that facilitates deleting pages. More...
class  ApiDisabled
 API module that dies with an error immediately. More...
class  ApiEditPage
 A module that allows for editing and creating pages. More...
class  ApiEmailUser
class  ApiExpandTemplates
 API module that functions as a shortcut to the wikitext preprocessor. More...
class  ApiFeedWatchlist
 This action allows users to get their watchlist items in RSS/Atom formats. More...
class  ApiFormatBase
 This is the abstract base class for API formatters. More...
class  ApiFormatFeedWrapper
 This printer is used to wrap an instance of the Feed class. More...
class  ApiFormatDbg
class  ApiFormatJson
class  Services_JSON
 Converts to and from JSON format. More...
class  Services_JSON_Error
class  ApiFormatPhp
class  ApiFormatRaw
 Formatter that spits out anything you like with any desired MIME type. More...
class  ApiFormatTxt
class  ApiFormatWddx
class  ApiFormatXml
class  ApiFormatYaml
class  Spyc
 Spyc -- A Simple PHP YAML Class. More...
class  ApiHelp
 This is a simple class to handle action=help. More...
class  ApiImport
 API module that imports an XML file like Special:Import does. More...
class  ApiImportReporter
 Import reporter for the API. More...
class  ApiLogin
 Unit to authenticate log-in attempts to the current wiki. More...
class  ApiLogout
 API module to allow users to log out of the wiki. More...
class  ApiMain
 This is the main API class, used for both external and internal processing. More...
class  UsageException
 This exception will be thrown when dieUsage is called to stop module execution. More...
class  ApiMove
class  ApiOpenSearch
class  ApiPageSet
 This class contains a list of pages that the client has requested. More...
class  ApiParamInfo
class  ApiParse
class  ApiPatrol
 Allows user to patrol pages. More...
class  ApiProtect
class  ApiPurge
 API interface for page purging. More...
class  ApiQuery
 This is the main query class. More...
class  ApiQueryAllCategories
 Query module to enumerate all categories, even the ones that don't have category pages. More...
class  ApiQueryAllimages
 Query module to enumerate all available pages. More...
class  ApiQueryAllLinks
 Query module to enumerate links from all pages together. More...
class  ApiQueryAllmessages
 A query action to return messages from site message cache. More...
class  ApiQueryAllpages
 Query module to enumerate all available pages. More...
class  ApiQueryAllUsers
 Query module to enumerate all registered users. More...
class  ApiQueryBacklinks
 This is a three-in-one module to query: * backlinks - links pointing to the given page, * embeddedin - what pages transclude the given page within themselves, * imageusage - what pages use the given image. More...
class  ApiQueryBase
 This is a base class for all Query modules. More...
class  ApiQueryGeneratorBase
class  ApiQueryBlocks
 Query module to enumerate all available pages. More...
class  ApiQueryCategories
 A query module to enumerate categories the set of pages belong to. More...
class  ApiQueryCategoryInfo
 This query adds the <categories> subelement to all pages with the list of categories the page is in. More...
class  ApiQueryCategoryMembers
 A query module to enumerate pages that belong to a category. More...
class  ApiQueryDeletedrevs
 Query module to enumerate all available pages. More...
class  ApiQueryDisabled
 API module that does nothing. More...
class  ApiQueryDuplicateFiles
 A query module to list duplicates of the given file(s). More...
class  ApiQueryExternalLinks
 A query module to list all external URLs found on a given set of pages. More...
class  ApiQueryExtLinksUsage
class  ApiQueryImageInfo
 A query action to get image information and upload history. More...
class  ApiQueryImages
 This query adds an <images> subelement to all pages with the list of images embedded into those pages. More...
class  ApiQueryInfo
 A query module to show basic page information. More...
class  ApiQueryLangLinks
 A query module to list all langlinks (links to correspanding foreign language pages). More...
class  ApiQueryLinks
 A query module to list all wiki links on a given set of pages. More...
class  ApiQueryLogEvents
 Query action to List the log events, with optional filtering by various parameters. More...
class  ApiQueryProtectedTitles
 Query module to enumerate all create-protected pages. More...
class  ApiQueryRandom
 Query module to get list of random pages. More...
class  ApiQueryRecentChanges
 A query action to enumerate the recent changes that were done to the wiki. More...
class  ApiQueryRevisions
 A query action to enumerate revisions of a given page, or show top revisions of multiple pages. More...
class  ApiQuerySearch
 Query module to perform full text search within wiki titles and content. More...
class  ApiQuerySiteinfo
 A query action to return meta information about the wiki site. More...
class  ApiQueryContributions
 This query action adds a list of a specified user's contributions to the output. More...
class  ApiQueryUserInfo
 Query module to get information about the currently logged-in user. More...
class  ApiQueryUsers
 Query module to get information about a list of users. More...
class  ApiQueryWatchlist
 This query action allows clients to retrieve a list of recently modified pages that are part of the logged-in user's watchlist. More...
class  ApiQueryWatchlistRaw
 This query action allows clients to retrieve a list of pages on the logged-in user's watchlist. More...
class  ApiResult
 This class represents the result of the API operations. More...
class  ApiRollback
class  ApiUnblock
 API module that facilitates the unblocking of users. More...
class  ApiUndelete
class  ApiWatch
 API module to allow users to watch a page. More...

Enumerations

enum  SERVICES_JSON_SLICE
 Converts to and from JSON format. More...

Enumeration Type Documentation

Converts to and from JSON format.

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. This feature can also be found in Python. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, TCL, and many others. These properties make JSON an ideal data-interchange language.

This package provides a simple encoder and decoder for JSON notation. It is intended for use with client-side Javascript applications that make use of HTTPRequest to perform server communication functions - data can be encoded into JSON notation for use in a client-side javascript, or decoded from incoming Javascript requests. JSON format is native to Javascript, and can be directly eval()'ed with no further parsing overhead

All strings should be in ASCII or UTF-8 format!

LICENSE: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author:
Michal Migurski <mike-json@teczno.com>

Matt Knapp <mdknapp[at]gmail[dot]com>

Brett Stimmerman <brettstimmerman[at]gmail[dot]com> 2005 Michal Migurski

Version:
CVS:
Id
ApiFormatJson_json.php 45765 2009-01-15 10:18:44Z catrope
http://www.opensource.org/licenses/bsd-license.php
See also:
http://pear.php.net/pepr/pepr-proposal-show.php?id=198 Marker constant for Services_JSON::decode(), used to flag stack state

Definition at line 61 of file ApiFormatJson_json.php.


Generated on Sat Sep 5 02:08:28 2009 for MediaWiki by  doxygen 1.5.9