XMLWriter

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

Represents a writer that provides a non-cached, forward-only means of generating streams or files containing XML data

Interface Synopsis

class XMLWriter {...}

Public Methods

• ->__construct()
• ->endAttribute(): bool
  Ends the current attribute
• ->endCData(): bool
  Ends the current CDATA section
• ->endComment(): bool
  Ends the current comment
• ->endDTD(): bool
  Ends the DTD of the document
• ->endDTDAttlist(): bool
  Ends the current DTD attribute list
• ->endDTDElement(): bool
  Ends the current DTD element
• ->endDTDEntity(): bool
  Ends the current DTD entity
• ->endDocument(): bool
  Ends the current document
• ->endElement(): bool
  Ends the current element
• ->endPI(): bool
  Ends the current processing instruction
• ->flush(bool $empty = true): mixed
  Flushes the current buffer
• ->fullEndElement(): bool
  End the current xml element
• ->openMemory(): bool
  Create new xmlwriter using memory for string output
• ->openURI(string $uri): bool
  Creates a new XMLWriter using uri for the output
• ->outputMemory(bool $flush = true): string
  Returns the current buffer
• ->setIndent(bool $indent): bool
  Toggles indentation on or off
• ->setIndentString(string $indentstring): bool
  Sets the string which will be used to indent each element/attribute of the resulting xml
• ->startAttribute(string $name): bool
  Starts an attribute
• ->startAttributeNS(string $prefix, string $name, string $uri): bool
  Starts a namespaced attribute
• ->startCData(): bool
  Starts a CDATA
• ->startComment(): bool
  Starts a comment
• ->startDTD(string $qualifiedname, string $publicid = NULL, string $systemid = NULL): bool
  Starts a DTD
• ->startDTDAttlist(string $name): bool
  Starts a DTD attribute list
• ->startDTDElement(string $qualifiedname): bool
  Starts a DTD element
• ->startDTDEntity(string $name, bool $isparam): bool
  Starts a DTD entity
• ->startDocument(string $version = '1.0', string $encoding = NULL, string $standalone = NULL): bool
  Starts a document
• ->startElement(string $name): bool
  Starts an element
• ->startElementNS(mixed $prefix, string $name, string $uri): bool
  Starts a namespaced element
• ->startPI(string $target): bool
  Starts a processing instruction tag
• ->text(string $content): bool
  Writes a text
• ->writeAttribute(string $name, string $value): bool
  Writes a full attribute
• ->writeAttributeNS(string $prefix, string $name, string $uri, string $content): bool
  Writes a full namespaced attribute
• ->writeCData(string $content): bool
  Writes a full CDATA
• ->writeComment(string $content): bool
  Writes a full comment
• ->writeDTD(string $name, string $publicid = NULL, string $systemid = NULL, string $subset = NULL): bool
  Writes a full DTD
• ->writeDTDAttlist(string $name, string $content): bool
  Writes a DTD attribute list
• ->writeDTDElement(string $name, string $content): bool
  Writes a full DTD element
• ->writeDTDEntity(string $name, string $content, bool $pe = false, string $publicid = '', string $systemid = '', string $ndataid = ''): bool
  Writes a full DTD entity
• ->writeElement(string $name, string $content = NULL): bool
  Writes a full element tag
• ->writeElementNS(string $prefix, string $name, string $uri, string $content = NULL): bool
  Writes a full namespaced element tag
• ->writePI(string $target, string $content): bool
  Writes a processing instruction
• ->writeRaw(string $content): bool
  Writes a raw xml text