EntityMapFactory.php

<?php

namespace Darya\ORM;

use Darya\ORM\EntityMap\Strategy\PropertyStrategy;
use InvalidArgumentException;

/**
 * Darya's entity map factory.
 *
 * Provides simple entity map instantiation with sensible defaults.
 *
 * @author Chris Andrew <chris@hexus.io>
 */
class EntityMapFactory
{
	/**
	 * Create an entity map without a specific entity class.
	 *
	 * @param string      $name
	 * @param array       $mapping
	 * @param string|null $resource
	 * @return EntityMap
	 */
	public function create(string $name, array $mapping, string $resource = null): EntityMap
	{
		if ($resource === null) {
			$resource = $name;
		}

		$entityMap = new EntityMap(
			Entity::class, $resource, $mapping, new PropertyStrategy()
		);

		$entityMap->setName($name);

		return $entityMap;
	}

	/**
	 * Create a mapping for an entity class.
	 *
	 * @param string      $class
	 * @param array|null  $mapping
	 * @param string|null $resource
	 * @return EntityMap
	 */
	public function createForClass(string $class, array $mapping = null, string $resource = null): EntityMap
	{
		if (!class_exists($class)) {
			throw new InvalidArgumentException("Undefined class '$class'");
		}

		if ($resource === null) {
			// TODO: Extract snake_case resource name from class base name
			$resource = $class;
		}

		if (empty($mapping)) {
			// TODO: Extract class properties using PHP's Reflection API for a one-to-one mapping
			//       One step further would be to use Doctrine-style or PHP 8 annotations... ooo...
			$mapping = [];
		}

		$entityMap = new EntityMap(
			$class, $resource, $mapping, new PropertyStrategy()
		);

		$entityMap->setName($class);

		return $entityMap;
	}
}