PHP Класс Wikimate, Wikimate

Автор: Robert McLeod

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$api
$debugMode
$error
$password
$session	Requests_Session
$useragent
$username

Открытые методы

Метод	Описание
__construct ( $api ) : Wikimate	Create a new Wikimate object.
debugCurlConfig ( boolean $echo = false ) : mixed	Used to return or print the curl settings, but now prints an error and returns Wikimate::debugRequestsConfig().
debugRequestsConfig ( boolean $echo = false ) : boolean	Get or print the Requests configuration.
delete ( array $array ) : array	Perfoms a delete query to the wiki API.
download ( string $url ) : mixed	Downloads data from the given URL.
edit ( array $array ) : array	Perfoms an edit query to the wiki API.
getError ( ) : mixed	Returns the latest error if there is one.
getFile ( string $filename ) : WikiFile	Returns a WikiFile object populated with the file data.
getPage ( string $title ) : WikiPage	Returns a WikiPage object populated with the page data.
login ( string $username, string $password, string $domain = null ) : boolean	Logs in to the wiki.
parse ( array $array ) : array	Performs a parse query to the wiki API.
query ( array $array ) : array	Performs a query to the wiki API with the given details.
setDebugMode ( boolean $b ) : Wikimate	Sets the debug mode.
upload ( array $array ) : array	Uploads a file to the wiki API.

Защищенные методы

Метод	Описание
initRequests ( ) : void	Set up a Requests_Session with appropriate user agent.

Описание методов

__construct() публичный Метод

Create a new Wikimate object.

public __construct ( $api ) : Wikimate
Результат	Wikimate

debugCurlConfig() публичный Метод

Used to return or print the curl settings, but now prints an error and returns Wikimate::debugRequestsConfig().

Устаревший: Since version 0.10.0

public debugCurlConfig ( boolean $echo = false ) : mixed
$echo	boolean	True to echo the configuration
Результат	mixed	Array of config if $echo is false, (boolean) true if echo is true

debugRequestsConfig() публичный Метод

Get or print the Requests configuration.

public debugRequestsConfig ( boolean $echo = false ) : boolean
$echo	boolean	Whether to echo the options
Результат	boolean	Options if $echo is false

delete() публичный Метод

Perfoms a delete query to the wiki API.

public delete ( array $array ) : array
$array	array	Array of details to be passed in the query
Результат	array	Unserialized php output from the wiki API

download() публичный Метод

Downloads data from the given URL.

public download ( string $url ) : mixed
$url	string	The URL to download from
Результат	mixed	The downloaded data (string), or null if error

edit() публичный Метод

Perfoms an edit query to the wiki API.

public edit ( array $array ) : array
$array	array	Array of details to be passed in the query
Результат	array	Unserialized php output from the wiki API

getError() публичный Метод

Returns the latest error if there is one.

public getError ( ) : mixed
Результат	mixed	The error array, or null if no error

getFile() публичный Метод

Returns a WikiFile object populated with the file data.

public getFile ( string $filename ) : WikiFile
$filename	string	The name of the wiki file
Результат	WikiFile	The file object

getPage() публичный Метод

Returns a WikiPage object populated with the page data.

public getPage ( string $title ) : WikiPage
$title	string	The name of the wiki article
Результат	WikiPage	The page object

initRequests() защищенный Метод

Set up a Requests_Session with appropriate user agent.

protected initRequests ( ) : void
Результат	void

login() публичный Метод

Logs in to the wiki.

public login ( string $username, string $password, string $domain = null ) : boolean
$username	string	The user name
$password	string	The user password
$domain	string	The domain (optional)
Результат	boolean	True if logged in

parse() публичный Метод

Performs a parse query to the wiki API.

public parse ( array $array ) : array
$array	array	Array of details to be passed in the query
Результат	array	Unserialized php output from the wiki API

query() публичный Метод

Performs a query to the wiki API with the given details.

public query ( array $array ) : array
$array	array	Array of details to be passed in the query
Результат	array	Unserialized php output from the wiki API

setDebugMode() публичный Метод

Sets the debug mode.

public setDebugMode ( boolean $b ) : Wikimate
$b	boolean	True to turn debugging on
Результат	Wikimate	This object

upload() публичный Метод

Uploads a file to the wiki API.

public upload ( array $array ) : array
$array	array	Array of details to be used in the upload
Результат	array	Unserialized php output from the wiki API

Описание свойств

$api защищенное свойство

protected $api

$debugMode защищенное свойство

protected $debugMode

$error защищенное свойство

protected $error

$password защищенное свойство

protected $password

$session защищенное свойство

protected Requests_Session $session
Результат	Requests_Session

$useragent защищенное свойство

protected $useragent

$username защищенное свойство

protected $username