pickles2/px2-px2dthelper

Pickles 2 のプラグインです。Pickles 2 babycorn(Desktop Tool) やその他のCMSと連携させるためのAPIを提供します。

インストール - Install

次の手順でインストールしてください。

Composer パッケージを読み込む。

$ composer require pickles2/px2-px2dthelper

Pickles2 のコンフィグに追記する。

<?php
return call_user_func( function(){

	/* 中略 */

	// funcs: Before content
	$conf->funcs->before_content = array(
		// PX=px2dthelper
		'tomk79\pickles2\px2dthelper\main::register'
	);

	/* 中略 */

	// processor
	$conf->funcs->processor->html = array(
		// broccoli-receive-message スクリプトを挿入
		// (Optional)
		'tomk79\pickles2\px2dthelper\broccoli_receive_message::apply('.json_encode( array(
			// 許可する接続元を指定
			'enabled_origin'=>array(
				'http://127.0.0.1:8080',
				'http://127.0.0.1:8081',
				'http://127.0.0.1:8082',
			)
		) ).')'
	);

	/* 中略 */

	return $conf;
} );

API

モジュールの CSS をビルドする

/* CSSファイルに下記を記述 */
<?php
// CSSのソースコードが返されます。
// このコードには、画像などのリソースもdataスキーマ化した状態で含められます。
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->build_css();
?>

モジュールの JavaScript をビルドする

// JavaScriptファイルに下記を記述
<?php
// JavaScriptのソースコードが返されます。
// スクリプト内から画像などのリソースを呼び出している場合、
// このメソッドには、リンクを解決するなどの機能はありません。
// 予め、出力後のパスを起点にパスが解決できるように作成してください。
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->build_js();
?>

HTMLにCSSとJavaScriptをロードする

<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
<?php
// style要素、および script要素 が出力されます。
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->load();
?>
</head>
<body>
	<h1>Page Title</h1>
	<!-- コンテンツ -->
</body>
</html>

Authorizer `$px->authorizer` の初期化

\tomk79\pickles2\px2dthelper\authorizer::initialize($px, 'member');

PXコマンド

PX=px2dthelper.version

px2-px2dthelper のバージョン番号を取得します。

$ php .px_execute.php /?PX=px2dthelper.version

PX=px2dthelper.check_status

px2-px2dthelper の状態情報を取得します。

$ php .px_execute.php /?PX=px2dthelper.check_status

PX=px2dthelper.find_page_content

ページのコンテンツファイルを探します。

$ php .px_execute.php /path/find/content.html?PX=px2dthelper.find_page_content

PX=px2dthelper.get.realpath_data_dir

$conf->plugins->px2dt->guieditor->path_data_dir の解決された内部絶対パスを取得します。

PX=px2dthelper.get.path_resource_dir

$conf->plugins->px2dt->guieditor->path_resource_dir の解決されたパスを取得します。

PX=px2dthelper.get.custom_fields

$conf->plugins->px2dt->guieditor->custom_fields の値を取得します。

PX=px2dthelper.get.navigation_info

ナビゲーションシステムを生成するために必要な情報をまとめて取得します。

$ php .px_execute.php "/?PX=px2dthelper.get.navigation_info&filter=false"

filter オプションは、 $site->get_bros() と $site->get_children() に渡されます。

PX=px2dthelper.get.realpath_theme_collection_dir

テーマコレクションディレクトリのパスを取得します。。

$ php .px_execute.php "/?PX=px2dthelper.get.realpath_theme_collection_dir"

PX=px2dthelper.get.all

Pickles 2 から複数の情報を一度に取得します。

$ php .px_execute.php "/?PX=px2dthelper.get.all&filter=false&path=/index.html"

filter オプションは、 $site->get_bros() と $site->get_children() に渡されます。

PX=px2dthelper.check_editor_mode

コンテンツの編集モードを取得します。

$ php .px_execute.php "/?PX=px2dthelper.check_editor_mode&path=/target/path.html"

PX=px2dthelper.search_sitemap

サイトマップ中のページを検索します。

limit オプションは、検索結果の最大件数を指定します。デフォルトは 200件です。

$ php .px_execute.php "/?PX=px2dthelper.search_sitemap&keyword=HOME&limit=10"

PX=px2dthelper.sitemap.create

新規サイトマップファイルを作成します。パラメータ filename に、作成するサイトマップのファイル名(拡張子は含まない)を指定します。

$ php .px_execute.php "/?PX=px2dthelper.sitemap.create&filename=foobar"

PX=px2dthelper.sitemap.delete

サイトマップファイルを削除します。パラメータ filename に、削除するサイトマップのファイル名(拡張子は含まない)を指定します。

$ php .px_execute.php "/?PX=px2dthelper.sitemap.delete&filename=foobar"

PX=px2dthelper.document_modules.build_css

CSSのソースコードが返されます。

$ php .px_execute.php /?PX=px2dthelper.document_modules.build_css

加えて、パラメータ theme_id を付与すると、テーマが定義するCSSのコードを返します。

PX=px2dthelper.document_modules.build_js

JavaScriptのソースコードが返されます。

$ php .px_execute.php /?PX=px2dthelper.document_modules.build_js

加えて、パラメータ theme_id を付与すると、テーマが定義するJavaScriptのコードを返します。

PX=px2dthelper.document_modules.load

CSSとJavaScriptをロードするHTMLソースコードが返されます。

$ php .px_execute.php /?PX=px2dthelper.document_modules.load

PX=px2dthelper.convert_table_excel2html

CSV や Excel形式で作られた表を元に、HTMLのテーブル要素を生成して出力します。パラメータ path には、 *.csv, *.xls, *.xlsx を指定できます。

$ php .px_execute.php "/?PX=px2dthelper.convert_table_excel2html&path=/path/to/sourcedata.xlsx"

PX=px2dthelper.init_content

コンテンツを初期化します。

$ php .px_execute.php "/path/init/content.html?PX=px2dthelper.init_content&editor_mode=html.gui"

v2.0.12 以降、このAPIは、すでにコンテンツが存在する場合には、上書きせずにエラーを返すようになりました。 force オプションが付加された場合は、強制的に上書きします。

v2.0.11 とそれ以前のバージョンでは、既存のコンテンツを上書きして初期化するのがデフォルトの挙動でした。

$ # forceオプションを付加した例
$ php .px_execute.php "/path/init/content.html?PX=px2dthelper.init_content&editor_mode=html.gui&force=1"

PX=px2dthelper.config.parse

設定ファイル(config.php)を解析し、解析できた値の一覧を返します。

PX=px2dthelper.config.update

設定ファイル(config.php)を解析し、解析できた値のうち任意の値を変更して上書きします。

$ php .px_execute.php "/path/to/target/page_path.html?PX=px2dthelper.config.update&base64_json=xxxxxxxxxxxx"

変更したい値は、 json (JSON形式の文字列) または base64_json (JSON形式の文字列を Base64に変換した文字列) のいずれかにセットして渡します。

$base64_json = base64_encode( json_encode( array(
	// config の項目で、上書きしたい情報をセットします。
	'values' => array(
		'name' => 'New Site Name',
	),

	// config の構造に合致しない設定項目は、`symbols` の中に分類されます。
	'symbols' => array(
		'theme_id' => 'new_theme_id', 
	),
) ) );

PX=px2dthelper.copy_content

コンテンツを複製します。

$ php .px_execute.php "/path/copy/to.html?PX=px2dthelper.copy_content&from=/path/copy/from.html"

または、

$ php .px_execute.php "/?PX=px2dthelper.copy_content&from=/path/copy/from.html&to=/path/copy/to.html"

v2.0.12 以降、このAPIは、すでにコンテンツが存在する場合には、上書きせずにエラーを返すようになりました。 force オプションが付加された場合は、強制的に上書きします。

v2.0.11 とそれ以前のバージョンでは、既存のコンテンツを上書きして初期化するのがデフォルトの挙動でした。

$ # forceオプションを付加した例
$ php .px_execute.php "/?PX=px2dthelper.copy_content&from=/path/copy/from.html&to=/path/copy/to.html&force=1"

PX=px2dthelper.change_content_editor_mode

コンテンツの編集モードを変更します。

$ php .px_execute.php "/path/to/target/page_path.html?PX=px2dthelper.change_content_editor_mode&editor_mode=html.gui"

PX=px2dthelper.plugins.get_plugin_options

プラグインオプションを取得します。

$ php .px_execute.php "/path/to/target/page_path.html?PX=px2dthelper.plugins.get_plugin_options&func_div=processor.html&plugin_name=namespace\\classname::funcname"

PX=px2dthelper.publish_single_page

指定されたページを単体でパブリッシュします。ページ固有のリソースディレクトリが同時にパブリッシュされます。

$ php .px_execute.php "/path/to/target/page_path.html?PX=px2dthelper.publish_single_page"

PX=px2dthelper.packages.get_path_composer_root_dir

composer.json が置かれているディレクトリのパスを取得する。

PX=px2dthelper.packages.get_path_npm_root_dir

package.json が置かれているディレクトリのパスを取得する。

PX=px2dthelper.packages.get_package_list

パッケージの一覧を取得する。

$ php .px_execute.php "/path/to/target/page_path.html?PX=px2dthelper.packages.get_package_list"

PX=px2dthelper.px2ce.gpi

PX=px2dthelper.px2me.gpi

PX=px2dthelper.px2te.gpi

それぞれ、Pickles 2 Contents Editor、Pickles 2 Module Editor、Pickles 2 Theme Editor のGPIを呼び出します。

次のオプションを指定できます。

appMode : web (デフォルト) または desktop
data : GPIに渡される引数。 JSON形式のテキストを base64エンコードして指定します。
data_filename : data の代わりに、JSONをファイルに保存して受け渡しします。ファイルは px-files/_sys/ram/data/ に置き、そのファイル名を指定してください。

PX=px2dthelper.px2ce.client_resources

PX=px2dthelper.px2me.client_resources

PX=px2dthelper.px2te.client_resources

それぞれ、 Pickles 2 Contents Editor、Pickles 2 Module Editor、Pickles 2 Theme Editor の、クライアントサイドで読み込むべきリソースの一覧を返します。

デフォルトでは、サーバー内部の絶対パスを返します。 dist パラメータにサーバー内部のディレクトリパスを渡すと、指定のディレクトリ内にコピーを作成し、そこからの相対パスを返すようになります。

PX=px2dthelper.custom_console_extensions

PX=px2dthelper.custom_console_extensions.XXXX.client_resources

PX=px2dthelper.custom_console_extensions.XXXX.gpi

PX=px2dthelper.custom_console_extensions_async_run

$conf->plugins->px2dt->customConsoleExtensions に登録された拡張機能へアクセスするAPIを提供します。第3引数の XXXX には、 Custom Console Extensions に登録したID(添字)を指定します。省略時には、登録されている拡張機能の一覧を返します。

PX=px2dthelper.get.path_theme_collection_dir

PX=px2dthelper.get.list_unassigned_contents

PX=px2dthelper.get.list_gui_editor_contents

PX=px2dthelper.get.list_all_contents

PX=px2dthelper.page.add_page_info_raw

PX=px2dthelper.page.get_page_info_raw

PX=px2dthelper.page.update_page_info_raw

PX=px2dthelper.page.move_page_info_raw

PX=px2dthelper.page.delete_page_info_raw

PX=px2dthelper.content.delete

PX=px2dthelper.contents_template.get_list

PX=px2dthelper.sitemap.filelist

PX=px2dthelper.sitemap.download

PX=px2dthelper.sitemap.upload

PX=px2dthelper.sitemap.csv2xlsx

PX=px2dthelper.sitemap.xlsx2csv

PX=px2dthelper.authorizer.is_authorized.XXXX

コマンドラインオプション

--role

ロール名。

更新履歴 - Change log