GuzzleHttpで取得数に上限があるAPIデータを、繰り返しリクエストして全件取得したいがreturnすると空になる

Question

表題の件です。
取得数に300件という上限のあるAPIデータを繰り返しリクエストすることで300件ずつ全件取得したいと考えております。
APIは、リクエストが返ってきた時にhasMoreがtrueならばさらにデータが存在することを意味します。その時、nextPageTokenも発行され、urlにtokenをつけて再リクエストすることで次のデータが取得できる仕様になっています。

Laravelのartisanコマンドを使い、以下のGetDataクラスを実行し試みました。全ての取得が終わり、hasMoreがtrueでなくなったときにreturnして値を返すようにしています。しかし、返ってきた値はどうしても空になってしまいます。return直前のprint_r($allrecords)をチェックすると問題なく全件取得できているのですが、returnして返ってきた値は空です。
どういう現象なのか理解できす、解決方法も分かりません。拙い説明で申し訳ありません。
別のクラスへ値を渡し、データを加工→別システムにあるデータを更新、ということをしたいと考えております。どうかご教授お願い致します。同期、非同期が関係するのかと考えましたが、全然詳しくなく手を出せずにいます。

  	public function GetData () {
  		$Data = $this->searchData('','');
  		print_r($Data);　　//これは空になってしまいます

  	}

	public function searchData ($opt_records, $nextPageToken) {

		if (isset($opt_records)) {
			$allrecords = $opt_records;
		}else{
			$allrecords = [];
		}
		$limit = 300;
		$url = "https://api.abc.com/v2.0/xxxx/search?range=all&limit=".$limit;
		$method = "GET";
		$token = 'xxxxxxxxxxxxxxxxxxx';
		if ($nextPageToken) {
            $url = $url.$nextPageToken;
        }

		//接続
        $client = new Client();
        $response = $client->request($method, $url,[
            'headers' => [
              'X-xxxxxx-Api-Key' => $token
            ],
        ]);

        //エラーの場合
		if ($response->getStatusCode() !== 200) {
            $this->log("searchData error:" . print_r($response, true));
            return $allrecords;
        }
        if($response->getStatusCode() == 200){
			$posts = $response->getBody();
        	$posts = json_decode($posts, true);

        	if (!$allrecords) {
        		$allrecords = $posts['data'];
        	}else{
        		$allrecords = array_merge($allrecords,$posts['data']);
        	}

	        if ($posts['hasMore'] == 1 || $posts['nextPageToken']) {
	        	$nextPageToken = '&nextPageToken='.$posts['nextPageToken'];
	        	$this->searchSansanData($allrecords,$nextPageToken);     	
	        }else{
	        	print_r($allrecords);  //ここで取得できていることは確認できました
	        	return $allrecords; //returnすると空になってしまいます
	        }

	    }

	}

Answer 1

再現することが考えにくい不具合なので，勘違いしている可能性をまず疑ってください。

• 関数内部の print_r() で表示と，関数外部の print_r() で表示は，どちらも1回のリクエストで一気に表示されたものでしょうか？連続した別々のリクエストで表示されたものではありませんか？

勘違いしている可能性としては↑が一番濃厚だと思います。
適当にリファクタリングしてみます，参考までに↓

protected $client;

public function __construct()
{
    // 共通部分はこういうところでセットしておくとやりやすい
    // （理想を言うと ServiceProvider からコンストラクタ引数として注入したほうがユニットテストは書きやすかったりするがここでは簡略化）
    $this->client = new Client([
        'base_uri' => 'https://api.sansan.com/v2.0/',
        'headers' => [
            'X-Sansan-Api-Key' => 'xxxxxxxxxxxxxxxxxxx',
        ],
    ]);
}

public function searchAllData()
{
    // 再帰呼び出しよりはループのほうがいいかも
    $posts = [];
    $nextPageToken = null;

    do {
        $result = $this->sendRequest($nextPageToken);
        $posts = array_merge($posts, $result['data']);
    } while ($nextPageToken = $result['nextPageToken']);

    return $posts;
}

protected function sendRequest($nextPageToken = null)
{
    // クエリストリングは query オプションで連想配列形式で指定できる
    $options = [
        'query' => [
            'range' => 'all',
            'limit' => 300,
        ],
    ];

    if ($nextPageToken) {
        $options['query']['nextPageToken'] = $nextPageToken;
    }

    // Guzzle は 200 系以外は Exception をスローするのでステータスコードのチェックは不要
    // （必要に応じて try-catch 構文で包む必要あり）
    $response = $this->client->request('GET', 'bizCards/search', $options);

    return json_decode($response->getBody(), true);
}

Comments

[mpyw]

ちなみに既存コードの一番「動かない」問題点は

$this->searchSansanData($allrecords,$nextPageToken);

この部分です。メソッド名を間違えていますし，return を忘れています。

[jiyo-ta]

返信が遅くなりまして申し訳ありません。
大変ありがとうございます。

>関数内部の print_r() で表示と，関数外部の print_r() で表示は，どちらも1回のリクエストで一気に表示さ
>れたものでしょうか？連続した別々のリクエストで表示されたものではありませんか？
再帰処理をしているつもりだったのですが、連続した別々のリクエストになっているのだとご指摘いただいて理解しました。

__construct()の使い方や再帰よりもループの方が良い、など貴重なレビューを頂き大変有り難く存じます。
お恥ずかしながらいつもコピペで切り抜けてきたため、本当に理解が乏しいと改めて実感しました。
結局、頂戴しましたソースを使ってみたところ思い通りの値を取得することができました。

>Guzzle は 200 系以外は Exception をスローするのでステータスコードのチェックは不要
>必要に応じて try-catch 構文で包む必要あり）
なるほどです。try-catch 構文を試してみようと思います。

>ちなみに既存コードの一番「動かない」問題点は
>$this->searchSansanData($allrecords,$nextPageToken);
>この部分です。メソッド名を間違えていますし，return を忘れています。
ご指摘ありがとうございます。searchDataの間違いでした。この質問を投稿した際に間違ってしまいました。

大変ありがとうございました。