PHP基本オブジェクト


概要

どこどこJP(v3)　PHP ライブラリを使用する事で簡単に判定値にアクセスする事が可能となります。 このライブラリはPHP5を対象とした、オブジェクトファイルです。

ライセンス

履歴

変更履歴を記載しています。

Version 日付 詳細
1.0.2 2011/08/24 改修 GetAttribute関数の改修
1.0.1 2010/09/02 改修 コンストラクタにパラメータ追加
GetAttribute、GetArray関数の改修
1.0.0 2010/08/25 公開 -

ダウンロード

実装例

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

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

　

コンストラクタ

ライブラリについての解説です。

コンストラクタ 説明
DocodocoJP( [string $key1, string $key2, boolean $exe] ) どこどこJP ライブラリのコンストラクタ
  • $key1：APIキー1
  • $key2：APIキー2
  • $exe：自動実行（true/default:false）

プロパティ

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

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

関数

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

関数 戻り値 説明
SetKey1( string $key1 ) boolean 成否 どこどこ APIキー1をセット
SetKey2( string $key2 ) boolean 成否 どこどこ APIキー2をセット
SetKey( array $apikey ) boolean 成否 どこどこ APIキー1、APIキー2をセット
$apikey
  • key1：APIキー1
  • key2：APIキー2
SetIp( string $ip ) boolean 成否 検索対象のIPアドレスのセット
SetChar( string $character ) boolean 成否 文字コードのセット
$character
  • JIS
  • Shift_JIS
  • EUC-JP
  • UTF-8
SetConfig( array $config ) boolean 成否 APIキー、検索IPアドレス、文字コードのセット
$config
  • key1：APIキー1
  • key2：APIキー2
  • ip：検索IP
  • char：文字コード
GetAttribute( [string $return] ) mixed 成否/結果 どこどこJPの値取得
  • $return：array（結果を連想配列で受け取る）
GetArray() array 判定結果 判定結果を連想配列で取り出す
GetStatusCode() integer コード ステータスコードの取得
GetStatusMessage() string メッセージ ステータスメッセージの取得
GetStatus() array ステータス ステータスを連想配列で取得

使用例

IPアドレスの検索

                <?
                require_once( "docodoco.class.php" );
                
                $obj = new DocodocoJP();
                $obj->SetKey( array( "key1" => "APIキー1",
                                     "key2" => "APIキー2"
                                   ));
                $obj->SetIp( "210.251.250.30" );
                $obj->GetAttribute();
                
                echo $obj->OrgName;
                ?>

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

サイバーエリアリサーチ株式会社

判定値をShift_JISの配列で受け取る

                <?
                require_once( "docodoco.class.php" );
                
                $obj = new DocodocoJP();
                $obj->SetConfig( array( "key1" => "APIキー1",
                                        "key2" => "APIキー2",
                                        "char" => "Shift_JIS"
                                       ));
                $obj->GetAttribute();
                $hoge = $obj->GetArray();
                
                echo $hoge["CityJName"]."<br />\n";
                ?>

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

　

複数のIPアドレスを検索する

                <?
                require_once( "docodoco.class.php" );
                
                $ipaddr = array( "120.137.170.1",
                                 "120.137.170.2",
                                 "120.137.170.3"
                               );
                
                $obj = new DocodocoJP( "APIキー1", "APIキー2" );
                $obj->SetChar( "EUC-JP" );
                
                foreach ( $ipaddr as $value ) {
                    $obj->SetIp( $value );
                    $hoge[] = $obj->GetAttribute( "array" );
                }
                
                echo $hoge[0]["IP"]."｜".$hoge[0]["PrefJName"]."<br />\n";
                echo $hoge[1]["IP"]."｜".$hoge[1]["PrefJName"]."<br />\n";
                echo $hoge[2]["IP"]."｜".$hoge[2]["PrefJName"]."<br />\n";
                ?>

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

120.137.170.1｜北海道
120.137.170.2｜青森
120.137.170.3｜岩手



Page Top