<?php

namespace Shm\ShmSocial;

use Shm\ShmUtils\DeepAccess;

/*
Полная структура
[
    ShmSocialsField::ID => null,
    ShmSocialsField::PROFILE_ID => null,
    ShmSocialsField::TYPE => null,
    ShmSocialsField::SOC => null,
    ShmSocialsField::MAIL => null,
    ShmSocialsField::NAME => null,
    ShmSocialsField::SURNAME => null,
    ShmSocialsField::PHOTO => null,
    ShmSocialsField::GENDER => null,
    ShmSocialsField::GROUPS => null,
    ShmSocialsField::OWNER => null,
    ShmSocialsField::OWNER_COLLECTION => null,
    ShmSocialsField::_ID => null,
    ShmSocialsField::CREATED_AT => null,
    ShmSocialsField::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 ShmSocialsField
{
	/** Класс коллекции */
	public const COLLECTION_CLASS = ShmSocials::class;

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

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

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

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

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

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

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

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

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

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

	/** groups (Structure) полный пусть ключа */
	public const GROUPS = 'groups';

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

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

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


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


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


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


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


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


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


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


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


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


