PHP Simple HTML DOM ParserのAPI

このページの内容は、API Version 1.11に基づいています。

ヘルパー関数 (Helper functions)

名称 説明 
object str_get_html( string $content )
 文字列から、DOMオブジェクトを生成する。 
object file_get_html( string $filename )
 ファイルまたはURLから、DOMオブジェクトを生成する。

DOM

メソッド

名称 説明 
void __construct( [ string $filename ] )
 コンストラクタ。ファイル名を指定した場合には、コンテンツの読み込みも行う。 
void clear()
 メモリをクリーンアップする。 
void load( string $content )
 文字列から、コンテンツを読み込む。 
void load_file( string $filename )
 ファイルまたはURLから、コンテンツを読み込む 
string save( [ string $filename ] )
 DOMツリーを表示する。ファイル名を指定した場合には、それをファイルに保存する。 
void set_callback( string $function_name )
 コールバック関数を設定する。 
mixed find(
    string $selector
    [ , int $index ]
    )
CSSセレクタで要素を探索する。indexを指定した場合にはn番目のオブジェクトが返され、さもなくばオブジェクトの配列が返される。

プロパティ

名称 説明 
string plaintext
 HTMLから抜き出したコンテンツ

Element

メソッド

名称 説明 
mixed find(
    string $selector
    [ , int $index ]
    )
CSSセレクタで子要素を探索する。indexを指定した場合にはn番目のオブジェクトが返され、さもなくばオブジェクトの配列が返される。

プロパティ

名称 説明 
string [ attribute ]
 要素の属性 
string tag
 要素のタグ 
string outertext
 要素の外側のHTMLテキスト 
string innertext
 要素の内側のHTMLテキスト 
string plaintext
 要素からタグを除外したテキスト 
// 属性の取得
$value = $e->href;

// 属性の設定
$e->href = 'my link';

// 属性の削除
$e->href = null;

// 属性の存在の確認
if(isset($e->href))
{
    echo 'href exist!';
}

取得例

$html = str_get_html( "<div>foo <b>bar</b></div>" );
$e = $html->find( "div", 0 );

echo $e->tag;       // Returns: " div"
echo $e->outertext; // Returns: " <div>foo <b>bar</b></div>"
echo $e->innertext; // Returns: " foo <b>bar</b>"
echo $e->plaintext; // Returns: " foo bar"

DOMの走査

メソッド
名称 説明 
mixed $e->children( [ int $index ] )
 indexを指定した場合にはn番目の子要素のオブジェクトが返され、さもなくば子要素の配列が返される。 
element $e->parent()
 要素の親が返される。 
element $e->first_child()
 要素の最初の子が返される。見つからない場合にはNULLが返される。 
element $e->last_child()
 要素の最後の子が返される。見つからない場合にはNULLが返される。 
element $e->next_sibling()
 親の子のなかで、この要素の直後の要素が返される。見つからない場合にはNULLが返される。 
element $e->prev_sibling()
 親の子のなかで、この要素の直前の要素が返される。見つからない場合にはNULLが返される。

参考

PHPのマニュアルから検索