【PHP8.x】itemメソッドの使い方

itemメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

itemメソッドは、トークンリスト(Dom\TokenListオブジェクト)内の指定されたインデックス(位置)にあるトークンを取得するメソッドです。Dom\TokenListオブジェクトは、HTML要素のclass属性のように、スペースで区切られた複数の文字列(トークン)の集合を管理します。このメソッドを使用することで、リストに含まれる個々のトークンに順番でアクセスすることが可能になります。引数には、取得したいトークンの位置を0から始まる整数のインデックスで指定します。例えば、リストの先頭にあるトークンを取得したい場合はインデックスとして0を、2番目のトークンを取得したい場合は1を指定します。メソッドの返り値は、指定したインデックスにトークンが存在すればそのトークンの文字列となり、存在しない場合、つまりインデックスがリストの範囲外である場合にはnullが返されます。この機能は、TokenListオブジェクトを配列のように扱い、角括弧([])を用いて$list[0]のように直接インデックスでアクセスした場合と同じ結果を得ることができます。

構文(syntax)

1<?php
2// HTML文字列からDOMドキュメントを作成します
3$dom = new \DOMDocument();
4$dom->loadHTML('<p class="token1 token2 token3"></p>');
5
6// <p>要素を取得します
7$element = $dom->getElementsByTagName('p')->item(0);
8
9// classList (Dom\TokenList) からインデックス1のトークン(クラス名)を取得します
10// インデックスは0から始まります
11$token = $element->classList->item(1);
12
13// "token2" が出力されます
14echo $token;
15?>

引数(parameters)

int $index

  • int $index: 取得したい要素のインデックスを指定する整数

戻り値(return)

?string

指定されたインデックスに対応するトークン文字列を返します。指定されたインデックスが存在しない場合は null を返します。