Как правильно сделать типизацию объектов?

Question

[OneTwoThreeFourFive]

Я использую паттерн DataMapper и использую общий абстрактный класс для всех дата мапперов, чтобы не копировать похожий код (findByID и другое).

abstract class DataMapperAbstract {
	public function findByID( int $id ) {
		$this->database->read...
	}

	protected function setDatabase( Database $database ) {
		$this->database = $database;
	}

	protected function setTable( string $table) {
		$this->table = $table;
	}

	abstract protected function mapToObject( array $data );

	abstract protected function mapToArray( $object ): array;

	abstract public function save( $object );
}

Есть дата маппер для пользователей

class UserMapper extends DataMapperAbstract {
	public function __construct( Database $database ) {
		$this->setDatabase( $database );
		$this->setTable( 'users' );
	}

	protected function mapToObject( array $data ): User {
		...
	}

	protected function mapToArray( $user ): array {
		if ( !( $user instanceof User ) ) {
			throw new \Exception( 'Not User' );
		}

		...
	}

	public function save( $user ) {
		...
	}
}

Чтобы проверить, является ли значение в $user mapToArray( $user ) объектом класса User, я использую конструкцию

if ( !( $user instanceof User ) ) {
	throw new \Exception( 'Not User' );
}

В абстрактном классе нельзя указать тип объекта User

abstract protected function mapToArray( User $object ): array;

потому что другие дата мапперы будут использовать другие объекты (не User).

Проверка с исключением нормальное решение? И чтобы не писать каждый раз такую конструкцию, добавить её в абстрактный класс function checkObject() { ... }?

Или как сделать лучше?

Comments

[Максим Федоров]

в конструкторе установите тип
string $classType

и потом проверяйте через $this->classType

[Александр Лыкасов]

Наверное, лучше не в конструкторе, а завести под это метод в базовом классе. Что-то навроде:

abstract protected function getModelClass(): string;

Answer 1

[Vitsliputsli]

Вы можете воспользоваться контравариантностью (php>=7.4), т.е. указать в абстрактном классе родительский класс для User:

abstract protected function mapToArray(Model $object ): array;

...

class User extends Model

Либо ввести DTO, чтобы mapper брал данные из него и вообще никак не обращался к бизнесовым сущностям.

Comments

[OneTwoThreeFourFive]

Я думал сделать похожим способом с общим классом, но тогда можно передать любой объект (который наследуется от Model) в маппер для пользователя, а по смыслу в маппер для пользователя можно передавать только объект User.

[Vitsliputsli]

OneTwoThreeFourFive, не,
MapperAbstract принимает Model,
а UserMapper принимает User.

Только сейчас заметил, почему абстрактный независимый от User mapper называется UserMapperAbstract?

[OneTwoThreeFourFive]

Наверно вы перепутали, есть класс abstract class DataMapperAbstract

Попробовал ваш пример и метод в маппере ожидает объект класса модель.

abstract class MapperAbstract {
	abstract public function test( Model $object );
}

class UserMapper extends MapperAbstract {
	public function test( User $object ) {

	}
}

class Model {

}

class User extends Model {

}

$user_mapper = new UserMapper();
$user = new User();

$user_mapper->test( $user );

Declaration of UserMapper::test(User $object) must be compatible with MapperAbstract::test(Model $object)

Если указать Model в классе UserMapper, то ошибки нет. Но тогда можно передать в метод любой класс, который наследуется от Model.

[Vitsliputsli]

OneTwoThreeFourFive, да, я тупанул, так не получится, т.к. наследник может “сужать“ родительский объект, а никак не наоборот. Чтобы выполнялся LSP. Тогда только вариант указывать и там и там интерфейс.

[OneTwoThreeFourFive]

С интерфейсом тоже не получится. На вашем примере. Можно создать интерфейс ModelInterface и User implements от интерфейса Model. Создать другие модели от интерфейса Model. В маппер добавить ModelInterface $object

abstract class MapperAbstract {
  abstract public function test( ModelInterface $object );
}

Тогда передать в маппер можно любую модель.

Если

abstract class MapperAbstract {
  abstract public function test( User $object );
}

то будет та же ошибка

Я выбрал способ проверки к какому классу принадлежит объект instanceof

[Vitsliputsli]

OneTwoThreeFourFive, не так, у вас везде будет один и тот же интерфейс (и в абстрактном классе, и в конкретном), и интерфейс явно будет не Model, скорее это будет DTOInterface который будет описывать как работать с объектом DTO (т.е. методы которыми можно извлечь данные для дальнейшего маппинга).
Этот интерфейс может реализовывать модель User, а лучше создать отдельный класс DTO. Тогда mapper будет работать не с бизнесовой моделью, а с объектом, где только данные, т.е. где только то, что ему нужно.