{"id":15017723,"url":"https://github.com/starcitizenwiki/laravelmediawikiapi","last_synced_at":"2025-08-22T12:39:36.478Z","repository":{"id":57059016,"uuid":"217114497","full_name":"StarCitizenWiki/LaravelMediawikiApi","owner":"StarCitizenWiki","description":"Laravel Package to interact with a MediaWiki Api","archived":false,"fork":false,"pushed_at":"2023-05-26T11:09:39.000Z","size":102,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-08-01T13:02:17.744Z","etag":null,"topics":["laravel","mediawiki-api","oauth"],"latest_commit_sha":null,"homepage":"https://api.star-citizen.wiki","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StarCitizenWiki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-23T17:25:12.000Z","updated_at":"2023-06-04T19:09:10.000Z","dependencies_parsed_at":"2024-09-12T03:14:13.333Z","dependency_job_id":"7555e5de-5cde-4d55-8a6f-85f0d9ee8f6e","html_url":"https://github.com/StarCitizenWiki/LaravelMediawikiApi","commit_stats":{"total_commits":63,"total_committers":2,"mean_commits":31.5,"dds":"0.031746031746031744","last_synced_commit":"546a36c6bd13508c2cde6eb87a12c5ecb3ebfd03"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/StarCitizenWiki/LaravelMediawikiApi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarCitizenWiki%2FLaravelMediawikiApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarCitizenWiki%2FLaravelMediawikiApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarCitizenWiki%2FLaravelMediawikiApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarCitizenWiki%2FLaravelMediawikiApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StarCitizenWiki","download_url":"https://codeload.github.com/StarCitizenWiki/LaravelMediawikiApi/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarCitizenWiki%2FLaravelMediawikiApi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271641249,"owners_count":24795334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","mediawiki-api","oauth"],"created_at":"2024-09-24T19:50:54.201Z","updated_at":"2025-08-22T12:39:36.455Z","avatar_url":"https://github.com/StarCitizenWiki.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravel MediaWiki API\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/packagist/v/starcitizenwiki/mediawikiapi\" alt=\"packagist version\" /\u003e\n    \u003cimg src=\"https://img.shields.io/packagist/dt/starcitizenwiki/mediawikiapi\" alt=\"packagist downloads /\u003e\n    \u003cimg src=\"https://img.shields.io/packagist/php-v/starcitizenwiki/mediawikiapi\" alt=\"php min version\" /\u003e\n\u003c/p\u003e\n                                                                                                        \nLaravel Package to interact with a Mediawiki Installation through the API, authenticated via OAuth.\n\n`composer require starcitizenwiki/mediawikiapi`\n\n## Installation\nPublish the configuration `php artisan vendor:publish`.  \nSelect `StarCitizenWiki\\MediaWikiApi\\ApiServiceProvider`\n\nA registered OAuth application is required on the target wiki if pages should be editable through the api.\n\n## Facade\nAccessible through `MediaWikiApi`.\n\n### Login\n```php\n$manager = app('mediawikiapi.manager');\n\n$manager-\u003esetConsumerFromCredentials(\n    'ConsumerToken',\n    'ConsumerSecret'\n);\n\n$manager-\u003esetTokenFromCredentials(\n    'AccessToken',\n    'AccessSecret'\n);\n```\n\n### BaseRequest\nEach request object extend the BaseRequest class.  \nThe base request class contains the following methods:\n```php\n$request-\u003equeryParams(); // Returns the query params as an array\n$request-\u003ejson(); // Set the request format to 'json'\n$request-\u003ecsrfToken('TOKEN'); // Set the csrf token for this request\n$request-\u003eformatVersion('latest'); // Set the formatversion. Valid values are 1, 2, 'latest'\n$request-\u003ewithTimestamp(); // Set the 'curtimestamp' param to 1\n$request-\u003eaddParam('key', 'value');\n$request-\u003erequest(); // Send the request, returns a MediaWikiResponse\n$request-\u003erequest([ \n  'timeout' =\u003e 10,\n]); // Send the request with additional GuzzleClient options\n```\n\n### Query\nMethods\n```php\n$query = MediaWikiApi::query();\n\n// Add meta params\n$query-\u003emeta('tokens'); // Param meta is now 'tokens'\n$query-\u003emeta('siteinfo')-\u003emeta('...'); // Param meta is now 'tokens|siteinfo|...'\n\n// Add prop params\n$query-\u003eprop('categories'); // Param prop is now 'categories'\n\n// Set the pages to work on\n$query-\u003etitles('Title1|Title2');\n// Or\n$query-\u003etitles('Title1')-\u003etitles('Title2');\n\n// Set a category limit if prop('categories') was set\n$query-\u003ecllimit(-1); // return 'max'\n$query-\u003ecllimit(100); // return 100\n\n// Force authentication\n$query-\u003ewithAuthentication();\n```\n\nRequest a CSRF token:\n```php\n$response = MediaWikiApi::query()-\u003emeta('tokens')-\u003erequest();\n\n// True if request was not successful\n$response-\u003ehasErrors(); // boolean\n$response-\u003egetErrors(); // array\n\n// True if request has warnings\n$response-\u003ehasWarnings(); // boolean\n$response-\u003egetWarnings(); // array\n\n$token = $response-\u003egetQuery()['tokens'];\n```\n\n### Parse\nMethods\n```php\n$parse = MediaWikiApi::parse();\n\n// Set a page to parse\n$parse-\u003epage('Example');\n\n// Add prop params\n$parse-\u003eprop('text'); // Param prop is now 'text'\n```\n\n### Edit\nMethods\n```php\n$edit = MediaWikiApi::edit();\n\n// Set the page title to edit\n// Unsets a previously set page ID!\n$edit-\u003etitle('Example');\n\n// Or use a page ID\n// Unsets a previously set title!\n$edit-\u003epageId(1);\n\n// Add text to the page\n// Automatically sets the md5 hash\n$edit-\u003etext('Content');\n\n// Edit an existing section\n$edit-\u003esection(1);\n\n// Add a new section\n$edit-\u003esection();\n\n// Set the section title\n$edit-\u003esectionTitle('Title');\n\n// Set an edit summary\n$edit-\u003esummary('This was an API edit');\n\n// Set mode to create only\n$edit-\u003ecreateOnly();\n\n// Set edit to minor\n// Unsets not minor\n$edit-\u003eminor();\n\n// Set edit to notminor\n// Unsets minor\n$edit-\u003enotMinor();\n\n// Set edit as bot edit\n$edit-\u003emarkBotEdit();\n\n// Set the CSRF Token\n$edit-\u003ecsrfToken('token');\n```\n\n### Action\nA generic class for requesting arbitrary API actions\n\n```php\n// Creates an action object with ?action=action-name, request method to 'GET' and auth to false\n$action = MediaWikiApi::action('action-name');\n\n// Creates an action object with ?action=foo, request method to 'POST' and auth to true\n$actionPostAuth = MediaWikiApi::action('foo', 'POST', true);\n\n// Creates an action object with ?action=bar\n$actionBar = MediaWikiApi::action('bar');\n$actionBar-\u003ewithAuthentication(); // auth is now true\n\n// Adding parameters\n$action-\u003eaddParam('name', 'value'); // \u0026name=value\n\n$action-\u003eaddParam('delete', true); // \u0026delete=true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarcitizenwiki%2Flaravelmediawikiapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarcitizenwiki%2Flaravelmediawikiapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarcitizenwiki%2Flaravelmediawikiapi/lists"}