PHP拡張オブジェクト


概要

どこどこJP(v3) PHP 機能拡張ライブラリを使用する事で新たな機能が追加されます。
このライブラリはPHP5を対象としたオブジェクトファイルで、“docodoco.class.php” のラッパークラスです。 (JavaScript版はこちら

注意点

当ファイルで提供する機能はドラフト(草案)となります。その為、常に最新版をご利用することをお薦めいたします。
ご利用には、こちらのファイルが必要となります。
また、以下の事を弊社は自由におこなえるものとします。

  • 改変・修正
  • 公開停止
  • 製品版への採用
  • 提供方法の変更

ライセンス

履歴

履歴を記載しています。

Version 日付 詳細
1.0.0 2010/08/25 公開 -

ダウンロード

実装例

                <?
                require_once( "docodoco.extend.class.php" );
                
                $obj = new extDocodocoJP( "APIキー1", "APIキー2" );    // $objは任意の変数名
                $obj->GetAttribute();
                
                echo $obj->PrefJName;
                ?>
            

このスクリプトは成功時に以下のように出力します。

 

コンストラクタ

コンストラクタについての解説です。

コンストラクタ 説明
extDocodocoJP( [string $key1, string $key2] ) どこどこJP ライブラリのコンストラクタ
  • $key1:APIキー1
  • $key2:APIキー2

プロパティ

プロパティについての解説です。

プロパティ 説明
Config protected array どこどこJPに接続に必要な設定
Status protected array 接続ステータス
各種判定値名 public string プロパティはセットパラメータ及び、 RESTのリターンパラメータに準じる

関数

関数についての解説です。

関数 戻り値 説明
SetPlugin( mixed $extend ) void 追加機能のセット。セットパラメータ参照
GetAttribute( [string $return, mixed $extend] ) mixed どこどこJPの値取得

セットパラメータ

セットパラメータについての解説です。

種類 パラメータ名 説明 値、サンプル
都道府県 StateJName 都道府県付き日本語表記取得
地方 RegionalLCode 大分類コード取得
RegionalLJName 大分類日本語表記取得
RegionalSCode 小分類コード取得
RegionalSJName 小分類日本語表記取得
組織 OrgPrefAName 都道府県取得(都道府県付き日本語表記)
OrgCityAddress 市区町村以下の住所取得
回線 LineCategory 分類コード取得
LineCategoryJName 分類日本語表記取得

使用例

                <?
                require_once( "docodoco.extend.class.php" );
                
                $plugin = array( "StateJName",
                                 "RegionalLCode",
                                 "RegionalLJName",
                                 "RegionalSCode",
                                 "RegionalSJName",
                                 "OrgPrefAName",
                                 "OrgCityAddress",
                                 "LineCategory",
                                 "LineCategoryJName"
                               );
                
                $obj = new extDocodocoJP( "APIキー1", "APIキー2" );    // $objは任意の変数名
                $obj->SetPlugin( $plugin );
                $obj->GetAttribute();
                ?>
            

docodoco.class.php”も参考にしてください。



Page Top