Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starcitizenwiki/laravelmediawikiapi
Laravel Package to interact with a MediaWiki Api
https://github.com/starcitizenwiki/laravelmediawikiapi
laravel mediawiki-api oauth
Last synced: 3 days ago
JSON representation
Laravel Package to interact with a MediaWiki Api
- Host: GitHub
- URL: https://github.com/starcitizenwiki/laravelmediawikiapi
- Owner: StarCitizenWiki
- License: mit
- Created: 2019-10-23T17:25:12.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-26T11:09:39.000Z (over 1 year ago)
- Last Synced: 2024-03-15T05:22:23.302Z (7 months ago)
- Topics: laravel, mediawiki-api, oauth
- Language: PHP
- Homepage: https://api.star-citizen.wiki
- Size: 99.6 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel MediaWiki API
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
```php
$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:
```php
$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
```php
$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:
```php
$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
```php
$parse = MediaWikiApi::parse();
// Set a page to parse
$parse->page('Example');
// Add prop params
$parse->prop('text'); // Param prop is now 'text'
```
### Edit
Methods
```php
$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
```php
// 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
```