CakePHPで楽天APIを叩いてみる（3）コントローラー編
2019/03/04
ではCakePHPで楽天APIの3回目、コントローラー編です。
コントローラーでモデル及びコンポーネントを呼び出し、結果を取得するという流れです。
ページ送りに関する設定も行います。
ではコントローラー内容です。
app/controllers/products_controller.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
<?php App::import('Sanitize'); App::import('Vendor', 'include_path_vendors'); App::import('Vendor', 'Pager', array('file' => 'Pager-2.4.8' . DS . 'Pager.php')); class ProductsController extends AppController { // ヘルパー宣言 var $helpers = array('Html', 'Form', 'Time', 'Text', 'DateFormat'); // モデル宣言 var $uses = array('Product'); // コンポーネント宣言 var $components = array('string', 'RakutenApi'); /** * ＜楽天＞ 商品一覧 * */ function productlist() { //------------------------------------------------------------ // 検索条件 //------------------------------------------------------------ // 数字版「並び替え」条件配列を ProductModel より取得 $sort_option_array = $this->Product->sort_option_array; $this->set('sort_option_array', $sort_option_array); // 文字版「並び替え」条件配列を ProductModel より取得 $sort_option_str_array = $this->Product->sort_option_str_array; // 表示数を AppModel より取得 $list_limit = $this->Product->list_limit; //------------------------------------------------------------ // 検索オプション、文字列等の調整 //------------------------------------------------------------ // ジャンルコード検索用 if( !empty($this->params['url']['genre_id']) ) { $genre_id = Sanitize::clean($this->params['url']['genre_id']); } else { if(!empty($this->passedArgs['genre_id'])) { $genre_id = Sanitize::clean($this->passedArgs['genre_id']); } else { $genre_id = "0"; } } // ページ if( !empty($this->params['url']['page']) ) { $page = Sanitize::clean($this->params['url']['page']); } else { if(!empty($this->passedArgs['page'])) { $page = Sanitize::clean($this->passedArgs['page']); } else { $page = "1"; } } // 並び替え(ソート) if( !empty($this->params['url']['sort']) ) { $sort = Sanitize::clean($this->params['url']['sort']); } else { if(!empty($this->passedArgs['sort'])) { $sort = Sanitize::clean($this->passedArgs['sort']); } else { $sort = 1; } } // フリーワード検索用 if( !empty($this->params['url']['keyword']) ) { $gKeyword = $this->params['url']['keyword']; // 文字コード調査 $enc = mb_detect_encoding($gKeyword, 'SJIS,UTF-8'); if( $enc != Configure::read('App.encoding') ) { // UTF-8に変換 $this->params['url']['keyword'] = mb_convert_encoding($gKeyword, Configure::read('App.encoding')); } // stringコンポーネントで全角変換する $this->params['url']['keyword'] = $this->string->to_zen_katakana($this->params['url']['keyword']); } if( !empty($this->params['url']['keyword']) ) { $keyword = Sanitize::clean($this->params['url']['keyword']); } else { if(!empty($this->passedArgs['keyword'])) { $keyword = Sanitize::clean($this->passedArgs['keyword']); } else { $keyword = ""; } } // 検索キーワード $keyword_encoded = ""; if( !empty($keyword) ) { //「全角スペース」を「半角スペース」に変換 $keyword_encoded = mb_ereg_replace(' ', ' ', $keyword); } // 一覧件数 if( !empty($this->params['url']['get_list_limit']) ) { $get_list_limit = Sanitize::clean($this->params['url']['get_list_limit']); if( array_key_exists($get_list_limit, $list_limit) == FALSE ) { $get_list_limit = SEARCH_RESULT_LIST_LIMIT; } } else { if( !empty($this->passedArgs['get_list_limit']) ) { $get_list_limit = Sanitize::clean($this->passedArgs['get_list_limit']); if( array_key_exists($get_list_limit, $list_limit) == FALSE ) { $get_list_limit = SEARCH_RESULT_LIST_LIMIT; } } else { $get_list_limit = SEARCH_RESULT_LIST_LIMIT; } } //------------------------------------------------------------ // 検索条件まとめ //------------------------------------------------------------ $conditions = array( 'genreId' => $genre_id, 'hits' => $get_list_limit, 'page' => $page, ); // 検索ワードの指定がない場合、$conditionsに "keyword" があるとエラーになるので、ある場合だけ条件とする if( !empty($keyword_encoded) ) { $conditions["keyword"] = $keyword_encoded; } // 並び順 if( !empty($sort) ) { if( $sort == 2 ) { $sort_option_str_array["$sort"] = '+' . $sort_option_str_array["$sort"]; } $conditions["sort"] = $sort_option_str_array["$sort"]; } //------------------------------------------------------------ // コンポーネント化している楽天商品検索を実行 //------------------------------------------------------------ $item_ret = $this->RakutenApi->raku_item_search( $conditions ); // 2次元配列なのでバラす extract($item_ret); // ビューにセット $this->set('item_status', $ret_status); $this->set('item_search', $ret_item); $this->set('count', $ret_item["count"]); $this->set('keyword', $keyword_encoded); $this->set('genre_id', $genre_id); $this->set('sort', $sort_option_str_array["$sort"]); //------------------------------------------------------------ // ページング処理 //------------------------------------------------------------ // pathパラメータ $option_path = 'genre_id:' . $genre_id; if( !empty($keyword_encoded) ) { $option_path .= '/keyword:' . $keyword_encoded; } if( !empty($sort) ) { $option_path .= '/sort:' . $sort; } // 表示数 $option_path .= '/get_list_limit:' . $get_list_limit; if( $ret_item["count"] >= SEARCH_RESULT_LIST_LIMIT * 100 ) { // ページ送りを100がリミットとする $total_item_count = SEARCH_RESULT_LIST_LIMIT * 100; } else { // 100以下の場合 $total_item_count = $ret_item["count"]; } // Pager用パラメータ $p_options = array( 'totalItems' => $total_item_count, 'perPage' => SEARCH_RESULT_LIST_LIMIT, 'urlVar' => "page", 'path' => FULL_BASE_URL . '/raku/products/productlist/' . $option_path, 'append' => false, 'fileName' => "page:%d", 'currentPage' => $page, 'mode' => "Jumping", 'delta' => "8", 'separator' => "", 'spacesBeforeSeparator' => "", 'spacesAfterSeparator' => "", 'prevImg' => '<<', 'nextImg' => '>>', 'curPageLinkClassName' => "current", ); $pager =& Pager::factory($p_options); $navi = $pager->getLinks(); $this->set('navi', $navi["all"]); //-------------------------------------------------- // HTMLヘッダ内処理 //-------------------------------------------------- if( !empty($keyword_encoded) ) { // titleタグ $this->set('title_for_layout', '[' . SYSTEM_NAME_FRONT . '] 商品一覧 | ' . $keyword_encoded . ' | ' . $page . 'ページ'); // metaタグ内のdescription $this->set('description_for_layout', '検索ワード ' . $keyword_encoded . ' の商品一覧ページ ' . $page . ' ページ目です'); // metaタグ内のkeyword $this->set('keyword_for_layout', ''); } else { $this->set('title_for_layout', '[' . SYSTEM_NAME_FRONT . '] 商品一覧 | ' . $Current['genreName'] . ' | ' . $page . 'ページ'); $this->set('description_for_layout', 'ジャンル ' . $Current['genreName'] . ' 内の商品一覧ページ ' . $page . ' ページ目です'); $this->set('keyword_for_layout', ''); } } ?> |
では、解説。
3、4行目で、前回設置作成した、Pagerライブラリとインクルードパスを呼び出します。
21行目から、productlist アクションを作っていきます。
23?31行目で、モデルに設定したソート順を取得します。
34行目のAppModelに設定している内容は以下となりますが、もちろんこの内容は、productモデルに書いても問題ありません。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
/** * 一覧件数 * */ var $list_limit = array( "2" => "2件", "3" => "3件", "5" => "5件", "6" => "6件", "9" => "9件", "10" => "10件", "20" => "20件", "50" => "50件", "100" => "100件", ); |
36?155行で、GETで取得する各オプションのサニタイズと置き換えを行います。
前回書いたURLのサンプルを見れば分かりますが、/keyword:きーわーど/sort:1/ のようなURLとするので、
基本的に $this->passedArgs で取得したものに対して行えば問題無いと思います。
デフォルトの表示件数である SEARCH_RESULT_LIST_LIMIT には、app.php にて「9」件と設定しています。
160?181行目で、取得したオプション（条件）を配列にまとめます。
ソート順指定が2（itemPrice）の場合は、「+itemPrice」とするために、「+」を追加します。
186行目で、オプションを引数にコンポーネント化済APIを作動させます。
返り値の $item_ret を extract で分解し、必要な変数/配列をビューにセット。
202行目からはページ送り用の設定です。
ページ番号をクリックした際に送られるURLのpathパラメータを設定。
パラメータには genre_id、keyword、sort、get_list_limitを指定します。
218行目からは、取得するアイテム数がやたらとある場合に備えて、最大ページ数を100ページとする処理を行います。
230行目から、PEAR Pager用設定を行います。
以下の様な内容です。
totalItems：対象となるアイテム数(itemDataが未指定の場合に使用)
perPage：1ページごとに表示されるアイテム数
urlVar：ページ番号を示すためのクエリ変数名(デフォルトは「pageID」)
path：ページへの絶対パス(ページ名は除く)
append：TRUEならpageIDはクエリ文字列としてURLに追加。FALSEならfileNameに従ってURLに埋め込まれる(デフォルトは「TRUE」)
fileName：ページ名。appendがTRUEなら"%d"
currentPage：初期ページ番号
mode：動作モードを指定。ジャンプ型(Jumping)又はスライド型(Sliding)
delta：現在のページの前後に表示するページ番号の数
separator：ページ番号を分けるための区切り文字。カンマやハイフンの他にタグも可能
spacesBeforeSeparator：区切り文字の前のスペース数
spacesAfterSeparator：区切り文字の後のスペース数
prevImg：前のページのリンクである「<<」の代替文字。タグも可能
nextImg：のページのリンクである「&lgt;>」の代替文字。タグも可能
curPageLinkClassName：現在のページのリンクのスタイルのためのCSSクラス
248行目でインスタンス化、249行目の getLinksメソッドで「連想配列として戻る/次/最初/最後のリンクとページリンク」を取得し、ビューにセットします。
255行目以降は、HTMLタイトルの設定処理です。SEOに考慮して作成しましたが、成果の方は疑わしいので、無視していただいて構いません。
駆け足でしたが、コントローラーは以上です。
ページ送り処理にちょっと頭を捻りましたが、その他は目新しい処理もなく、CakePHPerでしたら一目瞭然だと思います。
[tgAmazonItemLookup asin="4798033146" related="1"]