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

Нет описания правки
м Замена текста — «getId» на «searchId»
Строка 61: Строка 61:
}}
}}


=== getId / getTplId ===
=== searchId / getTplId ===
Обе функции ищут id по значению в указанном поле. Разница в результате:
Обе функции ищут id по значению в указанном поле. Разница в результате:
* <code>getId</code> возвращает найденные id в виде JSON-массива.
* <code>searchId</code> возвращает найденные id в виде JSON-массива.
* <code>getTplId</code> по найденным id сразу вызывает шаблон.
* <code>getTplId</code> по найденным id сразу вызывает шаблон.


Использование:
Использование:
* {{tji|GetField|функция{{=}}getId|searchValue|pagePath|keyPath}}
* {{tji|GetField|функция{{=}}searchId|searchValue|pagePath|keyPath}}
* {{tji|GetField|функция{{=}}getTplId|searchValue|pagePath|keyPath|template}}
* {{tji|GetField|функция{{=}}getTplId|searchValue|pagePath|keyPath|template}}
* {{tji|GetField|функция{{=}}getTplId|pagePath|keyPath|template|searchType{{=}}path}}
* {{tji|GetField|функция{{=}}getTplId|pagePath|keyPath|template|searchType{{=}}path}}
Строка 79: Строка 79:


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


{{Параметры|
{{Параметры|
Строка 199: Строка 199:
* Если запись, поле или JSON-страница не найдены, функции обычно возвращают пустую строку.
* Если запись, поле или JSON-страница не найдены, функции обычно возвращают пустую строку.
* Функция <code>get</code> возвращает таблицы в JSON-виде.
* Функция <code>get</code> возвращает таблицы в JSON-виде.
* В <code>getId</code> и <code>getTplId</code> значения сравниваются как строки.
* В <code>searchId</code> и <code>getTplId</code> значения сравниваются как строки.
* Параметр <code>keyPath</code> поддерживает доступ к вложенным полям и индексам.
* Параметр <code>keyPath</code> поддерживает доступ к вложенным полям и индексам.
* <code>getTpl</code> и <code>getTplId</code> удобны, когда нужно не получить сырые данные, а сразу отрендерить карточку или другой шаблон.
* <code>getTpl</code> и <code>getTplId</code> удобны, когда нужно не получить сырые данные, а сразу отрендерить карточку или другой шаблон.
* Функции с <code>Generator</code> работают только с генераторными страницами и хранилищами, где структура данных уже подготовлена под поиск по id.
* Функции с <code>Generator</code> работают только с генераторными страницами и хранилищами, где структура данных уже подготовлена под поиск по id.
* <code>json</code> и <code>jsonList</code> ожидают корректный JSON; если строка не разбирается, результат будет пустым.
* <code>json</code> и <code>jsonList</code> ожидают корректный JSON; если строка не разбирается, результат будет пустым.