illuminated/wikipedia-grabber

Grab Wikipedia (or another MediaWiki) page in Laravel.

, _(*1)

Laravel Wikipedia Grabber

, _(*2)

, _(*3)

, _(*4)

Wikipedia/MediaWiki Grabber for Laravel., _(*5)

, _(*6)

Table of contents

• Usage
• Output formats
• Available methods
• Advanced
  • MediaWiki
  • Modify the grabbed page
• Sponsors
• License

Usage

1. Install the package via Composer:, _(*7)

   shell script composer require illuminated/wikipedia-grabber, _(*8)

2. Publish the config:, _(*9)

   shell script php artisan vendor:publish --provider="Illuminated\Wikipedia\WikipediaGrabberServiceProvider", _(*10)

3. Grab a full page or preview:, _(*11)

   use Wikipedia;
   
   echo (new Wikipedia)->page('Michael Jackson');
   echo (new Wikipedia)->preview('Michael Jackson');
   
   // Or
   
   echo (new Wikipedia)->randomPage();
   echo (new Wikipedia)->randomPreview();
   

Output formats

Here's the list of supported output formats:, _(*12)

• plain (default)
• bootstrap
• bulma

Change the format in your config file, or specify it explicitly:, _(*13)

echo (new Wikipedia)->page('Michael Jackson')->bulma();

Available methods

When you call the page() or preview() method, you'll get an instance of the proper object., _(*14)

There are numerous methods available on these objects, for example:, _(*15)

$page = (new Wikipedia)->page('Michael Jackson');

$page->isSuccess();         // true
$page->isMissing();         // false
$page->isInvalid();         // false
$page->isDisambiguation();  // false

echo $page->getId();        // 14995351
echo $page->getTitle();     // "Michael Jackson"
echo $page->getBody();      // Same as `echo $page;`

Advanced

MediaWiki

Wikipedia uses the MediaWiki API under the hood., _(*16)

Thus, you can grab pages from any MediaWiki website:, _(*17)

use MediaWiki;

echo (new MediaWiki($url))->page('Michael Jackson');

Modify the grabbed page

Sometimes it might be useful to append additional sections to the grabbed page:, _(*18)

$page = (new Wikipedia)->page('Michael Jackson');

$page->append('Interesting Facts', 'He had two pet llamas on his ranch called Lola and Louis.');

Alternatively, you can get the sections collection and change it as needed:, _(*19)

$page = (new Wikipedia)->page('Michael Jackson');

$sections = $page->getSections();
$sections->push(
    new Section('Interesting Facts', 'He had two pet llamas on his ranch called Lola and Louis.', $level = 2)
);

Sponsors

, _(*20)

License

Laravel Wikipedia Grabber is open-sourced software licensed under the MIT license., _(*21)

 , _(*22)