PageQueryBossダウンロード - PageQueryBossソースコードのダウンロード

ページクエリボス

複数のフィールドとページを含む複雑なネストされたクエリを構築し、JSON に解析できる配列を返します。これは、SPA および PWA のデータを取得するのに役立ちます。

このモジュールを使用すると、ProcessWire ページまたは PageArray (RepeaterMatrixPageArray も含む) を配列または JSON に変換できます。クエリはネストでき、コールバック関数としてクロージャを含めることができます。 Pageimage や MapMarker など、一部のフィールドタイプは自動的に変換されます。

リリースアップデート

リリースページをチェックアウトして、更新を購読してください。

インストール

ProcessWire バックエンド経由

PageQueryBossクラス名を使用して、ProcessWire 管理の「モジュール」>「サイト」>「新規追加」>「ディレクトリからモジュールを追加」を介してインストールすることをお勧めします。

手動で

Github または ProcessWire リポジトリからファイルをダウンロードします: https://modules.processwire.com/modules/page-query-builder/

このモジュールのすべてのファイルを /site/modules/PageQueryBoss/ にコピーします。
管理画面で「モジュール > 更新」に移動し、このモジュールの「インストール」をクリックします。

メソッド

主に次の 2 つの方法があります。

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削除すると、インデックスは再び名前ベースになります。

役立つクロージャとヒント

これらは、使用したくなるかもしれない、または独自の開始点として役立つかもしれないいくつかのヘルプフィルクロージャ関数です (独自の関数がある場合はお知らせください)。

言語の概要を確認します。

 $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からのカスタム文字列

ReplyerMatrix を使用すると、フロントエンドのテンプレート文字列を作成できます。これはボタンやラベルなどに便利です。次のコードは、文字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;

トドス

バックエンド経由でデフォルトを設定できるようにします。デフォルトのクエリを使用して、どのようにしてスタイリッシュに実行できるでしょうか?

ライセンス: MIT

ライセンスの全文については、付属の LICENSE ファイルを参照してください。

拡大する