zero-to-prod / data-model-semver
A DataModel Representing the Components of a SemVer String
Fund package maintenance!
Github
Requires
- php: >=7.1
- ext-json: *
- zero-to-prod/package-helper: ^1.1.3
- zero-to-prod/regex-semver: ^71.0
- zero-to-prod/transformable: ^71.0
Requires (Dev)
- phpunit/phpunit: <12.0
Suggests
- zero-to-prod/data-model: Type-safe DTOs
- zero-to-prod/data-model-factory: Factories for a DataModel.
- zero-to-prod/semver-regex: A regular expression to check a SemVer string
- zero-to-prod/validate-semver: Validates a SemVer String
README
Contents
- Introduction
- Requirements
- Installation
- Documentation Publishing
- Usage
- Publishing DataModels
- Local Development
- Contributing
Introduction
A DataModel
representing the components of a SemVer string.
Requirements
- PHP 7.1 or higher.
Installation
Install Zerotoprod\DynamicSetter
via Composer:
composer require zero-to-prod/data-model-semver
This will add the package to your project's dependencies and create an autoloader entry for it.
Documentation Publishing
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/data-model-semver) vendor/bin/zero-to-prod-data-model-semver # Publish to custom directory vendor/bin/zero-to-prod-data-model-semver /path/to/your/docs
Automatic Documentation Publishing
You can automatically publish documentation by adding the following to your composer.json
:
{ "scripts": { "post-install-cmd": [ "zero-to-prod-data-model-semver" ], "post-update-cmd": [ "zero-to-prod-data-model-semver" ] } }
Usage
Pass a SemVer string to the from()
method.
$Semver = \Zerotoprod\DataModelSemver\Semver::from('1.2.3-prerelease+meta'); echo $Semver->major; // 1 echo $Semver->minor; // 2 echo $Semver->patch; // 3 echo $Semver->prerelease; // prerelease echo $Semver->buildmetadata; //meta
Helper Methods
Semver::from('1.2.3-prerelease+meta')->toArray(); Semver::from('1.2.3-prerelease+meta')->toJson();
Publishing DataModels
You can directly import these files into your project like this:
./vendor/bin/data-model-semver app/DataModelSemver
The first argument is the destination of where the files are copied to.
Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Commit changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-branch
). - Create a new Pull Request.