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 您可以為前端建立模板字串。這body按鈕key key等strings 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;

托多斯

透過後端進行預設配置。如何使用預設查詢以時尚的方式完成此操作？

許可證：麻省理工學院

請參閱包含的許可證文件以取得完整的許可證文字。

展開