awladdeleo/faker-news

Faker provider for fake news!

dev-master 2021-10-01 11:50 UTC

This package is auto-updated.

Last update: 2024-03-29 04:33:21 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

This is a custom provider for fzaniotto/Faker generating fake news headlines for use when testing website design. Also includes a fake news source name generator.

Installation

You can install the package via composer:

composer require awladdeleo/faker-news

Usage

$faker = (new \Faker\Factory())::create();
$faker->addProvider(new \Faker\Provider\Fakenews($faker));
$faker->addProvider(new \Faker\Provider\Fakenewssource($faker));

// generate a headline
echo $faker->headline;

// generate a named newssource (75% Newspapers, 25% TV news as below)
echo $faker->NewssourceName;

// generate a Newspaper name
// 'The Daily Texas', 'The Morning Herald', 'Manchester Post' etc
echo $faker->NewspaperName;

// generate a TV source name
// 'KKN News', 'ATV', 'JKK 247' etc
echo $faker->TvNewsName;

Example Laravel Factory Useage

<?php


use App\NewsStory;
use Faker\Generator as Faker;

$factory->define(NewsStory::class, function (Faker $faker) {
    $faker->addProvider(new \Faker\Provider\Fakenews($faker));
    $faker->addProvider(new \Faker\Provider\Fakenewssource($faker));
    return [
        'headline' => $faker->headline,
        'source' => $faker->newssourcename,
        'summary' => $faker->text,
        'url' => $faker->unique()->url,
    ];
});

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

PHP Package Boilerplate

This package was generated using the PHP Package Boilerplate.