Как хранить такие объекты?

Question

[topuserman]

С некого источника, получаю список контрагентов.
Для дальнейшей работы с этими контрагентами, хочу завести сущность Контрагент.
Столкнулся с такой, архитектурной проблемой:

Список контрагентов приходят в XML, сами контрагенты имеют сырые данные, т.е.,
примерно 50 свойств, такого формата:

Статус контрагента:  принимает значения 1, 2, 3
Тип контрагента:  принимает значения ind, legal
и т.д.

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

Вопрос:

1. Как лучше организовать архитектурно, чтобы с этим можно было гибко работать ?
В каким виде хранить значения всех ключей свойств ? Отдельным объектом ? Или в каком-то конфигурационном файле, например yaml ?

2. Лучше сразу в сущности Контрагента хранить значения, или хранить только ключи, а когда нужны данные, использовать какой-то дополнительный метод, который достает его из конфиг файла ?

3. Какие варианты есть ?

UPD:

таких объектов может быть несколько, например, у контрагента есть менеджер, со своими свойствами, соответственно, менеджер - тоже отдельная сущность, которая будет у контрагента.

UPD2:

Как насчет что-то похожее на ValueObject ?

abstract class DataValue {

	private $values = [];
	private $code;

	public function __construct(string $code) {
		$this->code = $code;
		$this->values = $this->getCodeValues();
	}

	public function getValue() {
		return $this->values[$this->code] ?? null;
	}

	public function getCode(): string {
		return $this->code;
	}

	abstract public function getCodeValues(): array;

}

class CounterpartyStatus extends DataValue {
	public function getCodeValues(): array {
		return [
			"ind" => "Индивидуальный предприниматель",
			"le" => "Юр. лицо"
		];
	}
}

class Counterparty {

	private $status;

	public function __construct(string $statusCode) {
		$this->status = new CounterpartyStatus($statusCode);
	}

	public function getStatus(): DataValue {
		return $this->status;
	}

}

$counterparty = new Counterparty("le");
$counterparty->getStatus()->getValue();

Код не проверял - просто для примера.

Comments

[Adamos]

В тегах и вопросе по какой-то рациональной причине вообще нет баз данных?

[topuserman]

Adamos, да, база данных не нужна.

[kafkiansky]

Как насчет что-то похожее на ValueObject ?

Это не Value Object.

[topuserman]

kafkiansky, классный коммент - бессмысленное противоречие самому себе.

[dmitriy]

все зависит от полной картины происходящего
но в идеале иметь полный агрегат,
$contragent->getType()//ValueObject
$contragent->getStatus()//ValueObject
$contragent->getManager()//Entity

но если стаутус и тип это просто идентификаторы то достаточно $contragent->getTypeId() $contragent->getStatusId()

[nokimaro]

Список всех доступных свойств, как мне кажется, должны быть чётко прописаны в самом объекте, а не где-то во внешнем файле.
Выносить это во внешний файл имеет смысл только если поля часто меняются и актуализировать их надо без участия разработчика, скажем конфиг который редактирует менеджер через админку.

[topuserman]

dmitriy, спасибо, а что должен в себе содержать ValueObject ?

Наверное все-таки какая-то прослойка должно быть между Сырыми данных и ValueObject, которая будет Сырые данные (т.е. ключи) преобразовать в ValueObject.

Т.е.:

$contragent->typeId // здесь может одно из двух значений, например - 1 или 2

а сам геттер:

function getType() : ValueObject {
   
   // соответствие ключей и значений, и идеале надо вытаскивать с какой-то конфига или другого источника, не знаю как правильно..
   $values = [
      1 => "ИП",   
      2 => "Юр. лицо"
   ];

   return new ValueObject($contragent->typeId, $values[$contragent->typeId]);
}

В итоге мы получаем как сам Ключ типа, так и его соответствующее значение.

[topuserman]

nokimaro, сами свойства, не изменяются сами, но перечень значений свойств, может часто меняться.

Например, статус Контрагента сейчас может принимать 2 значения, завтра - могут добавить еще несколько статусов.
И нужно иметь возможно, не изменяя код, добавить соответствие,
ключ статуса => его значение (описание)

не знаю как правильно это все собрать в единое

[dmitriy]

так у контрагента может быть несколько статусов?

[topuserman]

dmitriy, да, также, как и у других свойств контрагента.

проблема в том, что эти статусы и другие свойства, хранятся не в виде значений, а в виде кодов.

А нужно как-то реализовать, чтобы при использовании геттров, получать ValueObject или даже DTO, в котором будет код значения свойства, и само значение.

[dmitriy]

я возложил бы все на репозиторий, представив что у нас нет никаких xml структур
например получаем из репо по id контрагента

class Contragent{


public function findById(int $id): Contragent

// каким то образом извлекаем сырые данные
$row = ...

//что то предустановлено прямо в репо
$values = [
      1 => "ИП",   
      2 => "Юр. лицо"
   ];

$status = new Type($row["type"], $values[$contragent->typeId]);

$type = new Status($row["status"]);

$contragent = new Contragent($status,$type);
//тут контрагент может заполнится через сеттеры другим данными, обязательные идут через конструктор
return $contragent;
}

наполнение данными происходит в репозитрии , сама же сущность Contragent просто DTO

в итоге после получения объекта мы имеем доступ к вложенным объектам

$contragent = $repository->findById($id);

echo $contragent->getType()->getId();
echo $contragent->getStatus()->getId();

Answer 1

[Adik Izat]

Если допустить что в каждом xml файле у тебя отдельный файл контрагента то создай класс вроде этого.

class Contragent
{
  public $name;
  public $status;
  public $vozrast;
  
  public function __construct($xmlfile){
      $xml = new SimpleXMLElement($xmlfile);
      $this->name = $xml->name;
      $this->status = $xml->status;
      $this->status = $xml->vozrast;
  }
}

Потом используй как то так.

$firstContragent = new Contragent((<xml_file_контрагента>));
echo $firstContragent->name; // имя
echo $firstContragent->status; // статус
echo $firstContragent->vozrast; // возраст

Как-то так.
Подробнее пример тут

Comments

[topuserman]

тут разбор xml совсем не причем)