PageQueryBoss
Bugfix Release 0.0.6
Создавайте сложные вложенные запросы, содержащие несколько полей и страниц, и возвращайте массив, который можно проанализировать в формате JSON. Это полезно для получения данных для SPA и PWA.
Вы можете использовать модуль для преобразования страницы ProcessWire или PageArray — даже RepeaterMatrixPageArrays — в массив или JSON. Запросы могут быть вложенными и содержать замыкания в качестве функций обратного вызова. Некоторые типы полей преобразуются автоматически, например Pageimages или MapMarker.
Посетите страницу релизов и подпишитесь на обновления.
Рекомендуется устанавливать через администратора ProcessWire « Модули » > « Сайт » > « Добавить новый » > « Добавить модуль из каталога », используя имя класса PageQueryBoss .
Загрузите файлы из Github или репозитория ProcessWire: https://modules.processwire.com/modules/page-query-builder/
Существует два основных метода:
$page->pageQueryJson($query);
$page->pageQueryArray($query);
Запрос может содержать пары ключ и значение или только ключи. Он может быть вложенным и содержать замыкания для динамических значений. Чтобы проиллюстрировать короткий пример:
// simple query:
$query = [
'height',
'floors',
];
$pages->find('template=skyscraper')->pageQueryJson($query);
Запросы могут быть вложенными, содержать имена страниц, имена шаблонов или содержать функции и селекторы ProcessWire:
// simple query:
$query = [
'height',
'floors',
'images', // < some fileds contain default sub-queries to return data
'files' => [ // but you can also overrdide these defaults:
'filename'
'ext',
'url',
],
// Assuming there are child pages with the architec template, or a
// field name with a page relation to architects
'architect' => [ // sub-query
'name',
'email'
],
// queries can contain closure functions
'querytime' => function($parent){
return "Query for $parent->title was built ".time();
}
];
$pages->find('template=skyscraper')->pageQueryJson($query);
Одно имя поля ; height или floors или architects
Модуль может обрабатывать следующие поля:
Имя шаблона ; skyscraper или city
Имя дочерней страницы (page.child.name=pagename); my-page-name
Селектор ProcessWire ; template=building, floors>=25
Новое имя возвращаемого индекса, передаваемое через разделитель # :
// the field skyscraper will be renamed to "building":
$query = ["skyscraper`#building`"]
Любой из ключей выше (1–5) с новым вложенным массивом подзапросов:
$query = [
'skyscraper' => [
'height',
'floors'
],
'architect' => [
'title',
'email'
],
]
Именованный ключ и функция замыкания для обработки и возврата запроса. Замыкание получает родительский объект в качестве аргумента:
$query = [
'architecs' => function($parent)
{
$architects = $parent->find('template=architect');
return $architects->arrayQuery(['name', 'email']);
// or return $architects->explode('name, email');
}
]
$query = [
'title',
'subtitle',
// naming the key invitation
'template=Invitation, limit=1#invitation' => [
'title',
'subtitle',
'body',
],
// returns global speakers and local ones...
'speakers' => function($page){
$speakers = $page->speaker_relation;
$speakers = $speakers->prepend(wire('pages')->find('template=Speaker, global=1, sort=-id'));
// build a query of the speakers with
return $speakers->arrayQuery([
'title#name', // rename title field to name
'subtitle#ministry', // rename subtitle field to ministry
'links' => [
'linklabel#label', // rename linklabel field to minlabelistry
'link'
],
]);
},
// Child Pages with template=Program
'Program' => [
'title',
'summary',
'start' => function($parent){ // calculate the startdate from timetables
return $parent->children->first->date;
},
'end' => function($parent){ // calculate the endate from timetables
return $parent->children->last->date;
},
'Timetable' => [
'date', // date
'timetable#entry'=> [
'time#start', // time
'time_until#end', // time
'subtitle#description', // entry title
],
],
],
// ProcessWire selector, selecting children > name result "location"
'template=Location, limit=1#location' => [
'title#city', // summary title field to city
'body',
'country',
'venue',
'summary#address', // rename summary field to address
'link#tickets', // rename ticket link
'map', // Mapmarker field, automatically transformed
'images',
'infos#categories' => [ // repeater matrix! > rename to categories
'title#name', // rename title field to name
'entries' => [ // nested repeater matrix!
'title',
'body'
]
],
],
];
if ($input->urlSegment1 === 'json') {
header('Content-type: application/json');
echo $page->pageQueryJson($query);
exit();
}
Настройки модулей общедоступны. Их можно напрямую изменить, например:
$modules->get('PageQueryBoss')->debug = true;
$modules->get('PageQueryBoss')->defaults = []; // reset all defaults
Некоторые типы полей или шаблоны имеют селекторы по умолчанию, например Pageimages и т. д. Это запросы по умолчанию:
// Access and modify default queries: $modules->get('PageQueryBoss')->defaults['queries'] = …
public $defaults = [
'queries' => [
'Pageimage' => [
'basename',
'url',
'httpUrl',
'description',
'ext',
'focus',
],
'Pageimages' => [
'basename',
'url',
'httpUrl',
'description',
'ext',
'focus',
],
'Pagefile' => [
'basename',
'url',
'httpUrl',
'description',
'ext',
'filesize',
'filesizeStr',
'hash',
],
'Pagefiles' => [
'basename',
'url',
'httpUrl',
'description',
'ext',
'filesize',
'filesizeStr',
'hash',
],
'MapMarker' => [
'lat',
'lng',
'zoom',
'address',
],
'User' => [
'name',
'email',
],
],
];
Эти значения по умолчанию будут использоваться только в том случае, если для соответствующего типа нет вложенного подзапроса. Если вы запросите поле со сложными данными и не предоставите подзапрос, оно будет преобразовано соответствующим образом:
$page->pageQueryArry(['images']);
// returns something like this
'images' => [
'basename',
'url',
'httpUrl',
'description',
'ext',
'focus'=> [
'top',
'left',
'zoom',
'default',
'str',
]
];
Вы всегда можете предоставить свой собственный подзапрос, поэтому значения по умолчанию не будут использоваться:
$page->pageQueryArry([
'images' => [
'filename',
'description'
],
]);
Вы также можете переопределить значения по умолчанию, например
$modules->get('PageQueryBoss')->defaults['queries']['Pageimages'] = [
'basename',
'url',
'description',
];
Индекс вложенных элементов можно настроить. Это также делается с настройками по умолчанию. Есть 3 возможности:
Это настройка по умолчанию. Если у вас есть поле, содержащее подэлементы, имя будет ключевым в результатах:
// example
$pagesByName = [
'page-1-name' => [
'title' => "Page one title",
'name' => 'page-1-name',
],
'page-2-name' => [
'title' => "Page two title",
'name' => 'page-2-name',
]
]
Если объект указан в $defaults['index-id'], его идентификатор будет ключевым в результатах. В настоящее время ни один элемент не указан в качестве значений по умолчанию для индекса на основе идентификатора:
$modules->get('PageQueryBoss')->defaults['index-id']['Page'];
// example
$pagesById = [
123 => [
'title' => "Page one title",
'name' => 123,
],
124 => [
'title' => "Page two title",
'name' => 124,
]
]
По умолчанию несколько полей автоматически преобразуются в нумерованные индексы:
// objects or template names that should use numerical indexes for children instead of names
$defaults['index-n'] => [
'skyscraper', // template name
'Pageimage',
'Pagefile',
'RepeaterMatrixPage',
];
// example
$images = [
0 => [
'filename' => "image1.jpg",
],
1 => [
'filename' => "image2.jpg",
]
]
Совет: Когда вы удалите ключ Pageimage из $defaults['index-n'], индекс снова будет основан на имени.
Это несколько функций закрытия подсказки, которые вы, возможно, захотите использовать или можете использовать в качестве отправной точки для своих собственных (дайте мне знать, если у вас есть свои собственные):
$query = ['languages' => function($page){
$ar = [];
$l=0;
foreach (wire('languages') as $language) {
// build the json url with segment 1
$ar[$l]['url']= $page->localHttpUrl($language).wire('input')->urlSegment1;
$ar[$l]['name'] = $language->name == 'default' ? 'en' : $language->name;
$ar[$l]['title'] = $language->getLanguageValue($language, 'title');
$ar[$l]['active'] = $language->id == wire('user')->language->id;
$l++;
}
return $ar;
}];
Используя модуль ContinentsAndCountries, вы можете извлечь ISO-код и названия стран:
$query = ['country' => function($page){
$c = wire('modules')->get('ContinentsAndCountries')->findBy('countries', array('name', 'iso', 'code'),['code' =>$page->country]);
return count($c) ? (array) $c[count($c)-1] : null;
}];
Используя RepeaterMatrix, вы можете создать строку шаблона для своего интерфейса. Это полезно для кнопок, меток и т. д. В следующем коде используется повторитель со strings имен, имеющими key и поле body , возвращаемый массив содержит поле key в качестве, как вы предполагаете, ключей и поле body в качестве значений:
// build custom translations
$query = ['strings' => function($page){
return array_column($page->get('strings')->each(['key', 'body']), 'body', 'key');
}];
Используя следующую настройку, вы можете обрабатывать многоязычность и возвращать язык по умолчанию, если запрошенный язык не существует. URL-адрес составляется следующим образом: page/path/{language}/{content-type} например: api/icf/zurich/conference/2019/de/json
// get contenttype and language (or default language if not exists)
$lang = wire('languages')->get($input->urlSegment1);
if(!$lang instanceof Nullpage){
$user->language = $lang;
} else {
$lang = $user->language;
}
// contenttype segment 2 or 1 if language not present
$contenttype = $input->urlSegment2 ? $input->urlSegment2 : $input->urlSegment1;
if ($contenttype === 'json') {
header('Content-type: application/json');
echo $page->pageQueryJson($query);
exit();
}
Модуль учитывает провод('config')->debug. Он интегрируется с TracyDebug. Вы можете переопределить это так:
// turns on debug output no mather what:
$modules->get('PageQueryBoss')->debug = true;
Сделайте настройки по умолчанию настраиваемыми через Backend. Как это можно сделать стильно с помощью запросов по умолчанию?
Полный текст лицензии см. в прилагаемом файле ЛИЦЕНЗИИ.
© noelboss.com
