The DOMDocument class

    (PHP 5, PHP 7, PHP 8)

    简介

    Represents an entire HTML or XML document; serves as the root of the document tree.

    类摘要

    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): bool
    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::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
    }

    属性

    actualEncoding

    Deprecated. Actual encoding of the document, is a readonly equivalent to encoding.

    childElementCount

    The number of child elements.

    config

    Deprecated. Configuration used when DOMDocument::normalizeDocument() is invoked.

    doctype

    The Document Type Declaration associated with this document.

    documentElement

    The DOMElement object that is the first document element. If not found, this evaluates to null.

    documentURI

    The location of the document or null if undefined.

    encoding

    Encoding of the document, as specified by the XML declaration. This attribute is not present in the final DOM Level 3 specification, but is the only way of manipulating XML document encoding in this implementation.

    firstElementChild

    First child element or null.

    formatOutput

    Nicely formats output with indentation and extra space. This has no effect if the document was loaded with preserveWhitespace enabled.

    implementation

    The DOMImplementation object that handles this document.

    lastElementChild

    Last child element or null.

    preserveWhiteSpace

    Do not remove redundant white space. Default to true. Setting this to false has the same effect as passing LIBXML_NOBLANKS as option to DOMDocument::load() etc.

    recover

    Proprietary. Enables recovery mode, i.e. trying to parse non-well formed documents. This attribute is not part of the DOM specification and is specific to libxml.

    resolveExternals

    Set it to true to load external entities from a doctype declaration. This is useful for including character entities in your XML document.

    standalone

    Deprecated. Whether or not the document is standalone, as specified by the XML declaration, corresponds to xmlStandalone.

    strictErrorChecking

    Throws DOMException on errors. Default to true.

    substituteEntities

    Proprietary. Whether or not to substitute entities. This attribute is not part of the DOM specification and is specific to libxml. Default to false.

    警告

    Enabling entity substitution may facilitate XML External Entity (XXE) attacks.

    validateOnParse

    Loads and validates against the DTD. Default to false.

    警告

    Enabling validating the DTD may facilitate XML External Entity (XXE) attacks.

    version

    Deprecated. Version of XML, corresponds to xmlVersion.

    xmlEncoding

    An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.

    xmlStandalone

    An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified. A standalone document is one where there are no external markup declarations. An example of such a markup declaration is when the DTD declares an attribute with a default value.

    xmlVersion

    An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0".

    更新日志

    版本 说明
    8.0.0 DOMDocument implements DOMParentNode now.
    8.0.0 The unimplemented method DOMDocument::renameNode() has been removed.

    注释

    注意:

    此 DOM 扩展采用 UTF-8 编码。使用 mb_convert_encoding()、UConverter::transcode() 或 iconv() 来处理其它编码。

    注意:

    When using json_encode() on a DOMDocument object the result will be that of encoding an empty object.

    参见

    目录

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top