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

toggleAttributeメソッドは、DOM要素の属性の存在を切り替えるメソッドです。具体的には、指定された名前の属性が要素に存在する場合、その属性を削除します。逆に、属性が存在しない場合、指定された値を持つ属性を要素に追加します。このメソッドは、属性の追加と削除を一つの操作で効率的に行うことを目的としています。

Dom\Elementクラスのメソッドとして提供されており、要素の属性を動的に変更する必要がある場合に便利です。例えば、CSSクラスの追加や削除、ARIA属性の切り替えなど、JavaScriptと連携して動的なUIを実現する際に利用できます。

引数として、切り替えたい属性の名前（文字列）と、属性が存在しない場合に設定する値（文字列）を受け取ります。属性名のみを指定した場合、属性が存在しなければ空文字列が属性値として設定されます。このメソッドは、属性の存在をBoolean的な値として扱い、属性の追加/削除をトグルスイッチのように機能させる点で有用です。

戻り値はvoid型であり、値を返しません。メソッドの実行結果は、DOM要素の属性が直接変更されることで確認できます。エラーが発生した場合、例えばメモリ不足などの深刻な問題が発生した場合は、例外がスローされる可能性があります。そのため、適切なエラーハンドリングを行うことが推奨されます。toggleAttributeメソッドを使用することで、DOM操作をより簡潔にし、コードの可読性を向上させることができます。

Copy
1public Dom\Element::toggleAttribute(string $name): bool

string $qualifiedName, ?bool $force = null

• string $qualifiedName: 追加または削除する属性の名前を指定する文字列
• ?bool $force = null: trueを指定すると属性を強制的に追加または削除し、falseを指定すると属性が存在しない場合にのみ追加、存在する場合にのみ削除します。nullの場合は、属性が存在しない場合は追加し、存在する場合は削除します。

void

このメソッドは、指定された属性が存在しない場合は追加し、存在する場合は削除します。属性の追加または削除のみが行われるため、戻り値はありません。