cspivack / faker-baseball
Use fakerphp/faker to generate data from the Fighting Baseball roster.
v1.0.0
2022-01-02 00:04 UTC
Requires
- php: ^7.4 || ^8.0
- fakerphp/faker: ^1.9.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.3
- phpstan/phpstan: ^1.2
- phpunit/phpunit: ^9.5
README
A Faker provider that uses the Fighting Baseball roster to generate names, teams, and positions.
Installation
Add the Faker Baseball library to your composer.json
file:
composer require cspivack/faker-baseball
Usage
To use this provider with Faker, you must add the provider class to the Faker generator:
<?php $faker = \Faker\Factory::create(); $faker->addProvider(new \Faker\Provider\FightingBaseballProvider($faker)); /* General data */ $faker->playerName(); // A name using random first and last names $faker->playerPosition(); // One of the positions in the game $faker->playerTeam(); // One of the teams in the game /* Data for a specific player */ $faker->player()->name(); // A player's full name $faker->player()->firstName(); // A player's first name $faker->player()->lastName(); // A player's first name $faker->player()->team(); // A player's team $faker->player()->position(); // A player's position $faker->player()->benched(); // Whether the player is coming off the bench or not (boolean)
To use this provider with Laravel factories, add this to your AppServiceProvider's register() method:
public function register() { $this->app->singleton(Generator::class, function () { $faker = Factory::create(); $faker->addProvider(new \Faker\Provider\FightingBaseballProvider($faker)); return $faker; }); }
Tests
Run tests with composer test
and run static analyis with composer phpstan
.
Roadmap
- Add support for team/player relationships (getting a list of all players on a particular team, getting a player's teammates, etc.)