CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

2020/01/29 2020/02/08

CakePHP3＋PHP Simple HTML DOM Parserでスクレイピング

CakePHP3＋PHP Simple HTML DOM Parserでスクレイピング解説記事の事前説明

　
この記事は、CakePHP3に PHP Simple HTML DOM Parserをインストールしてスクレイピングをする環境を作る解説をするという内容です。
　
　
PHPでスクレイピングというと「phpQuery」に関連する記事が大量に出てきますが、「phpQuery」ではなく「PHP Simple HTML DOM Parser」の方をオススメする理由を「PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法」として記事にしましたので、興味があれば読んでください。
また、この記事では、PHP Simple HTML DOM Parserの基本的な設置方法も書いています。
　
　
また、PHP Simple HTML DOM Parserの設置方法、基本的な使い方については「PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方」として記事にしていますのでこちらを参考にしてください。
　
この記事に書いてあるのは、CakePHP3で PHP Simple HTML DOM Parserを使えるようにするところまでの内容です。
　
　
スクレイピングをする前に、PHPから Webサイトにアクセスする方法としては「file_get_contents」より「cURL」の方をオススメしますが、その理由を「PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較」として記事にしていますのでこちらも参考にしてください。
　
ただ、CakePHP3の場合は、Http Clientというライブラリが用意されていますので、それを利用するといいでしょう。
　
　

CakePHP3に PHP Simple HTML DOM Parserを設置する方法

１．PHP Simple HTML DOM Parser のインストール

　
まず初めに「PHP Simple HTML DOM Parser」をインストールします。
　
CakePHP3では、composerを使ってライブラリをインストールします。
下記のコマンドを実行します。
　

$ composer require kub-at/php-simple-html-dom-parser

1	$ composer require kub-at/php-simple-html-dom-parser

　
　
他の環境に合わせるために「PHP Simple HTML DOM Parser」のバージョンを指定してインストールする場合は、下記の「:1.9」のように最後にバージョンを追加します。
　

$ composer require kub-at/php-simple-html-dom-parser:1.9

1	$ composer require kub-at/php-simple-html-dom-parser:1.9

　
詳しくは「CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法」を参照してください。
　
　

２．PHP Simple HTML DOM Parserを読み込む

　
続いて、インストールした PHP Simple HTML DOM Parserを CakePHP3で使うために呼び出す処理を記述します。
　

use KubAT\PhpSimple\HtmlDomParser;

1	use KubAT\PhpSimple\HtmlDomParser;

　
　
例えば、SampleController.phpで PHP Simple HTML DOM Parserを使うのであれば、SampleController.phpに記述します。
　
　
これで PHP Simple HTML DOM Parserは使えるようになります。
　
　

３．PHP Simple HTML DOM Parserでスクレイピングをするサンプルソース

　
前項までで PHP Simple HTML DOM Parserを使う準備はできましたので、この後では実際にスクレイピングをするサンプルソースを書いておきます。
　
　
その前に、スクレイピングをするためには Webサイトを読み込む必要がありますので、 Http Clientなどを利用することになります。
　
そのために、前項で追記した内容の次の行あたりに下記を追記します。
　

use Cake\Http\Client;

1	use Cake\Http\Client;

　
　
そして、スクレイピングを行う処理のサンプルソースは以下のようになります。
　

    public function index(){
        // UserAgent
        define("USER_AGENT_TEXT", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36");

        // スクレイピング対象サイトの URL
        $url = "https://www.yahoo.co.jp/";

        // UAがないとエラーになるサイトの場合は、UAを設定する
        $option = ['headers' => ['User-Agent' => USER_AGENT_TEXT]];

        $http = new Client($option);

        // URLにアクセスし HTMLを取得
        $htmlSource  = $http->get($url)->getStringBody();

        // HTMLファイルから DOMオブジェクトを作成
        $html = HtmlDomParser::str_get_html($htmlSource);

        // スクレイピング（「a」タグを取得）
        echo implode("<br>", $html->find("a"));
    }

public function index(){

// UserAgent

define("USER_AGENT_TEXT", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36");

// スクレイピング対象サイトの URL

$url = "https://www.yahoo.co.jp/";

// UAがないとエラーになるサイトの場合は、UAを設定する

$option = ['headers' => ['User-Agent' => USER_AGENT_TEXT]];

$http = new Client($option);

// URLにアクセスし HTMLを取得

$htmlSource = $http->get($url)->getStringBody();

// HTMLファイルから DOMオブジェクトを作成

$html = HtmlDomParser::str_get_html($htmlSource);

// スクレイピング（「a」タグを取得）

echo implode("<br>", $html->find("a"));

}

　
ヤフーのサイト「https://www.yahoo.co.jp/」から、「a」タグを取得し、それを画面に表示する、というソースになっています。
　
それぞれの行にコメントを書いているので処理内容は分かるかと思います。
　
　
最初にも書きましたが、PHP Simple HTML DOM Parserの具体的な使い方に関しては「PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方」を参照してください。
　
　

http client()に User Agentを指定する方法

　
PHPから Webサイトにアクセスするときは、cURLを使うことをオススメします、と下記の記事でも書きました。
PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較
　
　
ですが、CakePHP3には http client() という便利なライブラリが用意されていますのでこれを利用すると便利です。
　
Cookbook　Http Client
https://book.cakephp.org/3/ja/core-libraries/httpclient.html
　
http、httpsを区別なくアクセスすることができたり、POSTでリクエストボディを送信できたり、Basic認証や OAuth2認証なども処理してくれます。
　
　
Http Clientの基本的な使い方に関しては、上記の Cookbookに書いてありますので参照してもらえるといいのですが、User Agentを設定してサイトにアクセスする方法の記載がありませんでしたのでここで解説をしておきます。
　

// UAがないとエラーになるサイトの場合は、UAを設定する
$option = ['headers' => ['User-Agent' => USER_AGENT_TEXT]];

$http = new Client($option);

// URLにアクセスし HTMLを取得
$htmlSource  = $http->get($url)->getStringBody();

// UAがないとエラーになるサイトの場合は、UAを設定する

$option = ['headers' => ['User-Agent' => USER_AGENT_TEXT]];

$http = new Client($option);

// URLにアクセスし HTMLを取得

$htmlSource = $http->get($url)->getStringBody();

　
　
User Agentを指定するには、オプションとして「headers」に指定をします。
簡単な設定で User Agentを指定してアクセスをすることができるようになります。
　
また、HTMLの本体を取得する場合は「->getStringBody()」を記述します。
　
また、定数「USER_AGENT_TEXT」はプログラム内のどこかで指定をしておいてください。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）

CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

: CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。