Download the PHP package anteris-dev/data-transfer-object-factory without Composer
On this page you can find all versions of the php package anteris-dev/data-transfer-object-factory. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download anteris-dev/data-transfer-object-factory
More information about anteris-dev/data-transfer-object-factory
Files in anteris-dev/data-transfer-object-factory
Package data-transfer-object-factory
Short Description Gives an easy-to-use API for mocking Data Transfer Objects.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package data-transfer-object-factory
Making it easy to mock your Data Transfer Objects
This package provides a fluent factory for Data Transfer Objects. Natively supported are POPOs (Plain Old PHP Objects), Getter / Setter Objects, and Spatie's Data Transfer Objects. If there is a DTO not represented, you can easily add an adapter to support it.
One thing that makes this package so powerful is that it integrates with Faker in an attempt to intelligently generate the correct content for your data based on its name. For example, a DTO with the property "$firstName" will get a Faker first name.
By default only built-in PHP types are supported, but this factory can easily be extended to support other types (e.g., Carbon) as well.
To Install
Run composer require anteris-dev/data-transfer-object-factory.
Getting Started
If you are simply using PHP default types in your DTOs, you can get started right away. Just pass your DTO FQDN to the static new() method. You can then use any of the following helper methods.
count()- Allows you to specify how many DTOs to be generated. They will be returned in an array.make()- Called when you are ready to generate the DTO. Returns the generated DTO[s].random()- Generates a random number of DTOssequence()- Alternates a specific state. (See below)state()- Manually sets properties based on the array of values passed.
Examples of these methods can be found below.
Extending
Adapters
Adapters instruct the factory on how to retrieve properties for a specific type of class. Adapters must implement the Anteris\DataTransferObjectFactory\Adapter\AdapterInterface which requires the following methods.
handles(ReflectionClass $class)- Returns a bool if the adapter can handle the referenced reflection class.getProperties(ReflectionClass $class)- Returns a collection of properties found on the referenced reflection class.createClass(ReflectionClass $class, PropertyCollection $collection)- Creates and returns and instance of the reflection class using the properties passed.
To register an adapter on the factory, call its static registerAdapter() method. For example:
For more information check out the Adapter directory in the source code.
Property Types
It used to be that you had to extend the factory class to utilize custom types. You can now do so through the static registerProvider() method on the PropertyFactory class. This method takes two arguments. The first should be the FQDN of the class you are providing (e.g. Carbon\Carbon) OR the built-in type (e.g. string). The second should be a callback that returns the generated value. This callback is passed two properties when called to assist in generating the value. The first is an instance of Anteris\FakerMap\FakerMap which can be used to help generate fake data. The second is the name of the property being generated or null if not provided.
For example, to support Carbon:
