PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方
2020/02/08
PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方
PHP Simple HTML DOM Parserに関連する解説、および、関連記事
PHPでスクレイピングをする際には、「PHP Simple HTML DOM Parser」というライブラリを利用すると簡単にスクレイピングをすることが出来ます。
この記事では「PHP Simple HTML DOM Parser」の基本的な使い方を始め、実用的な使い方、エラーの原因になるポイントなどを解説していきます。
また、「PHP スクレイピング」で検索すると「phpQuery」というライブラリの記事が大量にヒットするわけです。
しかし、「phpQuery」より「PHP Simple HTML DOM Parser」をおすすめする理由や、「PHP Simple HTML DOM Parser」の基本的な使い方についての解説を下記の記事に書いていますので、こちらも併せて読んでいただく方がいいかと思います。
PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法
「PHP Simple HTML DOM Parser」を CakePHP3で使う場合の導入方法については下記に記事を書きました。
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
また、スクレイピングを行う対象のページへアクセスするときは、「file_get_contents」や「cURL」を利用します。
ですが、断然「cURL」の方をオススメする！という理由や、cURLで SSL化されたページへのアクセス、User Agentを必要とするサイトへのアクセス方法などについて、下記の記事に書いていますので、こちらも併せて読んでいただく方がいいかと思います。
PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較
また、この記事は、下記のオフィシャルマニュアルを参考にしています。
https://simplehtmldom.sourceforge.io/manual.htm
DOMオブジェクトを生成する方法
「PHP Simple HTML DOM Parser」では、まず最初に HTMLから DOMオブジェクトを生成します。
そして、作成した DOMオブジェクトに対して「find()」メソッドを使ってほしい項目を取得する、という流れになります。
DOMオブジェクトを生成する基本形
その最初の DOMオブジェクトを作成する方法は下記の 3種類あります。
// HTMLのソースコードを指定する場合
$html = str_get_html("<html><body>Hello!</body></html>");
// URLを指定する場合
$html = file_get_html("http://example.com");
// HTMLファイルを指定する場合
$html = file_get_html("example.html");
DOMオブジェクトを生成するサンプルソース
URLを指定して Webサイトにアクセスし DOMオブジェクトを作成する場合は、「file_get_html()」が用意されていますが、私は cURLを使い別に HTMLソースコードを取得した上で、「str_get_html()」を使って DOMオブジェクトを生成する方法をオススメします。
なぜか。
指定の URLから情報が取得できなかった場合にエラー制御をするためには cURLの方がやりやすいからです。
詳しくは、「PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較」か「PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法」を参考にしてください。
cURLを利用した場合の DOMオブジェクトの生成するサンプルソースは以下のようになります。
<?php
// 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");
// PHP Simple HTML DOM Parser の読み込み
require_once "simple_html_dom.php";
$url = "https://www.yahoo.co.jp/";
// cURLを使用して Webサイトから情報を取得する関数
$htmlSource = getApiDataCurl($url,"html");
// HTMLをオブジェクト化
$html = str_get_html( $htmlSource );
// 結果を出力
print_r($html->find("a",0)->plaintext);
// APIを呼び出し、結果を受け取る処理（URLにアクセスしその結果を取得する処理）
// $url ：APIの URI（アクセスする URL）
// $responseType：受け取る結果のタイプ（header、html、json）
function getApiDataCurl($url, $responseType = "html" ){
：
中略
：
}
関数「getApiDataCurl()」の中身については、「PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較」か「PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法」を参考にしてください。
DOMオブジェクトから find()メソッドを使ってノード（項目）を取得する方法
DOMオブジェクトから find()メソッドを使ってノード（項目）を取得する処理の基本系
DOMオブジェクトからノード（項目）を取得するときは「find()」メソッドを使います。
その使い方の基本形は下記のようになります。
// すべての「a」タグの要素を配列として取得
$result = $html->find("a");
// 「a」タグの要素のうち 1番目（0）の項目を取得
$result = $html->find("a",0);
// 「a」タグの要素のうち最後（-1）の項目を取得
$result = $html->find("a",-1);
// id属性を持っているすべての要素を配列として取得
$result = $html->find("[id]");
// 上記は下記のように「*」を使うことも可能
$result = $html->find("*[id]");
// 「div」タグの要素のうち id属性を持っている要素を配列として取得
$result = $html->find("div[id]");
// 「div」タグの要素のうち「id=foo」である要素を配列として取得
$result = $html->find("div[id=foo]");
// 「div」タグの要素のうち id属性を持っている要素の 6番目を取得
$result = $html->find("div[id]",5);
要素の条件を指定するフィルタ
「$html->find("div[id=foo]");」の「[id=foo]」で指定している箇所はフィルタとなっておりまして、「=」以外の条件を指定することも出来ます。
指定方法とその条件は、以下のようになります。
[attribute]
指定された属性を持つ要素に一致するものを取得
[!attribute]
指定された属性を持つ要素に一致しないものを取得
[attribute=value]
指定された値である属性を持つ要素を取得
[attribute!=value]
指定された値ではない属性を持つ要素を取得
[attribute^=value]
指定された値から始まる属性を持つ要素を取得
[attribute$=value]
指定された値で終わる属性を持つ要素を取得
[attribute*=value]
指定された値を含む属性を持つ要素を取得
CSSの IDセレクタ、CLASSセレクタを指定する方法
CSSの IDセレクタや CLASSセレクタを条件として指定する方法もあります。
// 全てのタグのうち「id=foo」である要素を配列として取得
$result = $html->find("#foo");
// 下記の記述方法と同じ
$result = $html->find("[id=foo]");
// 全てのタグのうち「class=foo」である要素を配列として取得
$result = $html->find(".foo");
// 下記の記述方法と同じ
$result = $html->find("[class=foo]");
「,（カンマ）」で区切りることで、複数条件の指定ができるようになります。
// すべての「a」「img」タグの要素を配列として取得
$ret = $html->find("a, img");
// 「a」「img」タグの要素のうち title属性を持っている要素を配列として取得
$ret = $html->find("a[title], img[title]");
テキストブロックとコメントの取得
テキストブロックやコメントを取得するときは下記のように指定します。
// すべてのテキストブロックを取得
$result = $html->find("text");
// すべてのテキストを取得
$result = $html->plaintext;
// すべてのコメントを取得
$result = $html->find("comment");
「$html->plaintext」は、全てのタグの plaintextを取得するものです。
「$html->find("text")」とは違う結果になります。
子孫セレクタやネストされたタグの取得
スペースで区切ることで子孫セレクタ、ネストされた要素を取得することが出来ます。
// ulタグの中にある liタグの要素を取得
$result = $html->find("ul li");
// ネストされた divの要素を取得
$result = $html->find("div div div");
// 「class=hello」の tableタグの中にある tdタグの要素を取得
$result = $html->find("table.hello td");
// tableタグの中にある「align=center」の属性を持つ tdタグの要素を取得
$result = $html->find("table td[align=center]");
ネストされた要素は下記のように foreach()で取得することも可能です。
// ulタグの中にある liタグの要素を取得
foreach($html->find("ul") as $ul){
foreach($ul->find("li") as $li){
$result[] = $li->plaintext;
}
}
// ネストされた要素の順番を指定して取得
// ulタグの最初の要素をの中にある、最初の liタグの要素を取得
$result = $html->find("ul", 0)->find("li", 0);
取得した要素の属性にアクセスする方法
前項では、DOMオブジェクトから条件に従って要素を取得する方法を解説しました。
この後では、取得した要素の中から指定した属性の値を取得する方法を解説します。
要素の属性を指定して値を取得する方法の基本形
要素の属性を指定して値を取得する基本形は以下になります。
// 「a」タグの hrefの値を取得
echo $html->find("a",0)->href;
// 「a」タグの classの値を取得
echo $html->find("a",0)->class;
// 「a」タグの idの値を取得
echo $html->find("a",0)->id;
// 「a」タグのタグの名称を取得
echo $html->find("a",0)->tag;
要素のテキストの情報を取得する方法
指定した要素のテキスト情報を取得する方法が 3種類用意されています。
テキスト情報のみを取得するのか、タグも含めて取得するのか、などを選択することができます。
// 指定した要素のテキストのみを取得する
echo $html->find("div",0)->plaintext;
// 指定した要素に含まれる値を取得する
echo $html->find("div",0)->innertext;
// 指定した要素をタグを含めて取得する
echo $html->find("div",0)->outertext;
「plaintext」「innertext」「outertext」を指定した際の具体的な結果は以下のようになります。
// 下記の HTMLを対象に実行
$html = str_get_html( '<html><body><div><a href="https://example.com">リンクの例</a></div></body></html>' );
echo $html->find("div",0)->plaintext;
// 取得の値：リンクの例
echo $html->find("div",0)->innertext;
// 取得の値：<a href="https://example.com">リンクの例</a>
echo $html->find("div",0)->outertext;
// 取得の値：<div><a href="https://example.com">リンクの例</a></div>
ちなみに、「$html->find("a",0)->plaintext;」と「$html->find("a",0)->innertext;」とした場合は、両方とも同じ「リンクの例」となります。
これは、「a」タグの中には「リンクの例」しかないためです。
属性を設定、削除する方法、属性の存在の有無チェックの方法
属性から値を取得するだけではなく、属性に値を設定したり、削除したりすることもできます。
// 属性の値を取得（属性が非値ならば、論理値が返す）
$value = $html->find("a",0)->href;
// 属性の値を設定（属性が非値ならば、論理値を設定）
$html->find("a",0)->href = "http://example.com";
// 属性の値を削除（値を NULLとする）
$html->find("a",0)->href = null;
// 属性が存在するか否かをチェック
if( isset( $e->href ) ){
echo "href exist!";
}
DOM拡張モジュールに定義された関数を使用して要素を取得することも可能
DOMオブジェクトから要素を取得する方法としては、「find()」メソッドを利用する方法を紹介しました。
ですが、PHP Simple HTML DOM Parserでは、DOM拡張モジュールに定義された関数を使用して要素を取得することもできます。
例えば、下記のように「getElementById()」で「id」の値を指定して要素を取得することもできます。
$url = "https://www.yahoo.co.jp";
$htmlSource = getApiDataCurl($url,"html");
$html = str_get_html( $htmlSource );
// 「id=eyebrow」の要素を取得
print_r($html->getElementById("eyebrow")->outertext);
// 「id=eyebrow」の要素を取得の 1つめの子要素を取得
print_r($html->getElementById("eyebrow")->childNodes(0)->outertext);
// 「id=eyebrow」の要素を取得の 1つめの子要素の class名を取得
print_r($html->getElementById("eyebrow")->childNodes(0)->getAttribute("class"));
DOM拡張モジュールに定義された関数は多数ありますので、下記の PHPの関数レファレンスを参考にしてください。
https://www.php.net/manual/ja/book.dom.php
取得した HTMLを保存する方法
取得した HTMLファイルを簡単にファイルとして出力（保存）する方法も用意されています。
// HTML全体を保存
$html->save("result.html");
// 指定した要素を保存
$html->find("a",0)->save("result3.html");
// 下記はエラーになる
$html->find("a",0)->outertext->save("result3.html");
解説はしましたが、果たしてこの機能を使う機会はあるのだろうか？という疑問はありますね。
PHP Simple HTML DOM Parserを使うときの注意点
ここ以降は、マニュアルには載っていない内容ですが、実際に使ってみて気づいた点がいくつかありましたので、それをお伝えしたいと思います。
DOMオブジェクトの中身の確認には echo、printを使う
先のサンプルでは、取り出した値を「print_r()」を使って表示しています。
ですが、DOMオブジェクトの中身を確認したいときは、print_r()、var_dump()ではなく、echo、printを使いましょう。
具体的には、下記の記述を実行すると「Fatal error: Allowed memory size of 2097152000 bytes exhausted (tried to allocate 1046482944 bytes) in C:\xampp．．．」のエラーがでます。
print_r($html);
print_r($html->find("a"));
foreach($html->find("a") as $val ){
print_r($val) . "<br>\n";
}
下記の記述方法であればエラーは発生しません。
echo $html;
echo implode("<br>", $html->find("a"));
foreach($html->find("a") as $val ){
echo $val . "<br>\n";
}
詳しいエラーの原因は調べていませんが、すごい勢いで CPUとメモリを消費してオーバーフローをしてしまいますので、ローカル環境以外で「print_r()」を使うのはかなり危険です。
HTMLタグの大文字、小文字は気にしなくて問題なし
HTMLタグは大文字、小文字のどちらで記述しても問題ない仕様になっています。（XHTMLは小文字で記述する仕様になっています。）
そのため、HTMLタグが大文字のサイトがあったり、小文字のサイトがあったりしますが、「$html->find("title",0)->plaintext」などで指定するタグは、大文字小文字の区別をしません。
（HTMLのソース側も、find()に指定する側も大文字、小文字の区別は行われません。）
そのため、大文字小文字は気にせず記述することが出来ます。
逆に、大文字小文字が混在したサイトで「大文字で書かれた「H2タグ」の 3つめを取得したい」といった指定をすることは出来ません。
PHP Simple HTML DOM Parserで処理できる文字数には上限がある
PHP Simple HTML DOM Parserには処理できる文字数に上限があるようです。
とあるサイトのスクレイピングをしようとアクセスしたところ、「Fatal error: Uncaught Error: Call to a member function find() on bool in ．．．」というエラーが発生しました。
エラーの内容を調査すると、「$html->find("h3",0)->plaintext」を実行している「$html」が空であることが確認できました。
そして、「$html」が空になる理由が、HTMLのソース量が大きすぎて、「str_get_html()」で処理できていないことが分かりました。
そのため「mb_substr()」を使用して、取得した HTMLを文字数で制限して取得してみたところ、520,000文字以下であれば処理できることが確認できました。
（環境によって「520,000文字」が異なるか否かは確認をしていません。）
より具体的には．．．
520,261文字以上ではエラーがでました。
「mb_substr」で処理をしていますので、バイト数ではなく、全角半角の区別なく文字数です。（バイト数で制限があるか否かは確認していません。）
php.ini の memory_limit を変更しても制限される文字数が変わることはありませんでした。
このエラーの難点は、エラーメッセージが「$html が空です」というものであるため、HTMLのソース量が大きいことが原因で処理できていない、ということになかなか気づかない点が挙げられます。
大量の HTMLソースを持つページに対処するサンプルソース・その１
大量の HTMLソースを持つページの情報を取得する必要がある場合の具体的な対処方法のサンプルソースとしては以下のようになります。
$url = "https://www.yahoo.co.jp/";
$htmlSource = getApiDataCurl($url,"html");
// mb_substr()で 520000文字分を取得
$htmlResult = mb_substr($htmlSource,-520000,520000);
$html = str_get_html( $htmlResult );
print_r($html->find("a",0)->plaintext);
HTMLファイルの最初の方はグローバルメニューや検索条件を入力するエリアで、下の方に検索結果一覧が表示される、というサイトなどを想定しています。
そのため、検索結果が表示される HTMLの下の方だけ取得できればいい、といった場合はこの方法が簡単なのではないか、と思います。
「mb_substr」を用いて、最後から「520,000文字」を取得しています。
サンプルのヤフーのサイトは「520,000文字」もありませんが。
また、関数「getApiDataCurl()」は、オリジナルの関数です。詳細は「PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較」か「PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法」を確認してください。
大量の HTMLソースを持つページに対処するサンプルソース・その２
前項では「mb_substr」を用いてざっくり後半部分！という感じで取得する処理でした。
その２では、例えば「<h2>一覧表示</h2>」移行の行を対象として取得する、といった具体的な目印がある場合の対応方法です。
下記のように「foreach()」で上から 1行ずつチェックして必要な部分を取得する方法もあるかとも思います。
$url = "https://www.yahoo.co.jp/";
$htmlSource = getApiDataCurl($url,"html");
// 改行を区切りとして配列を生成
$htmlSourceArray = preg_split('/\r\n|\n|\r/',$htmlSource);
$okFlag = "NG";
$htmlResult = "";
foreach($htmlSourceArray as $htmlLine){
if($okFlag == "OK"){
$htmlResult .= $htmlLine;
} else {
// 「<h2>一覧表示</h2>」がある行以降を取得する
if(strpos($htmlLine,"<h2>一覧表示</h2>") !== false){
$htmlResult .= $htmlLine;
$okFlag = "OK";
}
}
}
長くなりましたが、以上になります。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！
関連記事
-
-
PHPで1ヵ月前、先月、今月1日、来月末の日付などの算出はDateTimeImmutableを使う
PHPには日時をオブジェクトとして生成する関数「DateTimeImmutable」「DateTime」が用意されている。これを利用して1ヶ月後、月初日、月末日、5日後などを指定して日付を取得できる。
-
-
PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較
PHPからWebサイトにアクセスしてHTMLを取得、APIにアクセスして情報を取得する場合は、cURLがオススメ。file_get_contentsでも可能だがエラー制御に難がありトラブルのもとになる。
-
-
乱数発生器（パスワード生成サービス）がバージョンアップで高速化！
乱数やパスワードを生成する乱数発生器を高速化！重複しない10桁、20桁の文字列を10万件、20万件と生成することも可能！イベントのキャンペーンのシリアルコードなどにも利用可能！
-
-
ECCUBE mtb_constants initパラメータ設定の項目を追加する方法
ECCUBEのパラメータ設定で設定できる項目を追加する方法を説明します。
-
-
ECCUBEのポイント設定、ポイント付与率を一括で変更する方法解説
ECCUBEの商品個別に設定してあるポイントを一括で変更する方法を解説。ECCUBEには商品個別のポイントを一括して変更する機能がありません。SQLを作成して一括置換！
-
-
PHP range関数を使って階乗と重複組み合わせを計算
PHPの range関数を使って階乗と重複組み合わせを計算し、それを元に乱数発生器を作成しました。
-
-
カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム
PHPのcURLを使用してカオナビAPIのアクセスに必要なtoken、シートの情報を取得するサンプルプログラムを作成。cURLの処理は関数化しているため他のAPIでも流用できる。
-
-
配列の値をテキスト表示する際に「、」でつなげるときの処理方法の一例
配列の値を「、」でつないで出力する際、単純にforeachで繰り返し処理をすると「イヌ、サル、キジ、」となるが文字列最後の「、」を出力しない方法を3つ解説している。
-
-
cURLを利用する際の注意点「
&」があるURLは「”」で囲むcURLでURLはダブルクォーテーションで囲む。LinuxでもWindowsでもコマンドでは「＆」は意味を持つ文字のためエラー原因になる。クォーテーションは常につけておく方が無難。
-
-
PHPで配列の値をダブルクオーテーションで囲んでimplodeでカンマ区切りにする方法
PHPで配列の値を、preg_replace関数でクォーテーションで囲み、implode関数で「,（カンマ）」で区切ってテキスト化する方法。この方法であれば配列が空でも分岐の処理は必要なし！
