PHPackages pickles2/px2agent - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. pickles2/px2agent ActiveLibrary[API Development](/categories/api) pickles2/px2agent ================= Pickles 2 と PHP スクリプトを仲介するAPIを提供します。 0.2.0(2y ago)04.1k3MITPHPPHP >=7.3.0 Since Aug 12Pushed 2y ago3 watchersCompare [ Source](https://github.com/pickles2/php-px2agent)[ Packagist](https://packagist.org/packages/pickles2/px2agent)[ RSS](/packages/pickles2-px2agent/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (5)Versions (10)Used By (3) php-px2agent ============ [](#php-px2agent) **pickles2/px2agent** は、[Pickles 2](https://pickles2.pxt.jp/) と PHP スクリプトを仲介するAPIを提供します。 Linux Windows master [![](https://camo.githubusercontent.com/8b33962f17c0ecc0674d265b27ba6dde0a4a94707ce67bbd44d6e7790ceb164d/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f7069636b6c6573322f7068702d7078326167656e742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/pickles2/php-px2agent) [![](https://camo.githubusercontent.com/a42a65b33f36ae7459146d8a3ff47b11d02f849d78e88d8da925e114d4ba2d0b/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f3774626739643766623879766234696a2f6272616e63682f6d61737465723f7376673d74727565)](https://ci.appveyor.com/project/tomk79/php-px2agent) develop [![](https://camo.githubusercontent.com/6e342dccf6acb14667ec637f9d7c6fdebbe3b32407ebfffd44c81299999848c5/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f7069636b6c6573322f7068702d7078326167656e742e7376673f6272616e63683d646576656c6f70)](https://travis-ci.org/pickles2/php-px2agent) [![](https://camo.githubusercontent.com/397e9167cca0238ba209c48f7289b50b6a0e17826f4eec21dd7d9ecfb78ceeb1/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f3774626739643766623879766234696a2f6272616e63682f646576656c6f703f7376673d74727565)](https://ci.appveyor.com/project/tomk79/php-px2agent) インストール - Installation --------------------- [](#インストール---installation) ``` $ composer require pickles2/px2agent; ``` 使い方 - Usage ----------- [](#使い方---usage) ``` $px2agent = new picklesFramework2\px2agent\px2agent(); $px2proj = $px2agent->createProject('/path/to/.px_execute.php'); /** * Pickles 2 にクエリを投げて、結果を受け取る (汎用) */ $data = $px2proj->query('/?PX=phpinfo', array( "output": "json", )); /** * PXコマンドを実行する */ $result = $px2proj->px_command( 'publish.run', '/index.html', array('path_region' => "/region/") ); /** * バージョン番号を取得する */ $value = $px2proj->get_version(); /** * configデータを取得する */ $value = $px2proj->get_config(); /** * サイトマップデータを取得する */ $value = $px2proj->get_sitemap(); /** * pathまたはidからページ情報を得る */ $value = $px2proj->get_page_info('/'); /** * 親ページのIDを取得する */ $value = $px2proj->get_parent('/sample_pages/'); /** * 子階層のページの一覧を取得する */ $value = $px2proj->get_children('/'); /** * 子階層のページの一覧を、filterを無効にして取得する */ $value = $px2proj->get_children('/', array('filter' => false)); /** * 同じ階層のページの一覧を取得する */ $value = $px2proj->get_bros('/sample_pages/'); /** * 同じ階層のページの一覧を、filterを無効にして取得する */ $value = $px2proj->get_bros('/sample_pages/', array('filter' => false)); /** * 同じ階層の次のページのIDを取得する */ $value = $px2proj->get_bros_next('/sample_pages/'); /** * 同じ階層の次のページのIDを、filterを無効にして取得する */ $value = $px2proj->get_bros_next('/sample_pages/', array('filter' => false)); /** * 同じ階層の前のページのIDを取得する */ $value = $px2proj->get_bros_prev('/sample_pages/'); /** * 同じ階層の前のページのIDを、filterを無効にして取得する */ $value = $px2proj->get_bros_prev('/sample_pages/', array('filter' => false)); /** * 次のページのIDを取得する */ $value = $px2proj->get_next('/sample_pages/'); /** * 次のページのIDを、filterを無効にして取得する */ $value = $px2proj->get_next('/sample_pages/', array('filter' => false)); /** * 前のページのIDを取得する */ $value = $px2proj->get_prev('/sample_pages/'); /** * 前のページのIDを、filterを無効にして取得する */ $value = $px2proj->get_prev('/sample_pages/', array('filter' => false)); /** * パンくず配列を取得する */ $value = $px2proj->get_breadcrumb_array('/sample_pages/'); /** * ダイナミックパス情報を得る */ $value = $px2proj->get_dynamic_path_info('/sample_pages/'); /** * ダイナミックパスに値をバインドする */ $value = $px2proj->bind_dynamic_path_param('/dynamicPath/{*}', array('' => 'abc.html')); /** * role を取得する */ $role = $px2proj->get_role('/sample_pages/actor1.html'); /** * Actor のページID一覧を取得する */ $actors = $px2proj->get_actors('/sample_pages/role.html'); /** * get home directory path */ $value = $px2proj->get_realpath_homedir(); /** * コンテンツルートディレクトリのパス(=install path) を取得する */ $value = $px2proj->get_path_controot(); /** * DOCUMENT_ROOT のパスを取得する */ $value = $px2proj->get_realpath_docroot(); /** * get content path */ $value = $px2proj->get_path_content('/'); /** * ローカルリソースディレクトリのパスを得る */ $value = $px2proj->path_files('/', '/images/sample.png'); /** * ローカルリソースディレクトリのサーバー内部パスを得る */ $value = $px2proj->realpath_files('/', '/images/sample.png'); /** * ローカルリソースのキャッシュディレクトリのパスを得る */ $value = $px2proj->path_files_cache('/', '/images/sample.png'); /** * ローカルリソースのキャッシュディレクトリのサーバー内部パスを得る */ $value = $px2proj->realpath_files_cache('/', '/images/sample.png'); /** * コンテンツ別の非公開キャッシュディレクトリのサーバー内部パスを得る */ $value = $px2proj->realpath_files_private_cache('/', '/images/sample.png'); /** * domain を取得する */ $value = $px2proj->get_domain(); /** * directory_index(省略できるファイル名) の一覧を得る */ $value = $px2proj->get_directory_index(); /** * 最も優先されるインデックスファイル名を得る */ $value = $px2proj->get_directory_index_primary(); /** * ファイルの処理方法を調べる */ $value = $px2proj->get_path_proc_type('/sample_pages/'); /** * リンク先のパスを生成する */ $value = $px2proj->href('/sample_pages/'); /** * パスがダイナミックパスにマッチするか調べる */ $value = $px2proj->is_match_dynamic_path('/sample_pages/'); /** * ページが、パンくず内に存在しているか調べる */ $value = $px2proj->is_page_in_breadcrumb('/sample_pages/', '/'); /** * 除外ファイルか調べる */ $value = $px2proj->is_ignore_path('/sample_pages/'); /** * パブリッシュする */ $output = $px2proj->publish( array( "path_region" => "/path/region/", "paths_region" => array( "/path/region1/", "/path/region2/" ), "paths_ignore" => array( "/path/region/ignored/1/", "/path/region/ignored/2/" ), "keep_cache" => 1, ) ); /** * キャッシュを削除する */ $output = $px2proj->clearcache(); ``` ### PHPバイナリのパスを指定する場合 - Specifying path to PHP binary [](#phpバイナリのパスを指定する場合---specifying-path-to-php-binary) ``` $px2agent = new picklesFramework2\px2agent\px2agent( array( 'bin' => '/path/to/php', 'ini' => '/path/to/php.ini', 'extension_dir' => '/path/to/ext/', ) ); $px2proj = $px2agent->createProject('/path/to/.px_execute.php'); ``` 開発者向け情報 - for developers ------------------------ [](#開発者向け情報---for-developers) ### 開発環境セットアップ - Setting up development environment [](#開発環境セットアップ---setting-up-development-environment) ``` $ cd {$project_root} $ composer install ``` ### テスト - Test [](#テスト---test) ``` $ composer test ``` ### ドキュメント出力 - JSDoc [](#ドキュメント出力---jsdoc) ``` $ composer run-script documentation ``` 更新履歴 - Change log ----------------- [](#更新履歴---change-log) ### pickles2/px2agent v0.2.0 (2023年6月25日) [](#pickles2px2agent-v020-2023年6月25日) - PHP 8.2 に対応した。 ### pickles2/px2agent v0.1.0 (2022年1月8日) [](#pickles2px2agent-v010-2022年1月8日) - サポートするPHPのバージョンを `>=7.3.0` に変更。 - PHP 8.1 に対応した。 ### pickles2/px2agent v0.0.4 (2022年1月3日) [](#pickles2px2agent-v004-2022年1月3日) - PHPコマンドのパスが引き回されない不具合を修正。 ### pickles2/px2agent v0.0.3 (2021年1月16日) [](#pickles2px2agent-v003-2021年1月16日) - `$pj->query()` に、新しいオプション `method`、 `body`、 `body_file` を追加。 ### pickles2/px2agent v0.0.2 (2020年12月19日) [](#pickles2px2agent-v002-2020年12月19日) - Windows で、コマンド中に `%` が含まれる場合に失敗する問題を修正。 ### pickles2/px2agent v0.0.1 (2020年8月12日) [](#pickles2px2agent-v001-2020年8月12日) - Initial Release. ライセンス - License --------------- [](#ライセンス---license) MIT License 作者 - Author ----------- [](#作者---author) - (C)Tomoya Koyanagi - website: - Twitter: @tomk79 ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity21 Limited adoption so far Community13 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~174 days Recently: every ~222 days Total 7 Last Release 1059d ago PHP version history (2 changes)0.0.1PHP >=5.4.0 0.1.0PHP >=7.3.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/00ca3b0b7c69b5a8c25bbfb82b305ab94c4fc7458b38df445cbb97acc073875f?d=identicon)[tomk79](/maintainers/tomk79) --- Top Contributors [![tomk79](https://avatars.githubusercontent.com/u/584845?v=4)](https://github.com/tomk79 "tomk79 (24 commits)") --- Tags pickles2 ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/pickles2-px2agent/health.svg) ``` [![Health](https://phpackages.com/badges/pickles2-px2agent/health.svg)](https://phpackages.com/packages/pickles2-px2agent) ``` ### Alternatives [twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk PHP SDK for Facebook Business 90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 74513.7M114](/packages/meilisearch-meilisearch-php)[google/common-protos Google API Common Protos for PHP 173103.7M50](/packages/google-common-protos)[hubspot/api-client Hubspot API client 23914.2M16](/packages/hubspot-api-client)[botman/driver-telegram Telegram driver for BotMan 92437.3k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)