Download the PHP package lucleads/automap without Composer
On this page you can find all versions of the php package lucleads/automap. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lucleads/automap
More information about lucleads/automap
Files in lucleads/automap
Package automap
Short Description Objects mapper library
License MIT
Homepage https://github.com/lucleads/Mapper
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 automap
Mapper
Description
Library that automatically copies the attributes of an object to a Data Transfer Object.
This library works in a similar way to libraries like MapStruct in other languages such as Java.
DEPLOY
To deploy a sandbox of the library, modify de .env file located in the project root with your local settings, open a terminal in the root directory and execute the next command:
docker-compose up -d[to build and deploy the docker container]
*NOTE: If you don't modify the .env file, the default values are:
- Container name: dto-mapper
- Php version: 8.0.10
- Deployable port: 81
HOW TO USE IT
In the path /src/app/ExampleUseCase you can find an example of how to implement a mapper.
The purpose of this library is to copy the values of the common fields of two objects.
For each pair of objects we have to create a mapper class (Example: PersonOutputDtoMapper).
That mapper class must extend from the abstract class Mapper and must contain in its constructor the entity which contains the fields values.
In that class, we can make a function (map()) that returns an instance of the class needed, for example a Data Transfer Object class.
The only content of this function should be a static call to its parent class method mapAutomatically() with the next parameters:
- 1st parameter: The source object
- 2nd parameter: The output object class expected
- 3rd parameter:
self::class(The mapper class)
To make our mapper find the source for the value of each field, there are three ways to do it:
- The value is in a public field with the same name in the source object and in the target object.
-
The source object have a getter with the same name of the field of the target object.
- Example:
-
In the specific MapperClass, we can define the layers to find the value as a class Map attribute.
- Example:
*NOTE: To define a map attributes, we must follow the next structure:
#[Map(
+
layers up the value separated by dots as string
+,
+field name in target object as string
+]
REQUIREMENTS
Needed to deploy the proyect:
Tools used in docker build (Don't need previous installation):
*NOTE: The PHP version established in the .env file must be 8.0 or higher.
