README.md

Nextras Object Mapper

orisai/object-mapper extension for nextras/orm

Content

• Setup
• Rules
  • entity from id rule

Setup

Install with Composer

composer require orisai/nextras-object-mapper

Register rules

With default setup:

use OriNextras\ObjectMapper\Rules\EntityFromIdRule;

$ruleManager->addRule(new EntityFromIdRule($model));

Or with Nette:

orisai.objectMapper:
	rules:
		- OriNextras\ObjectMapper\Rules\EntityFromIdRule()

Rules

entity from id rule

Map id of an entity to the entity

• Both doctrine/annotations and PHP attributes syntax can be used
• Usage in array and list rules results into single query (no n+1 problem)

#[Attributes()]

use App\User\DB\User;
use OriNextras\ObjectMapper\Rules\EntityFromId;
use Orisai\ObjectMapper\MappedObject;
use Orisai\ObjectMapper\Modifiers\FieldName;
use Orisai\ObjectMapper\Rules\IntValue;

final class EntityFetchingInput implements MappedObject
{

	#[FieldName('userId')]
	#[EntityFromId(
		name: 'userId',
		entity: User::class,
		idDefinition: new IntValue(unsigned: true, castNumericString: true)),
	]
	public User $user;

}

@Annotations()

use App\User\DB\User;
use OriNextras\ObjectMapper\Rules\EntityFromId;
use Orisai\ObjectMapper\MappedObject;
use Orisai\ObjectMapper\Modifiers\FieldName;
use Orisai\ObjectMapper\Rules\IntValue;

final class EntityFetchingInput implements MappedObject
{

	/**
	 * @FieldName("userId")
	 * @EntityFromId(
	 *     name="userId"
	 *     entity=User::class
	 *     idDefinition=@IntValue(unsigned=true, castNumericString=true)
	 * )
	 */
	public User $user;

}

$data = [
	'userId' => 666,
];
$input = $processor->process($data, EntityFetchingInput::class);
// $input == EntityFetchingInput(user: User(id: 666, /* ... */))

Parameters:

• name
  • name used in errors in case id validation succeeded but id was not found in database
  • required
  • e.g. userId
• entity
  • nextras/orm entity class to which id is mapped
  • required
  • e.g. User::class
• idRule
  • rule used to validate id before being queried in database
    • when database expects number, impossible ids like 'string' would fail in a way we can't handle
    • also it saves queries which can't return any result
  • required