PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    DOMDocument クラス

    (PHP 5, PHP 7, PHP 8)

    はじめに

    HTML ドキュメントあるいは XML ドキュメント全体を表し、 ドキュメントツリーのルートとなります。

    クラス概要

    class DOMDocument extends DOMNode implements DOMParentNode {
    /* プロパティ */
    public readonly ?DOMDocumentType $doctype;
    public readonly DOMImplementation $implementation;
    public readonly ?DOMElement $documentElement;
    public readonly ?string $actualEncoding;
    public ?string $encoding;
    public readonly ?string $xmlEncoding;
    public bool $standalone;
    public bool $xmlStandalone;
    public ?string $version;
    public ?string $xmlVersion;
    public bool $strictErrorChecking;
    public ?string $documentURI;
    public readonly mixed $config;
    public bool $formatOutput;
    public bool $validateOnParse;
    public bool $resolveExternals;
    public bool $preserveWhiteSpace;
    public bool $recover;
    public bool $substituteEntities;
    public readonly ?DOMElement $firstElementChild;
    public readonly ?DOMElement $lastElementChild;
    public readonly int $childElementCount;
    /* 継承したプロパティ */
    public readonly string $nodeName;
    public ?string $nodeValue;
    public readonly int $nodeType;
    public readonly ?DOMNode $parentNode;
    public readonly ?DOMElement $parentElement;
    public readonly DOMNodeList $childNodes;
    public readonly ?DOMNode $firstChild;
    public readonly ?DOMNode $lastChild;
    public readonly ?DOMNode $previousSibling;
    public readonly ?DOMNode $nextSibling;
    public readonly ?DOMNamedNodeMap $attributes;
    public readonly bool $isConnected;
    public readonly ?DOMDocument $ownerDocument;
    public readonly ?string $namespaceURI;
    public string $prefix;
    public readonly ?string $localName;
    public readonly ?string $baseURI;
    public string $textContent;
    /* メソッド */
    public __construct(string $version = "1.0", string $encoding = "")
    public adoptNode(DOMNode $node): DOMNode|false
    public append(DOMNode|string ...$nodes): void
    public createAttribute(string $localName): DOMAttr|false
    public createAttributeNS(?string $namespace, string $qualifiedName): DOMAttr|false
    public createCDATASection(string $data): DOMCdataSection|false
    public createComment(string $data): DOMComment
    public createDocumentFragment(): DOMDocumentFragment
    public createElement(string $localName, string $value = ""): DOMElement|false
    public createElementNS(?string $namespace, string $qualifiedName, string $value = ""): DOMElement|false
    public createEntityReference(string $name): DOMEntityReference|false
    public createProcessingInstruction(string $target, string $data = ""): DOMProcessingInstruction|false
    public createTextNode(string $data): DOMText
    public getElementById(string $elementId): ?DOMElement
    public getElementsByTagName(string $qualifiedName): DOMNodeList
    public getElementsByTagNameNS(?string $namespace, string $localName): DOMNodeList
    public importNode(DOMNode $node, bool $deep = false): DOMNode|false
    public load(string $filename, int $options = 0): bool
    public loadHTML(string $source, int $options = 0): bool
    public loadHTMLFile(string $filename, int $options = 0): bool
    public loadXML(string $source, int $options = 0): bool
    public normalizeDocument(): void
    public prepend(DOMNode|string ...$nodes): void
    public registerNodeClass(string $baseClass, ?string $extendedClass): true
    public relaxNGValidate(string $filename): bool
    public relaxNGValidateSource(string $source): bool
    public replaceChildren(DOMNode|string ...$nodes): void
    public save(string $filename, int $options = 0): int|false
    public saveHTML(?DOMNode $node = null): string|false
    public saveHTMLFile(string $filename): int|false
    public saveXML(?DOMNode $node = null, int $options = 0): string|false
    public schemaValidate(string $filename, int $flags = 0): bool
    public schemaValidateSource(string $source, int $flags = 0): bool
    public validate(): bool
    public xinclude(int $options = 0): int|false
    /* 継承したメソッド */
    public DOMNode::appendChild(DOMNode $node): DOMNode|false
    public DOMNode::C14N(
        bool $exclusive = false,
        bool $withComments = false,
        ?array $xpath = null,
        ?array $nsPrefixes = null
    ): string|false
    public DOMNode::C14NFile(
        string $uri,
        bool $exclusive = false,
        bool $withComments = false,
        ?array $xpath = null,
        ?array $nsPrefixes = null
    ): int|false
    public DOMNode::cloneNode(bool $deep = false): DOMNode|false
    public DOMNode::compareDocumentPosition(DOMNode $other): int
    public DOMNode::contains(DOMNode|DOMNameSpaceNode|null $other): bool
    public DOMNode::getLineNo(): int
    public DOMNode::getNodePath(): ?string
    public DOMNode::getRootNode(?array $options = null): DOMNode
    public DOMNode::hasAttributes(): bool
    public DOMNode::hasChildNodes(): bool
    public DOMNode::insertBefore(DOMNode $node, ?DOMNode $child = null): DOMNode|false
    public DOMNode::isDefaultNamespace(string $namespace): bool
    public DOMNode::isEqualNode(?DOMNode $otherNode): bool
    public DOMNode::isSameNode(DOMNode $otherNode): bool
    public DOMNode::isSupported(string $feature, string $version): bool
    public DOMNode::lookupNamespaceURI(?string $prefix): ?string
    public DOMNode::lookupPrefix(string $namespace): ?string
    public DOMNode::normalize(): void
    public DOMNode::removeChild(DOMNode $child): DOMNode|false
    public DOMNode::replaceChild(DOMNode $node, DOMNode $child): DOMNode|false
    public DOMNode::__sleep(): array
    public DOMNode::__wakeup(): void
    }

    プロパティ

    actualEncoding

    非推奨。ドキュメントの実際のエンコーディング。 読み込み専用で、 encoding と同等の内容です。

    childElementCount

    子要素の数

    config

    非推奨。 DOMDocument::normalizeDocument() を実行する際に使用する設定。

    doctype

    このドキュメントに関連付けられた文書型宣言

    documentElement

    最初のドキュメント要素を示す DOMElement オブジェクト。 存在しない場合は null になります。

    documentURI

    ドキュメントの位置。未定義の場合は null

    encoding

    XML 宣言で指定したドキュメントのエンコーディング。 この属性は、DOM Level 3 の最終的な仕様には存在しません。 しかし、この実装で XML ドキュメントのエンコーディングを扱うにはこれを使用するしかありません。

    firstElementChild

    最初の子要素。存在しない場合は null になります。

    formatOutput

    字下げや空白を考慮してきれいに整形した出力を行う。 これは、ドキュメントを preserveWhitespace を有効にして読み込んだ場合は効果がありません。

    implementation

    このドキュメントを処理する DOMImplementation オブジェクト

    lastElementChild

    最後の子要素。存在しない場合は null になります。

    preserveWhiteSpace

    余分な空白を取り除かない。デフォルトは true false に設定すると、 DOMDocument::load() の option に LIBXML_NOBLANKS を渡すのと同じ効果があります。

    recover

    非標準。 リカバリーモードを有効にし、整形式でないドキュメントのパースを試みます。 この属性は DOM の仕様にはなく、libxml 固有の独自仕様です。

    resolveExternals

    文書型宣言で外部エンティティを読み込む際に true を設定する。 XML ドキュメントに文字エンティティを含める際に便利です。

    standalone

    非推奨。 そのドキュメントがスタンドアローンかどうかを XML 宣言で指定したもの。 xmlStandalone に対応します。

    strictErrorChecking

    エラー時に DOMException をスローする。デフォルトは true

    substituteEntities

    非標準。 エンティティの置換を行うかどうか。 この属性は DOM の仕様にはなく、libxml 固有の独自仕様です。 デフォルトは false です。

    警告

    エンティティの置換を有効にすると、XML外部エンティティ参照攻撃(XXE) を容易にしてしまうかもしれません。

    validateOnParse

    DTD を読み込んで検証する。デフォルトは false

    警告

    DTD の検証を有効にすると、XML外部エンティティ参照攻撃(XXE) を容易にしてしまうかもしれません。