A Doctrine helper class that provides functionalities to easily create, patch or serialise entities.
Use cases:
- To create entities from arrays returning from APIs
- To create entities from arrays returning from pure SQL queries.
- To serialise entities to arrays for transfer or export purposes.
composer.json
"require": {
"micronative/entity-patcher": "^1.0.0"
},
"repositories": [
{ "type": "vcs", "url": "https://github.com/micronative/entity-patcher" }
],
Run
composer require micronative/entity-patcher:1.0.0
- Create entity with data KEYED_BY_PROPERTY
$patcher = new Patcher();
$company = $patcher->create(
Company::class,
[
'id' => 1,
'name' => 'Micronative',
'users' => [
[
'id' => '100',
'firstName' => 'Ken',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1000',
'type' => 'Admin'
],
[
'id' => '1100',
'type' => 'Manager'
],
],
'profiles' => [
[
'id' => '10000',
'description' => 'Admin Profile'
],
[
'id' => '10001',
'description' => 'Manager Profile'
],
]
],
[
'id' => '200',
'firstName' => 'May',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1100',
'type' => 'Student'
],
[
'id' => '1200',
'type' => 'Daughter'
],
],
'profiles' => [
[
'id' => '10003',
'description' => 'Student Profile'
],
[
'id' => '10004',
'description' => 'Daughter Profile'
],
]
]
]
],
Patcher::KEYED_BY_PROPERTY);
print_r($company);- Create entity with data KEYED_BY_COLUMN
$company = $patcher->create(
Company::class,
[
'company_id' => 1,
'company_name' => 'Micronative',
'users' => [
[
'user_id' => '100',
'user_firstName' => 'Ken',
'user_lastName' => 'Ngo',
'user_email' => '[email protected]',
'roles' => [
[
'role_id' => '1000',
'role_type' => 'Admin'
],
[
'role_id' => '1100',
'role_type' => 'Manager'
],
],
'profiles' => [
[
'profile_id' => '10000',
'profile_description' => 'Admin Profile'
],
[
'profile_id' => '10001',
'profile_description' => 'Manager Profile'
],
]
],
[
'user_id' => '200',
'user_firstName' => 'May',
'user_lastName' => 'Ngo',
'user_email' => '[email protected]',
'roles' => [
[
'role_id' => '1100',
'role_type' => 'Student'
],
[
'role_id' => '1200',
'role_type' => 'Daughter'
],
],
'profiles' => [
[
'profile_id' => '10003',
'profile_description' => 'Student Profile'
],
[
'profile_id' => '10004',
'profile_description' => 'Daughter Profile'
],
]
]
]
],
Patcher::KEYED_BY_COLUMN);
print_r($company);Two print_r($company) above will output the same result
Samples\Entity\Company Object
(
[id:Samples\Entity\Company:private] => 1
[name:Samples\Entity\Company:private] => Micronative
[users:Samples\Entity\Company:private] => Array
(
[0] => Tests\Entity\User Object
(
[id:Tests\Entity\User:private] => 100
[firstName:Tests\Entity\User:private] => Ken
[lastName:Tests\Entity\User:private] => Ngo
[email:Tests\Entity\User:private] => [email protected]
[roles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1000
[type:Tests\Entity\Role:private] => Admin
)
[1] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1100
[type:Tests\Entity\Role:private] => Manager
)
)
[profiles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10000
[description:Tests\Entity\Profile:private] => Admin Profile
)
[1] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10001
[description:Tests\Entity\Profile:private] => Manager Profile
)
)
)
[1] => Tests\Entity\User Object
(
[id:Tests\Entity\User:private] => 200
[firstName:Tests\Entity\User:private] => May
[lastName:Tests\Entity\User:private] => Ngo
[email:Tests\Entity\User:private] => [email protected]
[roles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1100
[type:Tests\Entity\Role:private] => Student
)
[1] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1200
[type:Tests\Entity\Role:private] => Daughter
)
)
[profiles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10003
[description:Tests\Entity\Profile:private] => Student Profile
)
[1] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10004
[description:Tests\Entity\Profile:private] => Daughter Profile
)
)
)
)
)@see: samples/create.php
- Patch entity with data KEYED_BY_PROPERTY
$patcher = new Patcher();
$company = new Company();
$patcher->patch(
$company,
[
'id' => 1,
'name' => 'Micronative',
'users' => [
[
'id' => '100',
'firstName' => 'Ken',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1000',
'type' => 'Admin'
],
[
'id' => '1100',
'type' => 'Manager'
],
],
'profiles' => [
[
'id' => '10000',
'description' => 'Admin Profile'
],
[
'id' => '10001',
'description' => 'Manager Profile'
],
]
],
[
'id' => '200',
'firstName' => 'May',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1100',
'type' => 'Student'
],
[
'id' => '1200',
'type' => 'Daughter'
],
],
'profiles' => [
[
'id' => '10003',
'description' => 'Student Profile'
],
[
'id' => '10004',
'description' => 'Daughter Profile'
],
]
]
]
],
Patcher::KEYED_BY_PROPERTY);
print_r($company);- Patch entity with data KEYED_BY_COLUMN
$patcher->patch(
$company,
[
'company_id' => 1,
'companny_name' => 'Micronative',
'users' => [
[
'id' => '100',
'firstName' => 'Ken',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1000',
'type' => 'Admin'
],
[
'id' => '1100',
'type' => 'Manager'
],
],
'profiles' => [
[
'id' => '10000',
'description' => 'Admin Profile'
],
[
'id' => '10001',
'description' => 'Manager Profile'
],
]
],
[
'id' => '200',
'firstName' => 'May',
'lastName' => 'Ngo',
'email' => '[email protected]',
'roles' => [
[
'id' => '1100',
'type' => 'Student'
],
[
'id' => '1200',
'type' => 'Daughter'
],
],
'profiles' => [
[
'id' => '10003',
'description' => 'Student Profile'
],
[
'id' => '10004',
'description' => 'Daughter Profile'
],
]
]
]
],
Patcher::KEYED_BY_COLUMN);
print_r($company);Two print_r($company) above will output the same result
Samples\Entity\Company Object
(
[id:Samples\Entity\Company:private] => 1
[name:Samples\Entity\Company:private] => Micronative
[users:Samples\Entity\Company:private] => Array
(
[0] => Tests\Entity\User Object
(
[id:Tests\Entity\User:private] => 100
[firstName:Tests\Entity\User:private] => Ken
[lastName:Tests\Entity\User:private] => Ngo
[email:Tests\Entity\User:private] => [email protected]
[roles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1000
[type:Tests\Entity\Role:private] => Admin
)
[1] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1100
[type:Tests\Entity\Role:private] => Manager
)
)
[profiles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10000
[description:Tests\Entity\Profile:private] => Admin Profile
)
[1] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10001
[description:Tests\Entity\Profile:private] => Manager Profile
)
)
)
[1] => Tests\Entity\User Object
(
[id:Tests\Entity\User:private] => 200
[firstName:Tests\Entity\User:private] => May
[lastName:Tests\Entity\User:private] => Ngo
[email:Tests\Entity\User:private] => [email protected]
[roles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1100
[type:Tests\Entity\Role:private] => Student
)
[1] => Tests\Entity\Role Object
(
[id:Tests\Entity\Role:private] => 1200
[type:Tests\Entity\Role:private] => Daughter
)
)
[profiles:Tests\Entity\User:private] => Array
(
[0] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10003
[description:Tests\Entity\Profile:private] => Student Profile
)
[1] => Tests\Entity\Profile Object
(
[id:Tests\Entity\Profile:private] => 10004
[description:Tests\Entity\Profile:private] => Daughter Profile
)
)
)
)
)@see: samples/patch.php
$patcher = new Patcher();
$company = new Company();
$company
->setId(1)
->setName('Micronative');
$role1 = new Role();
$role1
->setId(1)
->setType('Admin');
$role2 = new Role();
$role2
->setId(21)
->setType('Manager');
$user1 = new User();
$user1
->setId(2)
->setEmail('[email protected]')
->setFirstName('Ken')
->setLastName('Ngo')
->setCompany($company);
$role1->setUsers([$user1]);
$user1->setRoles([$role1, $role2]);
$user2 = new User();
$user2
->setId(3)
->setEmail('[email protected]')
->setFirstName('May')
->setLastName('Ngo')
->setCompany($company);
$role2->setUsers([$user2]);
$company->setUsers([$user1, $user2]);
# serialise to array KEYED_BY_PROPERTY
$companyArray = $patcher->serialise($company, Patcher::KEYED_BY_PROPERTY);
print_r($companyArray);
# serialise to array KEYED_BY_COLUMN
$companyArray = $patcher->serialise($company, Patcher::KEYED_BY_COLUMN);
print_r($companyArray);The first print_r($company) above will output an array keyed by property name
Array
(
[id] => 1
[name] => Micronative
[users] => Array
(
[0] => Array
(
[id] => 2
[firstName] => Ken
[lastName] => Ngo
[email] => [email protected]
[company] => Array
(
[id] => 1
[name] => Micronative
)
[roles] => Array
(
[0] => Array
(
[id] => 1
[type] => Admin
)
[1] => Array
(
[id] => 21
[type] => Manager
)
)
)
[1] => Array
(
[id] => 3
[firstName] => May
[lastName] => Ngo
[email] => May[email protected]
[company] => Array
(
[id] => 1
[name] => Micronative
)
)
)
)The second print_r($company) above will output an array keyed by column name
Array
(
[company_id] => 1
[company_name] => Micronative
[users] => Array
(
[0] => Array
(
[user_id] => 2
[user_first_name] => Ken
[user_last_name] => Ngo
[user_email] => [email protected]
[company] => Array
(
[company_id] => 1
[company_name] => Micronative
)
[roles] => Array
(
[0] => Array
(
[role_id] => 1
[role_type] => Admin
)
[1] => Array
(
[role_id] => 21
[role_type] => Manager
)
)
)
[1] => Array
(
[user_id] => 3
[user_first_name] => May
[user_last_name] => Ngo
[user_email] => May[email protected]
[company] => Array
(
[company_id] => 1
[company_name] => Micronative
)
)
)
)@see: samples/serialise.php
$patcher = new Patcher();
$company = new Company();
$company
->setId(1)
->setName('Micronative');
$role1 = new Role();
$role1
->setId(1)
->setType('Admin');
$role2 = new Role();
$role2
->setId(21)
->setType('Manager');
$user1 = new User();
$user1
->setId(2)
->setEmail('[email protected]')
->setFirstName('Ken')
->setLastName('Ngo')
->setCompany($company);
$role1->setUsers([$user1]);
$user1->setRoles([$role1, $role2]);
$user2 = new User();
$user2
->setId(3)
->setEmail('[email protected]')
->setFirstName('May')
->setLastName('Ngo')
->setCompany($company);
$role2->setUsers([$user2]);
# serialise to array KEYED_BY_PROPERTY
$rolesArray = $patcher->serialiseCollection([$role1, $role2], Patcher::KEYED_BY_PROPERTY);
print_r($rolesArray);
# serialise to array KEYED_BY_COLUMN
$rolesArray = $patcher->serialiseCollection([$role1, $role2], Patcher::KEYED_BY_COLUMN);
print_r($rolesArray);The first print_r($rolesArray) above will output an array keyed by property name
Array
(
[0] => Array
(
[id] => 1
[type] => Admin
[users] => Array
(
[0] => Array
(
[id] => 2
[firstName] => Ken
[lastName] => Ngo
[email] => [email protected]
[company] => Array
(
[id] => 1
[name] => Micronative
)
)
)
)
[1] => Array
(
[id] => 21
[type] => Manager
[users] => Array
(
[0] => Array
(
[id] => 3
[firstName] => May
[lastName] => Ngo
[email] => May[email protected]
[company] => Array
(
[id] => 1
[name] => Micronative
)
)
)
)
)The second print_r($rolesArray) will out an array keyed by column name
Array
(
[0] => Array
(
[role_id] => 1
[role_type] => Admin
[users] => Array
(
[0] => Array
(
[user_id] => 2
[user_first_name] => Ken
[user_last_name] => Ngo
[user_email] => [email protected]
[company] => Array
(
[company_id] => 1
[company_name] => Micronative
)
)
)
)
[1] => Array
(
[role_id] => 21
[role_type] => Manager
[users] => Array
(
[0] => Array
(
[user_id] => 3
[user_first_name] => May
[user_last_name] => Ngo
[user_email] => May[email protected]
[company] => Array
(
[company_id] => 1
[company_name] => Micronative
)
)
)
)
)