https://github.com/chipbell4/data-mapper
A Data Mapper From Flat Arrays to Object Structure
https://github.com/chipbell4/data-mapper
Last synced: 3 months ago
JSON representation
A Data Mapper From Flat Arrays to Object Structure
- Host: GitHub
- URL: https://github.com/chipbell4/data-mapper
- Owner: chipbell4
- Created: 2014-06-14T20:01:14.000Z (almost 11 years ago)
- Default Branch: develop
- Last Pushed: 2014-06-15T15:43:22.000Z (almost 11 years ago)
- Last Synced: 2024-12-26T08:42:06.779Z (4 months ago)
- Language: PHP
- Size: 152 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Schema Mapper
[](https://travis-ci.org/chipbell4/data-mapper)
Utility for mapping a flat array of data to a complex object tree via
their constructors. The best way to observe is to see an example.
Suppose you have a class ```Person``` that represents a Person (go figure).
The constructor looks something like this:
```PHP
__construct($name)
{
$this->name = $name;
}
```
Pretty generic stuff. This library will take a schema like this:
```JSON
{
"type" : "Person",
"fields" : {
"name" : {
"type" : "string",
"source" : "name_value"
}
}
}
```
And an array like this:
```PHP
array('name_value' => 'Chip')
```
and spit out a ```Person``` object with a name field of 'Chip'. This may
seem like overkill, but the structure allows for more complex objects.
Consider a class ```Couple``` with a constructor that looks like this:
```PHP
__construct(Person $p1, Person $p2, $hobby)
{
// ...
}
```
Again, typical fare, but it now has a little deeper dependency. In order to
construct a ```Couple``` object, you're going to need two ```Person```s and
also a hobby. Given a schema like this:
```JSON
{
"type" : "Couple",
"fields" : {
"p1" : {
"type" : "Person",
"fields" : {
"name" : {
"type" : "string",
"source" : "name_value_1"
}
}
}
"p2" : {
"type" : "Person",
"fields" : {
"name" : {
"type" : "string",
"source" : "name_value_2"
}
}
},
"hobby" : {
"type" : "string",
"source" : "hobby"
}
}
}
```
and an data array like
```PHP
array('name_value_1' => 'Chip', 'name_value_2' => 'April');
```
The data mapper class can actually build a ```Couple``` object, with two people
objects, one with the name 'Chip' and the other with the name 'April'.
To use the class, simply instantiate and call:
```PHP
$mapper = new chipbell4\DataMapper\DataMapper();
// assuming you already have a schema and flat data defined
$obj = $mapper->map($schema, $data);
// If the schema is still in a file
$obj = $mapper->mapFromFile('path/to/schema.json', $data);
```