Previous Next

Zend_Dom_Query

Zend_Dom_Query を使用すると、XML や (X)HTML ドキュメントに対して XPath あるいは CSS セレクタを用いた問い合わせができるようになります。 MVC アプリケーションの機能テストを支援するために作られたものですが、 スクリーンスクレイパーを手早く作成するためにも使うことができます。

CSS セレクタ記法は、ウェブ開発者にとってはシンプルでなじみのある記法です。 XML 構造のドキュメントに対する問い合わせに使用できます。 この記法は、スタイルシートを扱ったことのある人ならきっとおなじみでしょうし、 Javascript のツールキットの中にも CSS セレクタを使用してノードを選択できる機能を持つものがあります (» Prototype の $$()» Dojo の dojo.query をヒントにしてこのコンポーネントを作成しました)。

動作原理

Zend_Dom_Query を使用するには、 Zend_Dom_Query オブジェクトのインスタンスを作成します。 その際に、問い合わせたいドキュメント (文字列) をオプションで渡すことができます。 ドキュメントを用意すれば、 query() メソッドあるいは queryXpath() メソッドを使用することができます。どちらのメソッドも、 マッチしたノードを含む Zend_Dom_Query_Result オブジェクトを返します。

Zend_Dom_Query を使うことと DOMDocument + DOMXPath を使うことの最大の違いは、 CSS セレクタによる選択が可能かどうかということです。 以下の内容を、任意の組み合わせで使用することができます。

  • 要素型: マッチさせたい要素の型を指定します。 'div', 'a', 'span', 'h2' などです。

  • style 属性: マッチさせたい CSS style 属性を指定します。'.error', 'div.error', 'label.required' などです。ひとつの要素に複数のスタイルが定義されている場合は 指定したスタイルがスタイル宣言のどこかに存在すればマッチします。

  • id 属性: マッチさせたい要素 ID 属性を指定します。 '#content', 'div#nav' などです。

  • 任意の属性: マッチさせたい任意の要素属性を指定します。 以下の 3 種類のマッチ形式を用意しています。

    • 完全マッチ: その文字列に完全にマッチする属性。 'div[bar="baz"]' は、"bar" 属性の値が正確に "baz" と一致する div 要素にマッチします。

    • 単語マッチ: 指定した文字列に一致する単語を含む属性。 'div[bar~="baz"]' は、"bar" 属性の値に単語 "baz" を含む div 要素にマッチします。 '<div bar="foo baz">' はマッチしますが、 '<div bar="foo bazbat">' はマッチしません。

    • 部分文字列マッチ: その文字列を含む属性。'div[bar~="baz"]' は、 "bar" 属性の値のどこかに文字列 "baz" を含む div 要素にマッチします。

      直接の子孫: セレクタの間で '>' を使用すると、 直接の子要素であることを表します。'div > span' は、'span' 要素のうち 'div' の直接の子であるものだけを選択します。 上のセレクタのどれとでも共用できます。

      子孫: 複数のセレクタをひとつの文字列にまとめると、 探す階層を指定することができます。 'div .foo span #one' が探すのは id が 'one' である要素です。その要素は、'span' 要素の子孫 (その間の階層の数は問わない) であり、 さらにその 'span' 要素はクラス 'foo' の要素の子孫 (その間の階層の数は問わない) です。 同様に、そのクラス 'foo' の要素は 'div' 要素の子孫 (その間の階層の数は問わない) となります。 これは、たとえば以下のリストにおける単語 'One' へのリンクにマッチします。

      Lorem ipsum One Two Three Four

問い合わせを実行したら、その結果のオブジェクトを用いてノードの情報を取得したり、 そのノード (あるいはノードの内容) を取り出して操作したりすることができます。 Zend_Dom_Query_ResultCountableIterator を実装しており、内部では結果を DOMNodes/DOMElements で保持しています。 たとえば、次のようなコードを上の HTML に対して実行することを考えてみましょう。

$dom = new Zend_Dom_Query($html);
$results = $dom->query('.foo .bar a');

$count = count($results); // マッチした数: 4
foreach ($results as $result) {
    // $result は DOMElement です
}

Zend_Dom_Query では、 queryXpath() メソッドで XPath クエリを直接使用することもできます。 XPath クエリとして正しいものならなんでもこのメソッドに渡すことができ、 結果は Zend_Dom_Query_Result オブジェクトで返されます。

使用可能なメソッド

Zend_Dom_Query 系のクラスでは、次のメソッドが使用できます。

Zend_Dom_Query

次のメソッドが Zend_Dom_Query で使用できます。

  • setDocumentXml($document): 対象となる XML 文字列を指定します。

  • setDocumentXhtml($document): 対象となる XHTML 文字列を指定します。

  • setDocumentHtml($document): 対象となる HTML 文字列を指定します。

  • setDocument($document): 対象となる文字列を指定します。Zend_Dom_Query がドキュメントの形式を自動判定します。

  • getDocument(): オブジェクトに渡した元の文字列を取得します。

  • getDocumentType(): オブジェクトに渡したドキュメントの形式を取得します。 クラス定数 DOC_XMLDOC_XHTML あるいは DOC_HTML のいずれかとなります。

  • query($query): CSS セレクタ記法でドキュメントへの問い合わせを行います。

  • queryXpath($xPathQuery): XPath 記法でドキュメントへの問い合わせを行います。

Zend_Dom_Query_Result

先ほど説明したように、Zend_Dom_Query_ResultIteratorCountable を実装しており、 foreach ループで使用したり count() 関数を利用したりすることができます。 さらに、次のメソッドを公開しています。

  • getCssQuery(): その結果を得る元となった CSS セレクタクエリを (もし存在すれば) 返します。

  • getXpathQuery(): その結果を得る元となった XPath クエリを返します。 内部的には、Zend_Dom_Query は CSS セレクタクエリを XPath に変換しています。 そのため、このメソッドは常に結果を返します。

  • getDocument(): 問い合わせ対象となった DOMDocument を取得します。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Console_Getopt
Getopt について
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ: Zend_Controller_Router_Rewrite
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
Gdata について
AuthSub による認証
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
YouTube Data API の使用法
Picasa Web Albums の使用法
Gdata の例外処理
Zend_Http
Zend_Http_Client - 導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
JSON オブジェクト
XML から JSON への変換
Zend_Json_Server - JSON-RPC server
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
ロケールがサポートする言語
ロケールがサポートする地域
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
Introduction
Usage
Configuration
Advanced usage
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ドキュメントのページ
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
PHP のバージョン
PHP の拡張モジュール
Zend Framework のコンポーネント
Zend Framework の依存性
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報