質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.33%

  • PHP

    21353questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • API

    1605questions

    APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

  • FuelPHP

    533questions

    FuelPHPは、軽量高速で開発が可能なPHPのWebアプリケーションフレームワークです。

[FuelPHP]外部APIサービスにリクエストを送る時のパラメタの設定について

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 607

yoshiky

score 96

お世話になってます。
ある外部のサービスに、FuelPHPを使ってAPI経由で情報を取得したり、更新する処理を実装することになりましたが、
どのようにクラス設計をしたらいいか分からずに困っております。

取り急ぎ自分が考えた構成を下記に記します。主に使うのはcontrollerとapiとserviceです。

app/
...
├── classes
│   ├── controller
│   │   ├── sample.php  // apiを呼び出す処理を書く
│   ├── model
│   ├── api
│   │   ├── base.php    // 基底クラス。curlリクエストの実行やオプションの設定などの共有処理を書く
│   │   ├── sample.php  // コントローラが呼び出す
│   └── service
        ├── update.php  // api/sample.php が呼び出す、具体的な処理を実装する
        └── read.php
├── config
...
└── views
# かなり大まかな各クラスの主な処理

Class Controller_Sample extends Controller {

    $return = Api_Sample::method($params)  // 何らかのパラメータを$paramsとして渡し、結果を受け取る

}


Class Api_Sample($params) {

    $return = Service_Read::method($params);  // Serviceの呼び出し(わざわざServiceを挟む必要性も無い気がしますが。。)
}


Class Service_Read($params) {

    $return = Api_Base::execute($params)  // Apiを実行し外部サービスにリエクストを送って、レスポンスを得る

}

どういう構成にしたら良いか、具体的に分からない点は、
外部サービスが提供しているAPIを利用する場合、リクエストにパラメタをセットすると思います。
(例えば識別IDや契約ID,ユーザIDなど)。これらはconfigに定義してConfig::getなどで読み込めばいいと思いますが、読み込んだ値はどこでセットするのがいいでしょうか。

パラメタの数が70項目近くあるため、専用クラスを作った方がいいと思いますが、そのクラスの使い方が分からず、、
単純にclassesの下にformディレクトリを設け、その中に処理単位のクラスを作ってsetter/getterを定義して、api/sampleクラスからnewで呼び出すだけでいいのでしょうか。

大雑把で分かりにくいと思いますが、何かしらでもアドバイスいただけると助かります。
不明点があれば追記します。
何卒よろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

0

ディレクトリ構造的にふと疑問に思えたので、
FuelPHP 自作クラスを呼び出すとかのメモ - Qiita
FuelPHP で自作関数みたいなファイルはどこに置いたら良いか - Qiita
とか参考になりますでしょうか。

MVCモデルと関係ないクラス設計の場合、
Moduleとして置いちゃったほうがいいような気もするけど、
どっちでもできちゃうので「お好み」でどうぞ。

パラメータが70近くあるってのは不毛ですね、
必要に応じて階層化した連想配列で与えるとか、
目的に応じてパラメータを分類して、
小分けした分類ごとにパラメータを引き渡すとか、
きれいな実装ができるといいですね。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/02/10 14:24

    返信が遅くなり失礼しました。

    ご回答ありがとうございます。リンク先の記事を見ました。参考にさせていただきます。

    70項目のリクエストパラメタは例として悪かったかもですが(実際にあるのですが。。)、パラメタセット自体はよくある処理なので、集合知としてどこかにないかなと探しましたが、ないですね。。
    取り急ぎ classes/api/sample.php にリクエスト/レスポンスパラメタを定数で定義して、配列のvalueとして扱うことにしました。
    後でリファクタリングするかもですが。。

    キャンセル

同じタグがついた質問を見る

  • PHP

    21353questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • API

    1605questions

    APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

  • FuelPHP

    533questions

    FuelPHPは、軽量高速で開発が可能なPHPのWebアプリケーションフレームワークです。