starcitizenwiki / mediawikiapi
Laravel Package to interact with a Mediawiki Installation through the API, authenticated via OAuth
Installs: 1 342
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: >=7.4
- guzzlehttp/guzzle: ^6.0||^7.0.1
- mediawiki/oauthclient: ^1.1.0||^2.0
Requires (Dev)
- mockery/mockery: ~1.0
- phpunit/phpunit: ^9.2.6
This package is auto-updated.
Last update: 2024-11-26 14:29:52 UTC
README
Laravel Package to interact with a Mediawiki Installation through the API, authenticated via OAuth.
composer require starcitizenwiki/mediawikiapi
Installation
Publish the configuration php artisan vendor:publish
.
Select StarCitizenWiki\MediaWikiApi\ApiServiceProvider
A registered OAuth application is required on the target wiki if pages should be editable through the api.
Facade
Accessible through MediaWikiApi
.
Login
$manager = app('mediawikiapi.manager'); $manager->setConsumerFromCredentials( 'ConsumerToken', 'ConsumerSecret' ); $manager->setTokenFromCredentials( 'AccessToken', 'AccessSecret' );
BaseRequest
Each request object extend the BaseRequest class.
The base request class contains the following methods:
$request->queryParams(); // Returns the query params as an array $request->json(); // Set the request format to 'json' $request->csrfToken('TOKEN'); // Set the csrf token for this request $request->formatVersion('latest'); // Set the formatversion. Valid values are 1, 2, 'latest' $request->withTimestamp(); // Set the 'curtimestamp' param to 1 $request->addParam('key', 'value'); $request->request(); // Send the request, returns a MediaWikiResponse $request->request([ 'timeout' => 10, ]); // Send the request with additional GuzzleClient options
Query
Methods
$query = MediaWikiApi::query(); // Add meta params $query->meta('tokens'); // Param meta is now 'tokens' $query->meta('siteinfo')->meta('...'); // Param meta is now 'tokens|siteinfo|...' // Add prop params $query->prop('categories'); // Param prop is now 'categories' // Set the pages to work on $query->titles('Title1|Title2'); // Or $query->titles('Title1')->titles('Title2'); // Set a category limit if prop('categories') was set $query->cllimit(-1); // return 'max' $query->cllimit(100); // return 100 // Force authentication $query->withAuthentication();
Request a CSRF token:
$response = MediaWikiApi::query()->meta('tokens')->request(); // True if request was not successful $response->hasErrors(); // boolean $response->getErrors(); // array // True if request has warnings $response->hasWarnings(); // boolean $response->getWarnings(); // array $token = $response->getQuery()['tokens'];
Parse
Methods
$parse = MediaWikiApi::parse(); // Set a page to parse $parse->page('Example'); // Add prop params $parse->prop('text'); // Param prop is now 'text'
Edit
Methods
$edit = MediaWikiApi::edit(); // Set the page title to edit // Unsets a previously set page ID! $edit->title('Example'); // Or use a page ID // Unsets a previously set title! $edit->pageId(1); // Add text to the page // Automatically sets the md5 hash $edit->text('Content'); // Edit an existing section $edit->section(1); // Add a new section $edit->section(); // Set the section title $edit->sectionTitle('Title'); // Set an edit summary $edit->summary('This was an API edit'); // Set mode to create only $edit->createOnly(); // Set edit to minor // Unsets not minor $edit->minor(); // Set edit to notminor // Unsets minor $edit->notMinor(); // Set edit as bot edit $edit->markBotEdit(); // Set the CSRF Token $edit->csrfToken('token');
Action
A generic class for requesting arbitrary API actions
// Creates an action object with ?action=action-name, request method to 'GET' and auth to false $action = MediaWikiApi::action('action-name'); // Creates an action object with ?action=foo, request method to 'POST' and auth to true $actionPostAuth = MediaWikiApi::action('foo', 'POST', true); // Creates an action object with ?action=bar $actionBar = MediaWikiApi::action('bar'); $actionBar->withAuthentication(); // auth is now true // Adding parameters $action->addParam('name', 'value'); // &name=value $action->addParam('delete', true); // &delete=true