Шаблон:GetField/doc: различия между версиями

Строит вызов шаблона для одного id и сразу обрабатывает его через препроцессор. Помимо <code>id</code>, в шаблон передаются развёрнутые поля записи.

=== getId / getTplId ===

* <code>getId</code> возвращает найденные id в виде JSON-массива.

* <code>getTplId</code> по найденным id сразу вызывает шаблон.

* {{tji|GetField|функция{{=}}getId|searchValue|pagePath|keyPath}}

* {{tji|GetField|функция{{=}}getTplId|searchValue|pagePath|keyPath|template}}

* {{tji|GetField|функция{{=}}getTplId|pagePath|keyPath|template|searchType{{=}}path}}

* <code>searchType=path</code> — только для <code>getTplId</code>; выводит все id, у которых поле по указанному пути существует и не пустое. В этом режиме первым параметром передаётся <code>pagePath</code>, а не значение для поиска.

<code>getTplId</code> вызывает шаблон в виде <code><nowiki>{{Имя шаблона|id=...|...поля записи...}}</nowiki></code>. Если найдено несколько id, вызовы собираются подряд через пробел.

* {{tji|GetField|функция{{=}}getId|Elements|[[Участник:IanComradeBot/prototype/reaction.json|prototype/reaction.json]]|group}} -> {{GetField|функция=getId|Stir|prototype/reaction.json|requiredMixerCategories}}

{{Параметры/строка|4|Имя шаблона, который будет вызван для каждого найденного id.|Только для <code>getTplId</code>}}

=== getGenerator / getTplGenerator ===

Эти функции находят прототипы или компоненты содержащие указанный id, используя [[Участник:IanComradeBot/prototype_store.json]] и [[Участник:IanComradeBot/component_store.json]].

* {{tji|GetField|функция{{=}}getGenerator|searchId|prototype|Название}}

* {{tji|GetField|функция{{=}}getGenerator|searchId|component|Название}}

* {{tji|GetField|функция{{=}}getTplGenerator|searchId|prototype|Название|Шаблон}}

<code>getGenerator</code> возвращает JSON-массив id, найденных в компонентах/прототипах. <code>getTplGenerator</code> по тем же id сразу вызывает шаблон, используя страницу вида <code>prototype/Название.json</code> или <code>component/Название.json</code>.

* {{tji|GetField|функция{{=}}getGenerator|MopItem|component|itemBorgModule}} -> {{GetField|функция=getGenerator|MopItem|component|itemBorgModule}}

* {{tji|GetField|функция{{=}}getGenerator|MopItem|prototype|latheRecipe}} -> {{GetField|функция=getGenerator|MopItem|prototype|latheRecipe}}

{{Параметры/строка|4|Имя шаблона, который будет вызван для каждого найденного id.|Только для <code>getTplGenerator</code>}}

=== GeneratorId / GeneratorTplId ===

* {{tji|GetField|функция{{=}}GeneratorId|pagePath}}

* {{tji|GetField|функция{{=}}GeneratorTplId|pagePath|template}}

<code>GeneratorId</code> по умолчанию возвращает JSON-массив id.  

<code>GeneratorTplId</code> вызывает шаблон для каждого id в виде <code><nowiki>{{Имя шаблона|id=...|...поля записи...}}</nowiki></code>.

* {{tji|GetField|функция{{=}}GeneratorId|component/staticPrice.json}} -> выводит все id сущностей с этим компонентом в формате JSON

* {{tji|GetField|функция{{=}}GeneratorTplId|component/staticPrice.json|component/staticPrice/wrapper}} -> выводит все id сущностей с этим компонентом обёрнутым в шаблон {{шс|component/staticPrice/wrapper}}

{{Параметры/строка|2|Имя шаблона для <code>GeneratorTplId</code>.|Только для <code>GeneratorTplId</code>}}

{{Параметры/строка|replace|Строка замены для <code>GeneratorId</code>. Если задана, результат выводится построчно вместо JSON-массива.|Нет}}

* В <code>getId</code> и <code>getTplId</code> значения сравниваются как строки.

* <code>getTpl</code> и <code>getTplId</code> удобны, когда нужно не получить сырые данные, а сразу отрендерить карточку или другой шаблон.

* Функции с <code>Generator</code> работают только с генераторными страницами и хранилищами, где структура данных уже подготовлена под поиск по id.