Data Models and factories for the OMDB API.
This works well when hydrating results from the OmdbApi package.
Install Zerotoprod\OmdbModels
via Composer:
composer require zero-to-prod/omdb-models
This will add the package to your project’s dependencies and create an autoloader entry for it.
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
# Publish to default location (./docs/zero-to-prod/omdb-models)
vendor/bin/zero-to-prod-omdb-models
# Publish to custom directory
vendor/bin/zero-to-prod-omdb-models /path/to/your/docs
You can automatically publish documentation by adding the following to your composer.json
:
{
"scripts": {
"post-install-cmd": [
"zero-to-prod-omdb-models"
],
"post-update-cmd": [
"zero-to-prod-omdb-models"
]
}
}
You can directly import these files into your project like this:
./vendor/bin/omdb-models ./app/OmdbModels
This package has the following models:
\Zerotoprod\OmdbModels\Error::from();
\Zerotoprod\OmdbModels\Rating::from();
\Zerotoprod\OmdbModels\SearchItem::from();
\Zerotoprod\OmdbModels\SearchResults::from();
\Zerotoprod\OmdbModels\Title::from();
// Enums
\Zerotoprod\OmdbModels\ErrorType::from();
\Zerotoprod\OmdbModels\Type::from();
This package uses Data Model Factories and has the following factories:
\Zerotoprod\OmdbModels\Factories\ErrorFactory::factory()->setMessage('message')->make();
\Zerotoprod\OmdbModels\Factories\RatingFactory::factory()->setValue('2')->make();
\Zerotoprod\OmdbModels\Factories\SearchItemFactory::factory()->setTitle('Avatar')->make();
\Zerotoprod\OmdbModels\Factories\SearchResultsFactory::factory()->setTotalResults(2)->make();
\Zerotoprod\OmdbModels\Factories\TitleFactory::factory()->setTitle('Avatar')->make();
You can directly import these files into your project like this:
./vendor/bin/omdb-models app/OmdbModels
The first argument is the destination of where the files are copied to.
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
git checkout -b feature-branch
).git commit -m 'Add some feature'
).git push origin feature-branch
).