PXコマンド

PXコマンドは、Pickles Frameworkの独自の機能を提供するインターフェイスです。Pickles FrameworkやPHPの設定を確認する、ページやコンテンツの情報を確認するといった情報サービスや、キャッシュのクリア、パブリッシュなどの機能もこれに含まれます。

実行方法

URLにパラメータ ?PX={$PXコマンド名} を付加して起動します。

PXコマンド一覧

api
外部のアプリケーションと通信するためのAPIを提供する。
clearcache
Pickles Framework が作成するキャッシュファイルをクリアする。
config
Pickles Framework のコンフィグ内容を確認する。
edit
カレントページのコンテンツソースを直接編集する。
fillcontents
サイトマップに記載された content の情報を元に、未作成のコンテンツの空ファイルを作成する。
initialize
データベースなど初期構築を実行する。
pageinfo
カレントページのページ情報を表示する。
phpinfo
phpinfo() を実行し、PHPの設定情報を確認する。
plugins
プラグインが提供するPXコマンドインターフェイスを呼び出す。
publish
静的なファイル群にパブリッシュする。
rdb
データベースの内容を閲覧・操作する。
sitemap
サイトマップを表示する。
sitemap_definition
サイトマップ定義を表示する。
themes
テーマの一覧を表示する。

PX=api の詳細

PX=api は、外部のツール等から Pickles Framework 内のファイルを操作することを主な目的として設計されました。
次に示すので、PX=api が持つ機能の一覧です。

api.dlfile.config
コンフィグファイル(mainconfig.ini) をダウンロードする。
api.dlfile.sitemap_definition
サイトマップ構造定義ファイル(sitemap_definition.csv) をダウンロードする。
api.dlfile.content
コンテンツディレクトリ内の任意のファイルをダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.dlfile.sitemap
サイトマップディレクトリ内の任意のファイルをダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.dlfile.theme.(テーマID)
指定のテーマIDのディレクトリ内の任意のファイルをダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ulfile.config
コンフィグファイル(mainconfig.ini) をアップロードする。
api.ulfile.sitemap_definition
サイトマップ構造定義ファイル(sitemap_definition.csv) をアップロードする。
api.ulfile.content
コンテンツディレクトリ内の任意のファイルをアップロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ulfile.sitemap
サイトマップディレクトリ内の任意のファイルをアップロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ulfile.theme.(テーマID)
指定のテーマIDのディレクトリ内の任意のファイルをアップロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ulfile.px
_PXディレクトリ内の任意のファイルをアップロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ls.content
コンテンツディレクトリ内の任意のパスに格納されたファイルの一覧をダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。ただし、_PXディレクトリ、/_px_execute.php, /.htaccess は一覧から取得することはできない。
api.ls.sitemap
サイトマップディレクトリ内の任意のパスに格納されたファイルの一覧をダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ls.theme.(テーマID)
指定のテーマIDのディレクトリ内の任意のパスに格納されたファイルの一覧をダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.ls.px
_PXディレクトリ内の任意のパスに格納されたファイルの一覧をダウンロードする。対象とするファイルのパスは、pathパラメータに指示する。
api.delete.content
コンテンツディレクトリ内の任意のファイルやディレクトリを削除する。対象とするファイルのパスは、pathパラメータに指示する。
api.delete.sitemap
サイトマップディレクトリ内の任意のファイルやディレクトリを削除する。対象とするファイルのパスは、pathパラメータに指示する。
api.delete.theme.(テーマID)
指定のテーマIDのディレクトリ内の任意のファイルやディレクトリを削除する。対象とするファイルのパスは、pathパラメータに指示する。
api.delete.px
_PXディレクトリ内の任意のファイルやディレクトリを削除する。対象とするファイルのパスは、pathパラメータに指示する。
api.get.version
PxFWのバージョン番号を返す。
api.get.config
PxFWが読み込んだコンフィグの内容を返す。
api.get.sitemap
サイトマップ配列全体を返す。
api.get.sitemap_definition
サイトマップ定義を返す。
api.hash
フレームワーク管理下のすべてのファイルやディレクトリと、そのハッシュ値の一覧を出力する。text/csv の出力のみ。

下記のパラメータを併用することができます。

bin
アップロードするファイルの内容。api.ulfileでのみ使用可能。
path
対象とするファイルのパス。コンテンツやサイトマップなど、複数のファイルや階層の概念を持った対象の場合に付加する。content, sitemap, theme をアップロード、ダウンロード、削除する場合に使用。
type
形式をXML(デフォルト), JSON, JSONP の中から指定します。api.dlfile 以外で使用可能。
callback
JSONPのコールバック関数名を指定する。デフォルトは callback。typeにJSONPを指定した場合に使用可能。

<前へ | 次へ>

次期バージョン Pickles 2 を公開しました。もっと詳しく