addwiki/mediawiki-api

A MediaWiki API library

3.1.0 2024-10-15 20:46 UTC

Requires

• php: >=8.1
• addwiki/mediawiki-api-base: ^3.1
• addwiki/mediawiki-datamodel: ^3.1

Requires (Dev)

• mediawiki/mediawiki-codesniffer: ~38.0
• php-parallel-lint/php-parallel-lint: ^1.2
• phpunit/phpunit: ~9

GPL-2.0-or-later

• Addshore
• Sam Wilson

• api
• mediawiki

README

Installation

Use composer to install the library and all its dependencies:

composer require "addwiki/mediawiki-api:~3.0"

Example Usage

// Load all the stuff
require_once( __DIR__ . '/vendor/autoload.php' );

// Create an authenticated API and services
$auth = new \Addwiki\Mediawiki\Api\Client\Auth\UserAndPassword( 'username', 'password' )
$api = new \Addwiki\Mediawiki\Api\Client\Action\ActionApi( 'http://localhost/w/api.php', $auth );
$services = new \Addwiki\Mediawiki\Api\MediawikiFactory( $api );

// Get a page
$page = $services->newPageGetter()->getFromTitle( 'Foo' );

// Edit a page
$content = new \Addwiki\Mediawiki\DataModel\Content( 'New Text' );
$revision = new \Addwiki\Mediawiki\DataModel\Revision( $content, $page->getPageIdentifier() );
$services->newRevisionSaver()->save( $revision );

// Move a page
$services->newPageMover()->move(
	$services->newPageGetter()->getFromTitle( 'FooBar' ),
	new Title( 'FooBar' )
);

// Delete a page
$services->newPageDeleter()->delete(
	$services->newPageGetter()->getFromTitle( 'DeleteMe!' ),
	array( 'reason' => 'Reason for Deletion' )
);

// Create a new page
$newContent = new \Addwiki\Mediawiki\DataModel\Content( 'Hello World' );
$title = new \Addwiki\Mediawiki\DataModel\Title( 'New Page' );
$identifier = new \Addwiki\Mediawiki\DataModel\PageIdentifier( $title );
$revision = new \Addwiki\Mediawiki\DataModel\Revision( $newContent, $identifier );
$services->newRevisionSaver()->save( $revision );

// List all pages in a category
$pages = $services->newPageListGetter()->getPageListFromCategoryName( 'Category:Cat name' );

Running the integration tests

To run the integration tests, you need to have a running MediaWiki instance. The tests will create pages and categories without using a user account so it's best if you use a test instance. Furthermore you need to turn off rate limiting by adding the line

$wgGroupPermissions['*']['noratelimit'] = true;

to the LocalSettings.php of your MediaWiki.

By default, the tests will use the URL http://localhost/w/api.php as the API endpoint. If you have a different URL (e.g. http://localhost:8080/w/api.php), you need to configure the URL as an environment variable before running the tests. Example:

export MEDIAWIKI_API_URL='http://localhost:8080/w/api.php'

Warning: Running the integration tests can take a long time to complete.