<?php

namespace Shm\ShmAdmin\SchemaCollections;

use Shm\ShmUtils\DeepAccess;

/*
Полная структура
[
    ShmexportsField::TYPE => null,
    ShmexportsField::FILE_PATH => null,
    ShmexportsField::FILE_NAME => null,
    ShmexportsField::FILE_URL => null,
    ShmexportsField::TIMEZONE => null,
    ShmexportsField::TITLE => null,
    ShmexportsField::CURRENCY => null,
    ShmexportsField::COLLECTION => null,
    ShmexportsField::PIPELINE => null,
    ShmexportsField::PROGRESS => null,
    ShmexportsField::ERROR => null,
    ShmexportsField::STATUS => null,
    ShmexportsField::_ID => null,
    ShmexportsField::CREATED_AT => null,
    ShmexportsField::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 ShmexportsField
{
	/** Класс коллекции */
	public const COLLECTION_CLASS = ShmExportCollection::class;

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

	/** type (Enum) полный пусть ключа */
	public const TYPE = 'type';

	public const TYPE_ENUM_ALL_KEYS_VALUES = [
		'statement' => 'Ведомость расчетов',
		'data' => 'Экспорт данные',
	];

	/** Enum type: Ведомость расчетов */
	public const TYPE_ENUM_STATEMENT = 'statement';

	/** Enum type: Экспорт данные */
	public const TYPE_ENUM_DATA = 'data';

	/** Enum type */
	public const TYPE_ENUM_ALL_KEYS = ['statement', 'data'];

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

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

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

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

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

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

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

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

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

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

	/** status (Enum) полный пусть ключа */
	public const STATUS = 'status';

	public const STATUS_ENUM_ALL_KEYS_VALUES = [
		'pending' => 'В очереди',
		'processing' => 'В обработке',
		'done' => 'Выполнено',
		'error' => 'Ошибка',
	];

	/** Enum status: В очереди */
	public const STATUS_ENUM_PENDING = 'pending';

	/** Enum status: В обработке */
	public const STATUS_ENUM_PROCESSING = 'processing';

	/** Enum status: Выполнено */
	public const STATUS_ENUM_DONE = 'done';

	/** Enum status: Ошибка */
	public const STATUS_ENUM_ERROR = 'error';

	/** Enum status */
	public const STATUS_ENUM_ALL_KEYS = ['pending', 'processing', 'done', 'error'];

	/** _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 TYPE_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::TYPE, $defaultValue);
	}


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


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


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


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


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


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


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


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


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


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


	public static function STATUS_GET($data, $defaultValue = null)
	{
		return DeepAccess::get($data, self::STATUS, $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);
	}
}


