Download the PHP package zonuexe/kenall without Composer
On this page you can find all versions of the php package zonuexe/kenall. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kenall
Kenall.php - ケンオール非公式APIクライアント
PHP向けのケンオール 📮 郵便番号・住所検索APIの非公式クライアントです。このパッケージは個人によって開発されており、Open Collector, Inc.が提供するものではありません。
このパッケージは開発の初期段階であり、現状有姿・無保証として提供されます。通常の用途で利用するための基本的な機能は実装していますが、エラーハンドリングなどは未実装です。機能追加などのPull Requestを歓迎します。
このパッケージを利用して郵便番号検索するにはケンオール ホームからAPIキーを取得する必要があります。
Install
Composerを利用します。
このパッケージではphp-http/discoveryを用いてインストール済みのPSR-HTTPパッケージを利用します。
使用時に以下のようなエラーが発生する場合はパッケージが不足しています。
以下の仮想パッケージからそれぞれ好きな組み合わせをComposerでインストールしてください。
もしGuzzleを利用しているなら以下のようなコマンドで最新版にアップデートできるかもしれません。
API
function find(string $postal_code): AddressResolverResponse
難しいことを考えずに郵便番号検索したいひと向けの関数です。
関数を呼び出す前に環境変数 'KENALL_AUTHORIZATION_TOKEN' をセットする必要があります。また、内部的には後述する create_client() の結果をキャッシュしています。
引数の string $postal_code は文字列型で7桁の数字である必要があります。
function create_client(string $api_key): KenallClient
APIクライアントのインスタンスを取得し、オブジェクト指向的に操作したい人向けの関数です。
内部ではphp-http/discoveryを用いてPSR-18 Http Client および、PSR-17 Http Factory の実装クラスを探索して自動検出します。
class KenallClient
ケンオールへのAPIリクエストを行なうクライアントクラスです。
findPostalCode(string $postal_code): AddressResolverResponse- ケンオールの
GET /postalcode/:郵便番号APIに対応します - 引数の
string $postal_codeは文字列型で7桁の数字である必要があります。
- ケンオールの
class AddressResolverResponse
ケンオールの GET /postalcode/:郵便番号 APIから返される値に対応したオブジェクトです。
このオブジェクトは ArrayAccess およびイテレータを実装しており、配列や foreach でのデータの取り出しに対応しています。これらの方法で Address を取得することができます。
class Address (郵便区画レコード)
一般的な意味での「住所」に相当するクラスです。プロパティはケンオールのドキュメントに準じています。
使用のためのヒント
初心者向け
ケンオールから取得できるAPIキーを環境変数 KENALL_AUTHORIZATION_TOKEN としてセットしておいてください。
中級者向け
この方法で利用する場合、トークンは環境変数にセットする必要はありません。
上級者向け
上記の方法をそのままコードに組み込んだ場合、ユニットテストなどでケンオールAPIにリクエストしてしまうリスクがあります。PSR-18対応のHTTPクライアントクラスを注入することでテスト時のHTTPクライアントを差し替えることができます。
あるいはPHP-HTTP Discoveryのドキュメントを参考にMockClientをセットすることで実装コードに手を入れずにHTTPクライアントを避けることも可能です。
Copyright
Copyright 2021 USAMI Kenta
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
All versions of kenall with dependencies
php-http/discovery Version ^1.13
psr/http-client Version ^1.0
psr/http-factory Version ^1.0