<?php

namespace Shm\ShmPayment\TBankPayment\TBankCollections;

use Shm\ShmUtils\DeepAccess;

/*
Полная структура
[
    TPaymentsField::AMOUNT => null,
    TPaymentsField::ORDER_ID => null,
    TPaymentsField::DESCRIPTION => null,
    TPaymentsField::PHONE => null,
    TPaymentsField::EMAIL => null,
    TPaymentsField::OWNER => null,
    TPaymentsField::OWNER_COLLECTION => null,
    TPaymentsField::INIT_REQUEST => null,
    TPaymentsField::AUTO_REFUNDED => null,
    TPaymentsField::NOTIFICATIONS => [
        [
            TPaymentsField::EL_NOTIFICATIONS__UUID => null,
        ],
    ],
    TPaymentsField::INIT_RESULT => null,
    TPaymentsField::PAYMENT_ID => null,
    TPaymentsField::STATUS => null,
    TPaymentsField::CHARGE_RESULT => null,
    TPaymentsField::CANCEL_RESULT => [
        [
            TPaymentsField::EL_CANCEL_RESULT__REQUEST => null,
            TPaymentsField::EL_CANCEL_RESULT__RESULT => null,
            TPaymentsField::EL_CANCEL_RESULT__CREATED_AT => null,
            TPaymentsField::EL_CANCEL_RESULT__UUID => null,
        ],
    ],
    TPaymentsField::_ID => null,
    TPaymentsField::CREATED_AT => null,
    TPaymentsField::UPDATED_AT => null,
]
*/

/**
 * Контракт строковых ключей полей. Не DTO, не коллекция, не значения полей.
 *
 * Как выбирать константу:
 * 1) Документ: filter, $set, $unset, sort, projection → константа без суффикса (полный путь с точками).
 *    updateOne([_ID => $id], ['$set' => [STATUS => $v, INIT_RESULT__PAYMENT_ID => $pid]])
 * 2) Собрать вложенный Structure как PHP-массив → внутри родителя ключи `_KEY` (локальное имя).
 *    SEAT => [SEAT__NUMBER_KEY => 1, SEAT__ROW_KEY => 'A']
 * 3) Собрать / прочитать элемент массива → `EL_{ARRAY}__{FIELD}` (путь от элемента, не от документа).
 *    '$push' => [CANCEL_RESULT => [EL_CANCEL_RESULT__REQUEST => $req]]
 *    foreach (NOTIFICATIONS_GET($doc) as $item) { EL_NOTIFICATIONS__UUID_GET($item); }
 * 4) Mongo: «поле в любом элементе массива» → `{ARRAY}__IDX__{FIELD}` = 'array.field'.
 *    Только filter/aggregate. Запрещено с *_GET, DeepAccess и как ключ PHP-массива документа.
 *
 * Чтение:
 * - `{CONST}_GET($data, $default)` — значение по пути. $default только если пути нет, а не когда в данных null.
 * - Вложенное поле нельзя читать как $data[INIT_RESULT__PAYMENT_ID]: в PHP нет ключа с точкой.
 * - EL_*_GET только от элемента массива. У IDX нет GET.
 * - ID-поле: GET возвращает ObjectId/скаляр, не подгруженный документ.
 *
 * Запись:
 * - Ключи документа = полные пути (п.1). Ключи элемента / $push = EL_ (п.3).
 * - Не используйте *_GET для записи.
 *
 * Не путать:
 * - COLLECTION_CLASS — PHP-класс коллекции (findOne, updateOne, insertOne).
 * - COLLECTION_NAME — строка-имя в MongoDB. Класс туда не подставлять.
 * - Константа поля — ключ. `{FIELD}_ENUM_{VALUE}` — значение. Пишите STATUS => STATUS_ENUM_ACTIVE, не STATUS => STATUS.
 * - Карта «Полная структура» над классом — справочник формы, не шаблон insert со всеми null.
 *
 * Жёстко:
 * - Имена полей только константами этого класса, никогда строками ('status', 'members.owner').
 * - Нет константы → нет поля в схеме. Не выдумывайте имена и не склеивайте пути ('a.'.$x).
 * - Не берите константы из чужого *Field для документа этой коллекции.
 * - `__` в имени константы = точка в пути. `_KEY` / `EL_` / `IDX` / `_ENUM_` — разные роли, не взаимозаменяемы.
 *
 * Файл генерируется автоматически. Не редактируйте вручную.
 */
class TPaymentsField
{
	/** Класс коллекции */
	public const COLLECTION_CLASS = TPayments::class;

	/** Имя коллекции */
	public const COLLECTION_NAME = 'tPayments';

	/** Сумма платежа, руб полный пусть ключа */
	public const AMOUNT = 'amount';

	/** ID заказа полный пусть ключа */
	public const ORDER_ID = 'orderId';

	/** Описание платежа полный пусть ключа */
	public const DESCRIPTION = 'description';

	/** Телефон полный пусть ключа */
	public const PHONE = 'phone';

	/** Email полный пусть ключа */
	public const EMAIL = 'email';

	/** owner (ObjectId) полный пусть ключа */
	public const OWNER = 'owner';

	/** ownerCollection полный пусть ключа */
	public const OWNER_COLLECTION = 'ownerCollection';

	/** Запрос инициализации платежа (Structure) полный пусть ключа */
	public const INIT_REQUEST = 'initRequest';

	/** Автоматический возврат полный пусть ключа */
	public const AUTO_REFUNDED = 'autoRefunded';

	/** Уведомления (Array) полный пусть ключа */
	public const NOTIFICATIONS = 'notifications';

	/** uuid — ключ поля элемента массива */
	public const EL_NOTIFICATIONS__UUID = 'uuid';

	/** uuid — путь через массив (MongoDB IDX), не для GET */
	public const NOTIFICATIONS__IDX__UUID = 'notifications.uuid';

	/** Результат инициализации платежа (Structure) полный пусть ключа */
	public const INIT_RESULT = 'initResult';

	/** ID платежа полный пусть ключа */
	public const PAYMENT_ID = 'paymentId';

	/** Статус платежа полный пусть ключа */
	public const STATUS = 'status';

	/** Результат оплаты по сохраненной карте (Structure) полный пусть ключа */
	public const CHARGE_RESULT = 'chargeResult';

	/** Результаты отмен платежа (Array) полный пусть ключа */
	public const CANCEL_RESULT = 'cancelResult';

	/** Запрос отмены платежа (Structure) — ключ поля элемента массива */
	public const EL_CANCEL_RESULT__REQUEST = 'request';

	/** Запрос отмены платежа (Structure) — путь через массив (MongoDB IDX), не для GET */
	public const CANCEL_RESULT__IDX__REQUEST = 'cancelResult.request';

	/** Результат отмены платежа (Structure) — ключ поля элемента массива */
	public const EL_CANCEL_RESULT__RESULT = 'result';

	/** Результат отмены платежа (Structure) — путь через массив (MongoDB IDX), не для GET */
	public const CANCEL_RESULT__IDX__RESULT = 'cancelResult.result';

	/** Дата создания запроса — ключ поля элемента массива */
	public const EL_CANCEL_RESULT__CREATED_AT = 'created_at';

	/** Дата создания запроса — путь через массив (MongoDB IDX), не для GET */
	public const CANCEL_RESULT__IDX__CREATED_AT = 'cancelResult.created_at';

	/** uuid — ключ поля элемента массива */
	public const EL_CANCEL_RESULT__UUID = 'uuid';

	/** uuid — путь через массив (MongoDB IDX), не для GET */
	public const CANCEL_RESULT__IDX__UUID = 'cancelResult.uuid';

	/** _id (ObjectId) полный пусть ключа */
	public const _ID = '_id';

	/** created_at полный пусть ключа */
	public const CREATED_AT = 'created_at';

	/** updated_at полный пусть ключа */
	public const UPDATED_AT = 'updated_at';

	public static function AMOUNT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::AMOUNT, $defaultValue);
	}


	public static function ORDER_ID_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::ORDER_ID, $defaultValue);
	}


	public static function DESCRIPTION_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::DESCRIPTION, $defaultValue);
	}


	public static function PHONE_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::PHONE, $defaultValue);
	}


	public static function EMAIL_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EMAIL, $defaultValue);
	}


	public static function OWNER_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::OWNER, $defaultValue);
	}


	public static function OWNER_COLLECTION_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::OWNER_COLLECTION, $defaultValue);
	}


	public static function INIT_REQUEST_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::INIT_REQUEST, $defaultValue);
	}


	public static function AUTO_REFUNDED_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::AUTO_REFUNDED, $defaultValue);
	}


	public static function NOTIFICATIONS_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::NOTIFICATIONS, $defaultValue);
	}


	public static function EL_NOTIFICATIONS__UUID_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EL_NOTIFICATIONS__UUID, $defaultValue);
	}


	public static function INIT_RESULT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::INIT_RESULT, $defaultValue);
	}


	public static function PAYMENT_ID_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::PAYMENT_ID, $defaultValue);
	}


	public static function STATUS_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::STATUS, $defaultValue);
	}


	public static function CHARGE_RESULT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::CHARGE_RESULT, $defaultValue);
	}


	public static function CANCEL_RESULT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::CANCEL_RESULT, $defaultValue);
	}


	public static function EL_CANCEL_RESULT__REQUEST_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EL_CANCEL_RESULT__REQUEST, $defaultValue);
	}


	public static function EL_CANCEL_RESULT__RESULT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EL_CANCEL_RESULT__RESULT, $defaultValue);
	}


	public static function EL_CANCEL_RESULT__CREATED_AT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EL_CANCEL_RESULT__CREATED_AT, $defaultValue);
	}


	public static function EL_CANCEL_RESULT__UUID_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::EL_CANCEL_RESULT__UUID, $defaultValue);
	}


	public static function _ID_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::_ID, $defaultValue);
	}


	public static function CREATED_AT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::CREATED_AT, $defaultValue);
	}


	public static function UPDATED_AT_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::UPDATED_AT, $defaultValue);
	}
}


