DomCrawler 組件

編輯此頁面

DomCrawler 組件簡化了 HTML 和 XML 文件中的 DOM 導航。

注意

雖然有可能，但 DomCrawler 組件並非設計用於操作 DOM 或重新轉儲 HTML/XML。

安裝

        1
        $ composer require symfony/dom-crawler
    

注意

如果您在 Symfony 應用程式之外安裝此組件，您必須在您的程式碼中引入 vendor/autoload.php 檔案，以啟用 Composer 提供的類別自動載入機制。請閱讀這篇文章以瞭解更多詳細資訊。

表單也獲得特殊處理。selectButton() 方法在 Crawler 上可用，它會傳回另一個 Crawler，該 Crawler 符合 <button> 或 <input type="submit"> 或 <input type="button"> 元素（或它們內部的 <img> 元素）。在 id、alt、name 和 value 屬性以及這些元素的文字內容中尋找作為引數給定的字串。

此方法特別有用，因為您可以使用它來傳回代表按鈕所在表單的 Form 物件

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // button example: <button id="my-super-button" type="submit">My super button</button>

// you can get button by its label
$form = $crawler->selectButton('My super button')->form();

// or by button id (#my-super-button) if the button doesn't have a label
$form = $crawler->selectButton('my-super-button')->form();

// or you can filter the whole form, for example a form has a class attribute: <form class="form-vertical" method="POST">
$crawler->filter('.form-vertical')->form();

// or "fill" the form fields with data
$form = $crawler->selectButton('my-super-button')->form([
    'name' => 'Ryan',
]);
    

Form 物件具有許多非常有用的方法，可用於處理表單

        1
2
3
        $uri = $form->getUri();
$method = $form->getMethod();
$name = $form->getName();
    

getUri() 方法不僅僅傳回表單的 action 屬性。如果表單方法是 GET，則它會模仿瀏覽器的行為，並傳回 action 屬性，後跟包含所有表單值的查詢字串。

注意

支援選用的 formaction 和 formmethod 按鈕屬性。getUri() 和 getMethod() 方法會考量這些屬性，以始終傳回正確的動作和方法，具體取決於用於取得表單的按鈕。

您可以在表單上虛擬設定和取得值

        1
2
3
4
5
6
7
8
9
10
11
12
        // sets values on the form internally
$form->setValues([
    'registration[username]' => 'symfonyfan',
    'registration[terms]'    => 1,
]);

// gets back an array of values - in the "flat" array like above
$values = $form->getValues();

// returns the values like PHP would see them,
// where "registration" is its own array
$values = $form->getPhpValues();
    

若要處理多維欄位

        1
2
3
4
5
6
7
8
        <form>
    <input name="multi[]">
    <input name="multi[]">
    <input name="multi[dimensional]">
    <input name="multi[dimensional][]" value="1">
    <input name="multi[dimensional][]" value="2">
    <input name="multi[dimensional][]" value="3">
</form>
    

傳遞值陣列

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // sets a single field
$form->setValues(['multi' => ['value']]);

// sets multiple fields at once
$form->setValues(['multi' => [
    1             => 'value',
    'dimensional' => 'an other value',
]]);

// tick multiple checkboxes at once
$form->setValues(['multi' => [
    'dimensional' => [1, 3] // it uses the input value to determine which checkbox to tick
]]);
    

這很棒，但會變得更好！Form 物件允許您像瀏覽器一樣與表單互動，選取單選值、勾選核取方塊和上傳檔案

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        $form['registration[username]']->setValue('symfonyfan');

// checks or unchecks a checkbox
$form['registration[terms]']->tick();
$form['registration[terms]']->untick();

// selects an option
$form['registration[birthday][year]']->select(1984);

// selects many options from a "multiple" select
$form['registration[interests]']->select(['symfony', 'cookies']);

// fakes a file upload
$form['registration[photo]']->upload('/path/to/lucas.jpg');
    

使用表單資料

執行所有這些操作的重點是什麼？如果您在內部進行測試，您可以擷取表單上的資訊，就像剛透過使用 PHP 值提交一樣

        1
2
        $values = $form->getPhpValues();
$files = $form->getPhpFiles();
    

如果您使用外部 HTTP 用戶端，您可以使用表單來擷取建立表單 POST 請求所需的所有資訊

        1
2
3
4
5
6
        $uri = $form->getUri();
$method = $form->getMethod();
$values = $form->getValues();
$files = $form->getFiles();

// now use some HTTP client and post using this information
    

使用所有這些整合系統的一個很好的範例是 HttpBrowser，它由 BrowserKit 組件提供。它瞭解 Symfony Crawler 物件，並且可以使用它來直接提交表單

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        use Symfony\Component\BrowserKit\HttpBrowser;
use Symfony\Component\HttpClient\HttpClient;

// makes a real request to an external site
$browser = new HttpBrowser(HttpClient::create());
$crawler = $browser->request('GET', 'https://github.com/login');

// select the form and fill in some values
$form = $crawler->selectButton('Sign in')->form();
$form['login'] = 'symfonyfan';
$form['password'] = 'anypass';

// submits the given form
$crawler = $browser->submit($form);
    

選取無效的選項值

依預設，選項欄位（選取、單選）已啟用內部驗證，以防止您設定無效值。如果您想要能夠設定無效值，您可以在整個表單或特定欄位上使用 disableValidation() 方法

        1
2
3
4
5
6
        // disables validation for a specific field
$form['country']->disableValidation()->select('Invalid value');

// disables validation for the whole form
$form->disableValidation();
$form['country']->select('Invalid value');
    

解析 URI

UriResolver 類別會採用 URI（相對、絕對、片段等），並將其轉換為相對於另一個給定基本 URI 的絕對 URI

        1
2
3
4
5
        use Symfony\Component\DomCrawler\UriResolver;

UriResolver::resolve('/foo', 'https://127.0.0.1/bar/foo/'); // https://127.0.0.1/foo
UriResolver::resolve('?a=b', 'https://127.0.0.1/bar#foo'); // https://127.0.0.1/bar?a=b
UriResolver::resolve('../../', 'https://127.0.0.1/'); // https://127.0.0.1/
    

使用 HTML5 解析器

如果您需要 Crawler 使用 HTML5 解析器，請將其 useHtml5Parser 建構子引數設定為 true

        1
2
3
        use Symfony\Component\DomCrawler\Crawler;

$crawler = new Crawler(null, $uri, useHtml5Parser: true);
    

這樣做，crawler 將使用 masterminds/html5 程式庫提供的 HTML5 解析器來解析文件。

瞭解更多

本作品，包括程式碼範例，均依Creative Commons BY-SA 3.0 授權條款授權。

版本

DomCrawler 組件

安裝

用法

節點過濾

節點遍歷

存取節點值

新增內容

表達式評估

連結

圖片

表單

使用表單資料

選取無效的選項值

解析 URI

使用 HTML5 解析器

瞭解更多

成為 Symfony 貢獻者