PageQueryBoss下载 - PageQueryBoss源码下载

页面查询老大

构建包含多个字段和页面的复杂嵌套查询，并返回一个可以解析为 JSON 的数组。这对于获取 SPA 和 PWA 的数据非常有用。

您可以使用该模块将 ProcessWire Page 或 PageArray（甚至 RepeaterMatrixPageArrays）转换为数组或 JSON。查询可以嵌套并包含闭包作为回调函数。某些字段类型会自动转换，例如 Pageimages 或 MapMarker。

发布更新

查看发布页面并订阅更新。

安装

通过 ProcessWire 后端

建议使用PageQueryBoss类名称通过 ProcessWire 管理“模块”>“站点”>“添加新模块”>“从目录添加模块”进行安装。

手动

从 Github 或 ProcessWire 存储库下载文件：https://modules.processwire.com/modules/page-query-builder/

将此模块的所有文件复制到 /site/modules/PageQueryBoss/
转到管理员中的“模块 > 刷新”，然后单击该模块的“安装”。

方法

主要有两种方法：

返回 JSON

 $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

字段的默认查询：

某些字段类型或模板带有默认选择器，例如页面图像等。这些是默认查询：

 // 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种可能性：

按名称嵌套（默认）
按 ID 嵌套
按数字索引嵌套

命名索引（默认）：

这是默认设置。如果您有一个包含子项的字段，则名称将是结果中的键：

 // example
$pagesByName = [
	'page-1-name' => [
		'title' => "Page one title",
		'name' => 'page-1-name',
	],
	'page-2-name' => [
		'title' => "Page two title",
		'name' => 'page-2-name',
	]
]

基于ID的索引：

如果 $defaults['index-id'] 中列出了一个对象，则 id 将成为结果中的键。目前，没有项目被列为基于 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",
	]
]

提示：当您从 $defaults['index-n'] 中删除键Pageimage时，索引将再次基于名称。

有用的关闭和提示

这些是您可能想要使用的几个 helpfill 闭包函数，或者可以帮助您作为自己的起点（如果您有自己的函数，请告诉我）：

获取语言概述：

 $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 模块获取县信息

使用 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;
}];

来自接口 RepeaterTable 的自定义字符串

使用 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();
}

调试

该模块遵循wire('config')->debug。它与 TracyDebug 集成。你可以像这样覆盖它：

 // turns on debug output no mather what:
$modules->get('PageQueryBoss')->debug = true;

托多斯

通过后端进行默认配置。如何使用默认查询以时尚的方式完成此操作？

许可证：麻省理工学院

请参阅包含的许可证文件以获取完整的许可证文本。

展开

PageQueryBoss