Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dmitry-ivanov/laravel-wikipedia-grabber

Wikipedia/MediaWiki Grabber for Laravel.
https://github.com/dmitry-ivanov/laravel-wikipedia-grabber

grabber laravel laravel-package mediawiki parser wiki wikipedia wikipedia-grabber wikipedia-parser

Last synced: 3 days ago
JSON representation

Wikipedia/MediaWiki Grabber for Laravel.

Host: GitHub
URL: https://github.com/dmitry-ivanov/laravel-wikipedia-grabber
Owner: dmitry-ivanov
License: mit
Created: 2018-01-18T15:11:11.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-03-06T21:56:38.000Z (7 months ago)
Last Synced: 2024-09-25T20:41:42.709Z (8 days ago)
Topics: grabber, laravel, laravel-package, mediawiki, parser, wiki, wikipedia, wikipedia-grabber, wikipedia-parser
Language: HTML
Homepage:
Size: 6.3 MB
Stars: 45
Watchers: 4
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        ![Wikipedia/MediaWiki Grabber for Laravel](art/1380x575-optimized.jpg)

# Laravel Wikipedia Grabber

[](https://buymeacoffee.com/dmitry.ivanov)

[![StyleCI](https://github.styleci.io/repos/117998599/shield?branch=master&style=flat)](https://github.styleci.io/repos/117998599?branch=master)

[![Build Status](https://img.shields.io/github/actions/workflow/status/dmitry-ivanov/laravel-wikipedia-grabber/tests.yml?branch=master)](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/actions?query=workflow%3Atests+branch%3Amaster)

[![Coverage Status](https://img.shields.io/codecov/c/github/dmitry-ivanov/laravel-wikipedia-grabber/master)](https://app.codecov.io/gh/dmitry-ivanov/laravel-wikipedia-grabber/tree/master)

![Packagist Version](https://img.shields.io/packagist/v/illuminated/wikipedia-grabber)

![Packagist Stars](https://img.shields.io/packagist/stars/illuminated/wikipedia-grabber)

![Packagist Downloads](https://img.shields.io/packagist/dt/illuminated/wikipedia-grabber)

![Packagist License](https://img.shields.io/packagist/l/illuminated/wikipedia-grabber)

Wikipedia/MediaWiki Grabber for Laravel.

| Laravel | Wikipedia Grabber                                                            |

|---------|------------------------------------------------------------------------------|

| 11.x    | _[Support](https://buymeacoffee.com/dmitry.ivanov)_ ☕                        |

| 10.x    | [10.x](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/10.x) |

| 9.x     | [9.x](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/9.x)   |

| 8.x     | [8.x](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/8.x)   |

| 7.x     | [7.x](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/7.x)   |

| 6.x     | [6.x](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/6.x)   |

| 5.8.*   | [5.8.*](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/5.8) |

| 5.7.*   | [5.7.*](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/5.7) |

| 5.6.*   | [5.6.*](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/5.6) |

| 5.5.*   | [5.5.*](https://github.com/dmitry-ivanov/laravel-wikipedia-grabber/tree/5.5) |

![Laravel Wikipedia Grabber - Demo](doc/img/demo.gif)

## Table of contents

- [Usage](#usage)

- [Output formats](#output-formats)

- [Available methods](#available-methods)

- [Advanced](#advanced)

  - [MediaWiki](#mediawiki)

  - [Modify the grabbed page](#modify-the-grabbed-page)

- [Sponsors](#sponsors)

- [License](#license)

## Usage

1. Install the package via Composer:

    ```shell script

    composer require illuminated/wikipedia-grabber

    ```

2. Publish the config:

    ```shell script

    php artisan vendor:publish --provider="Illuminated\Wikipedia\WikipediaGrabberServiceProvider"

    ```

3. Grab a full page or preview:

    ```php

    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:

- `plain` (default)

- `bootstrap`

- `bulma`

Change the format in your config file, or specify it explicitly:

```php

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.

There are numerous methods available on these objects, for example:

```php

$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](https://mediawiki.org/wiki/API:Main_page) under the hood.

Thus, you can grab pages from any MediaWiki website:

```php

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:

```php

$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:

```php

$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

[![Laravel Idea](art/sponsor-laravel-idea.png)](https://laravel-idea.com)


[![Material Theme UI Plugin](art/sponsor-material-theme.png)](https://material-theme.com)


## License

Laravel Wikipedia Grabber is open-sourced software licensed under the [MIT license](LICENSE.md).

[](https://buymeacoffee.com/dmitry.ivanov)