antragsbot 0.5.1
http://antragsbot.sf.net
Public Member Functions | Public Attributes

Wikimate Class Reference

List of all members.

Public Member Functions

 __construct ()
 debugCurlConfig ($echo=false)
 edit ($array)
 getPage ($title)
 query ($array)
 setDebugMode ($b)

Public Attributes

const SECTIONLIST_BY_INDEX = 2
const SECTIONLIST_BY_NAME = 1

Detailed Description

Provides an interface over wiki api objects such as pages Logs into the wiki on construction

Author:
Robert McLeod
Since:
December 2010
Version:
0.4.7

Constructor & Destructor Documentation

Wikimate::__construct ( )

Creates a curl object and logs in If it can't login the class will exit and return null


Member Function Documentation

Wikimate::debugCurlConfig ( echo = false)

Either return or print the curl settings.

Parameters:
boolean$echoTrue to echo the configuration
Returns:
mixed Array of config if $echo is false, (boolean)true if echo is true
Wikimate::edit ( array)

Perfoms an edit query to the wiki api

Parameters:
array$arrayarray of details to be passed in the query
Returns:
array unserialized php output from the wiki
Wikimate::getPage ( title)

Returns a WikiPage object populated with the page data

Parameters:
string$titleThe name of the wiki article
Returns:
WikiPage the page object
Wikimate::query ( array)

Performs a query to the wiki api with the given details

Parameters:
array$arrayarray of details to be passed in the query
Returns:
array unserialized php output from the wiki
Wikimate::setDebugMode ( b)

Sets the debug mode

Parameters:
boolean$debugModetrue to turn debugging on
Returns:
Wikimate this object

Member Data Documentation


The documentation for this class was generated from the following file:
All Classes Files Functions Variables Enumerations