diff --git a/reference/xmlwriter/functions/xmlwriter-end-attribute.xml b/reference/xmlwriter/functions/xmlwriter-end-attribute.xml index 3b5848d8a5..7c1f6b2533 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-attribute.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-attribute.xml @@ -1,122 +1,57 @@ - + - xmlwriter_end_attribute - End attribute - returns FALSE on error + XMLWriter->endAttribute() + End attribute &reftitle.description; + Object oriented style: + + XMLWriter + + boolendAttribute + + + + Procedural style: boolxmlwriter_end_attribute resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current attribute. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-cdata.xml b/reference/xmlwriter/functions/xmlwriter-end-cdata.xml index 1529ebf53d..b8a60b94b6 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-cdata.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-cdata.xml @@ -1,123 +1,55 @@ - + - xmlwriter_end_cdata - End current CDATA - returns FALSE on error + XMLWriter->endCData() + End current CDATA &reftitle.description; + Object oriented style: + + XMLWriter + + boolendCData + + + + Procedural style: boolxmlwriter_end_cdata resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current CDATA section. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-comment.xml b/reference/xmlwriter/functions/xmlwriter-end-comment.xml index 4455833f09..4e938fd129 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-comment.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-comment.xml @@ -1,123 +1,55 @@ - + - xmlwriter_end_comment - Create end comment - returns FALSE on error + XMLWriter->endComment() + Create end comment &reftitle.description; + Object oriented style: + + XMLWriter + + boolendComment + + + + Procedural style: boolxmlwriter_end_comment resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current comment. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-document.xml b/reference/xmlwriter/functions/xmlwriter-end-document.xml index 8f082aa95b..596fbedac2 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-document.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-document.xml @@ -1,123 +1,54 @@ - + - xmlwriter_end_document - End current document - returns FALSE on error + XMLWriter->endDocument() + End current document &reftitle.description; + Object oriented style: + + XMLWriter + + boolendDocument + + + + Procedural style: boolxmlwriter_end_document resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current document. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-dtd-attlist.xml b/reference/xmlwriter/functions/xmlwriter-end-dtd-attlist.xml index 407882abb9..cf0ac67dd2 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-dtd-attlist.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-dtd-attlist.xml @@ -1,123 +1,55 @@ - + - xmlwriter_end_dtd_attlist - End current DTD AttList - returns FALSE on error + XMLWriter->endDTDAttlist() + End current DTD AttList &reftitle.description; + Object oriented style: + + XMLWriter + + boolendDTDAttlist + + + + Procedural style: boolxmlwriter_end_dtd_attlist resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current DTD attribute list. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-dtd-element.xml b/reference/xmlwriter/functions/xmlwriter-end-dtd-element.xml index be1a5f3091..e3b478f8cf 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-dtd-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-dtd-element.xml @@ -1,123 +1,55 @@ - + - xmlwriter_end_dtd_element - End current DTD element - returns FALSE on error + XMLWriter->endDTDElement() + End current DTD element &reftitle.description; + Object oriented style: + + XMLWriter + + boolendDTDElement + + + + Procedural style: boolxmlwriter_end_dtd_element resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current DTD element. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-dtd-entity.xml b/reference/xmlwriter/functions/xmlwriter-end-dtd-entity.xml index a23caae451..6bc2595549 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-dtd-entity.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-dtd-entity.xml @@ -1,123 +1,54 @@ - + - xmlwriter_end_dtd_entity - End current DTD Entity - returns FALSE on error + XMLWriter->endDTDEntity() + End current DTD Entity &reftitle.description; + Object oriented style: + + XMLWriter + + boolendDTDEntity + + + + Procedural style: boolxmlwriter_end_dtd_entity resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current DTD entity. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-dtd.xml b/reference/xmlwriter/functions/xmlwriter-end-dtd.xml index 02069c13a7..23b39c3ef8 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-dtd.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-dtd.xml @@ -1,125 +1,57 @@ - + - xmlwriter_end_dtd - End current DTD - returns FALSE on error + XMLWriter->endDTD() + End current DTD &reftitle.description; + Object oriented style: + + XMLWriter + + boolendDTD + + + + Procedural style: boolxmlwriter_end_dtd resourcexmlwriter - - &warn.undocumented.func; - + + Ends the DTD of the document. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - - + + - xmlwriter_end_element - End current element - returns FALSE on error + XMLWriter->endElement() + End current element &reftitle.description; + Object oriented style: + + XMLWriter + + boolendElement + + + + Procedural style: boolxmlwriter_end_element resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current element. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-end-pi.xml b/reference/xmlwriter/functions/xmlwriter-end-pi.xml index 4eb4942526..676e64f27d 100644 --- a/reference/xmlwriter/functions/xmlwriter-end-pi.xml +++ b/reference/xmlwriter/functions/xmlwriter-end-pi.xml @@ -1,123 +1,55 @@ - + - xmlwriter_end_pi - End current PI - returns FALSE on error + XMLWriter->endPI() + End current PI &reftitle.description; + Object oriented style: + + XMLWriter + + boolendPI + + + + Procedural style: boolxmlwriter_end_pi resourcexmlwriter - - &warn.undocumented.func; - + + Ends the current processing instruction. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-flush.xml b/reference/xmlwriter/functions/xmlwriter-flush.xml index 17f167071b..a05feea5fa 100644 --- a/reference/xmlwriter/functions/xmlwriter-flush.xml +++ b/reference/xmlwriter/functions/xmlwriter-flush.xml @@ -1,133 +1,58 @@ - + - xmlwriter_flush - Output current buffer + XMLWriter->flush() + Flush current buffer &reftitle.description; + Object oriented style: + + XMLWriter + + mixedflush + boolempty + + + Procedural style: mixedxmlwriter_flush resourcexmlwriter boolempty - - &warn.undocumented.func; - + + Flushes the current buffer. + + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; empty - Its description + Whether to empty the buffer or no. Default is &true;. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + If you opened the writer in memory, this function returns the generated XML buffer, + Else, if using URI, this function will write the buffer and return the number of + written bytes. - - - - - - - - - - - - + - xmlwriter_full_end_element - End current element - returns FALSE on error + XMLWriter->fullEndElement() + End current element &reftitle.description; + Object oriented style: + + XMLWriter + + boolfullEndElement + + + + Procedural style: boolxmlwriter_full_end_element resourcexmlwriter - - &warn.undocumented.func; - + + End the current xml element. Writes an end tag even if the element is empty. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-open-memory.xml b/reference/xmlwriter/functions/xmlwriter-open-memory.xml index ebea6e0e1a..0251b69e93 100644 --- a/reference/xmlwriter/functions/xmlwriter-open-memory.xml +++ b/reference/xmlwriter/functions/xmlwriter-open-memory.xml @@ -1,113 +1,55 @@ - + - xmlwriter_open_memory + XMLWriter->openMemory() Create new xmlwriter using memory for string output &reftitle.description; + Object oriented style: + + XMLWriter + + boolopenMemory + + + + Procedural style: resourcexmlwriter_open_memory - - &warn.undocumented.func; - + + Creates a new XMLWriter using memory for string output. + &reftitle.parameters; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + Object oriented style: &return.success;. - - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-open-uri.xml b/reference/xmlwriter/functions/xmlwriter-open-uri.xml index 42d48e95c0..7fbbdbcb5e 100644 --- a/reference/xmlwriter/functions/xmlwriter-open-uri.xml +++ b/reference/xmlwriter/functions/xmlwriter-open-uri.xml @@ -1,123 +1,65 @@ - + - xmlwriter_open_uri + XMLWriter->openURI() Create new xmlwriter using source uri for output &reftitle.description; + Object oriented style: + + XMLWriter + + boolopenURI + stringuri + + + Procedural style: resourcexmlwriter_open_uri - stringsource + stringuri - - &warn.undocumented.func; - + + Creates a new XMLWriter using uri for the output. + &reftitle.parameters; - source + uri - Its description + The URI of the resource for the output. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + Object oriented style: &return.success;. - - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-output-memory.xml b/reference/xmlwriter/functions/xmlwriter-output-memory.xml index 5bb48894c7..1368137eca 100644 --- a/reference/xmlwriter/functions/xmlwriter-output-memory.xml +++ b/reference/xmlwriter/functions/xmlwriter-output-memory.xml @@ -1,132 +1,63 @@ - + - xmlwriter_output_memory - Output current buffer as string + XMLWriter->outputMemory() + Returns current buffer &reftitle.description; + Object oriented style: + + XMLWriter + + booloutputMemory + boolflush + + + Procedural style: stringxmlwriter_output_memory resourcexmlwriter boolflush - - &warn.undocumented.func; - + + Returns the current buffer. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; flush - Its description + Whether to flush the output buffer or no. Default is &true;. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + Returns the current buffer as a string. - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-set-indent-string.xml b/reference/xmlwriter/functions/xmlwriter-set-indent-string.xml index 7d64a5d1dd..40f9f4002d 100644 --- a/reference/xmlwriter/functions/xmlwriter-set-indent-string.xml +++ b/reference/xmlwriter/functions/xmlwriter-set-indent-string.xml @@ -1,132 +1,64 @@ - + - xmlwriter_set_indent_string - Set string used for indenting - returns FALSE on error + XMLWriter->setIndentString() + Set string used for indenting &reftitle.description; + Object oriented style: + + XMLWriter + + boolsetIndentString + stringindentString + + + Procedural style: boolxmlwriter_set_indent_string resourcexmlwriter stringindentString - - &warn.undocumented.func; - + + Sets the string which will be used to indent each element/attribute of the + resulting xml. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; indentString - Its description + The indentation string. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-set-indent.xml b/reference/xmlwriter/functions/xmlwriter-set-indent.xml index b4f0032dd1..1259d3ede5 100644 --- a/reference/xmlwriter/functions/xmlwriter-set-indent.xml +++ b/reference/xmlwriter/functions/xmlwriter-set-indent.xml @@ -1,132 +1,63 @@ - + - xmlwriter_set_indent - Toggle indentation on/off - returns FALSE on error + XMLWriter->setIndent() + Toggle indentation on/off &reftitle.description; + Object oriented style: + + XMLWriter + + boolsetIndent + boolindent + + + Procedural style: boolxmlwriter_set_indent resourcexmlwriter boolindent - - &warn.undocumented.func; - + + Toggles indentation on or off. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; indent - Its description + Whether indentation is enabled. Defaults to &false;. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-attribute-ns.xml b/reference/xmlwriter/functions/xmlwriter-start-attribute-ns.xml index 70b3534454..1264b5dc23 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-attribute-ns.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-attribute-ns.xml @@ -1,13 +1,24 @@ - + - xmlwriter_start_attribute_ns - Create start namespaced attribute - returns FALSE on error + XMLWriter->startAttributeNS() + Create start namespaced attribute &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartAttributeNS + stringprefix + stringname + stringuri + + + Procedural style: boolxmlwriter_start_attribute_ns resourcexmlwriter @@ -15,27 +26,20 @@ stringname stringuri - - &warn.undocumented.func; - + + Starts a namespaced attribute. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; prefix - Its description + The namespace prefix. @@ -43,7 +47,7 @@ name - Its description + The attribute name. @@ -51,100 +55,32 @@ uri - Its description + The namespace URI. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-attribute.xml b/reference/xmlwriter/functions/xmlwriter-start-attribute.xml index 93faa1fccb..4f3e7b5ad1 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-attribute.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-attribute.xml @@ -1,132 +1,66 @@ - + - xmlwriter_start_attribute - Create start attribute - returns FALSE on error + XMLWriter->startAttribute() + Create start attribute &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartAttribute + stringname + + + Procedural style: boolxmlwriter_start_attribute resourcexmlwriter stringname - - &warn.undocumented.func; - + + Starts an attribute. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The attribute name. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-cdata.xml b/reference/xmlwriter/functions/xmlwriter-start-cdata.xml index dd3e3a0caf..8d307bcae3 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-cdata.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-cdata.xml @@ -1,123 +1,55 @@ - + - xmlwriter_start_cdata - Create start CDATA tag - returns FALSE on error + XMLWriter->startCData() + Create start CDATA tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartCData + + + + Procedural style: boolxmlwriter_start_cdata resourcexmlwriter - - &warn.undocumented.func; - + + Starts a CDATA. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-comment.xml b/reference/xmlwriter/functions/xmlwriter-start-comment.xml index a236c14a4e..414dcd120d 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-comment.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-comment.xml @@ -1,123 +1,55 @@ - + - xmlwriter_start_comment - Create start comment - returns FALSE on error + XMLWriter->startComment() + Create start comment &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartComment + + + + Procedural style: boolxmlwriter_start_comment resourcexmlwriter - - &warn.undocumented.func; - + + Starts a comment. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-document.xml b/reference/xmlwriter/functions/xmlwriter-start-document.xml index 0ed47513a7..5f7cd557a7 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-document.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-document.xml @@ -1,13 +1,24 @@ - + - xmlwriter_start_document - Create document tag - returns FALSE on error + XMLWriter->startDocument() + Create document tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartDocument + stringversion + stringencoding + stringstandalone + + + Procedural style: boolxmlwriter_start_document resourcexmlwriter @@ -15,27 +26,21 @@ stringencoding stringstandalone - - &warn.undocumented.func; - + + Starts a document. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; version - Its description + The version number of the document as part of the XML declaration. + Defaults to 1.0. @@ -43,7 +48,8 @@ encoding - Its description + The encoding of the document as part of the XML declaration. + &null by default. @@ -51,100 +57,30 @@ standalone - Its description + yes or no. + &null; by default. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-dtd-attlist.xml b/reference/xmlwriter/functions/xmlwriter-start-dtd-attlist.xml index ac327d0f38..2a826cb03a 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-dtd-attlist.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-dtd-attlist.xml @@ -1,132 +1,64 @@ - + - xmlwriter_start_dtd_attlist - Create start DTD AttList - returns FALSE on error + XMLWriter->startDTDAttlist() + Create start DTD AttList &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartDTDAttlist + stringname + + + Procedural style: boolxmlwriter_start_dtd_attlist resourcexmlwriter stringname - - &warn.undocumented.func; - + + Starts a DTD attribute list. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The attribute list name. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-dtd-element.xml b/reference/xmlwriter/functions/xmlwriter-start-dtd-element.xml index 8be4c40b63..cbd01b4b53 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-dtd-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-dtd-element.xml @@ -1,132 +1,64 @@ - + - xmlwriter_start_dtd_element - Create start DTD element - returns FALSE on error + XMLWriter->startDTDElement() + Create start DTD element &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartDTDElement + stringqualifiedName + + + Procedural style: boolxmlwriter_start_dtd_element resourcexmlwriter - stringname + stringqualifiedName - - &warn.undocumented.func; - + + Starts a DTD element. + &reftitle.parameters; + &xmlwriter.xmlwriter.description; - xmlwriter + qualifiedName - Its description - - - - - name - - - Its description + The qualified name of the document type to create. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-dtd-entity.xml b/reference/xmlwriter/functions/xmlwriter-start-dtd-entity.xml index d462ff8244..9df2a21b68 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-dtd-entity.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-dtd-entity.xml @@ -1,40 +1,43 @@ - + - xmlwriter_start_dtd_entity - Create start DTD Entity - returns FALSE on error + XMLWriter->startDTDEntity() + Create start DTD Entity &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartDTDEntity + stringname + boolisparam + + + Procedural style: boolxmlwriter_start_dtd_entity resourcexmlwriter stringname boolisparam - - &warn.undocumented.func; - + + Starts a DTD entity. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The name of the entity. @@ -42,100 +45,29 @@ isparam - Its description + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-dtd.xml b/reference/xmlwriter/functions/xmlwriter-start-dtd.xml index f41c85bce3..652f67f24c 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-dtd.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-dtd.xml @@ -1,150 +1,84 @@ - + - xmlwriter_start_dtd - Create start DTD tag - returns FALSE on error + XMLWriter->startDTD() + Create start DTD tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartDTD + stringqualifiedName + stringpublicId + stringsystemId + + + Procedural style: boolxmlwriter_start_dtd resourcexmlwriter - stringname - stringpubid - stringsysid + stringqualifiedName + stringpublicId + stringsystemId - - &warn.undocumented.func; - + + Starts a DTD. + &reftitle.parameters; + &xmlwriter.xmlwriter.description; - xmlwriter + qualifiedName - Its description + The qualified name of the document type to create. - name + publicId - Its description + The external subset public identifier. - pubid + systemId - Its description - - - - - sysid - - - Its description + The external subset system identifier. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-element-ns.xml b/reference/xmlwriter/functions/xmlwriter-start-element-ns.xml index 1fa7b482a3..e63dea1423 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-element-ns.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-element-ns.xml @@ -1,13 +1,24 @@ - + - xmlwriter_start_element_ns - Create start namespaced element tag - returns FALSE on error + XMLWriter->startElementNS() + Create start namespaced element tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartElementNS + stringprefix + stringname + stringuri + + + Procedural style: boolxmlwriter_start_element_ns resourcexmlwriter @@ -15,27 +26,20 @@ stringname stringuri - - &warn.undocumented.func; - + + Starts a namespaced element. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; prefix - Its description + The namespace prefix. @@ -43,7 +47,7 @@ name - Its description + The element name. @@ -51,100 +55,30 @@ uri - Its description + The namespace URI. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-element.xml b/reference/xmlwriter/functions/xmlwriter-start-element.xml index 2a61a9d36b..2a6a1423fa 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-element.xml @@ -1,132 +1,64 @@ - + - xmlwriter_start_element - Create start element tag - returns FALSE on error + XMLWriter->startElement() + Create start element tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartElement + stringname + + + Procedural style: boolxmlwriter_start_element resourcexmlwriter stringname - - &warn.undocumented.func; - + + Starts an element. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The element name. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-start-pi.xml b/reference/xmlwriter/functions/xmlwriter-start-pi.xml index ac3aa6b7d4..5fbf4059ae 100644 --- a/reference/xmlwriter/functions/xmlwriter-start-pi.xml +++ b/reference/xmlwriter/functions/xmlwriter-start-pi.xml @@ -1,132 +1,64 @@ - + - xmlwriter_start_pi - Create start PI tag - returns FALSE on error + XMLWriter->startPI() + Create start PI tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolstartPI + stringtarget + + + Procedural style: boolxmlwriter_start_pi resourcexmlwriter stringtarget - - &warn.undocumented.func; - + + Starts a processing instruction tag. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; target - Its description + The target of the processing instruction. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-text.xml b/reference/xmlwriter/functions/xmlwriter-text.xml index e36014cd52..83c075acac 100644 --- a/reference/xmlwriter/functions/xmlwriter-text.xml +++ b/reference/xmlwriter/functions/xmlwriter-text.xml @@ -1,133 +1,55 @@ - + - xmlwriter_text - Write text - returns FALSE on error + XMLWriter->text() + Write text &reftitle.description; + Object oriented style: + + XMLWriter + + booltext + stringcontent + + + Procedural style: boolxmlwriter_text resourcexmlwriter stringcontent - - &warn.undocumented.func; - + + Writes a text. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; content - Its description + The contents of the text. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - - + - xmlwriter_write_attribute_ns - Write full namespaced attribute - returns FALSE on error + XMLWriter->writeAttributeNS() + Write full namespaced attribute &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteAttributeNS + stringprefix + stringname + stringuri + stringcontent + + + Procedural style: boolxmlwriter_write_attribute_ns resourcexmlwriter @@ -16,27 +28,20 @@ stringuri stringcontent - - &warn.undocumented.func; - + + Writes a full namespaced attribute. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; prefix - Its description + The namespace prefix. @@ -44,7 +49,7 @@ name - Its description + The attribute name. @@ -52,7 +57,7 @@ uri - Its description + The namespace URI. @@ -60,100 +65,32 @@ content - Its description + The attribute value. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-attribute.xml b/reference/xmlwriter/functions/xmlwriter-write-attribute.xml index 9c34c89d5c..2f303530dc 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-attribute.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-attribute.xml @@ -1,140 +1,76 @@ - + - xmlwriter_write_attribute - Write full attribute - returns FALSE on error + XMLWriter->writeAttribute() + Write full attribute &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteAttribute + stringname + stringvalue + + + Procedural style: boolxmlwriter_write_attribute resourcexmlwriter stringname - stringcontent + stringvalue - - &warn.undocumented.func; - + + Writes a full attribute. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The name of the attribute. - content + value - Its description + The value of the attribute. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-cdata.xml b/reference/xmlwriter/functions/xmlwriter-write-cdata.xml index eadce5f69c..f5803667cf 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-cdata.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-cdata.xml @@ -1,132 +1,64 @@ - + - xmlwriter_write_cdata - Write full CDATA tag - returns FALSE on error + XMLWriter->writeCData() + Write full CDATA tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteCData + stringcontent + + + Procedural style: boolxmlwriter_write_cdata resourcexmlwriter stringcontent - - &warn.undocumented.func; - + + Writes a full CDATA. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; content - Its description + The contents of the CDATA. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-comment.xml b/reference/xmlwriter/functions/xmlwriter-write-comment.xml index ed65db53b9..0d14e355cd 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-comment.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-comment.xml @@ -1,132 +1,64 @@ - + - xmlwriter_write_comment - Write full comment tag - returns FALSE on error + XMLWriter->writeComment() + Write full comment tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteComment + stringcontent + + + Procedural style: boolxmlwriter_write_comment resourcexmlwriter stringcontent - - &warn.undocumented.func; - + + Writes a full comment. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; content - Its description + The contents of the comment. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-dtd-attlist.xml b/reference/xmlwriter/functions/xmlwriter-write-dtd-attlist.xml index 40d8216199..fb6a55c3f4 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-dtd-attlist.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-dtd-attlist.xml @@ -1,40 +1,43 @@ - + - xmlwriter_write_dtd_attlist - Write full DTD AttList tag - returns FALSE on error + XMLWriter->writeDTDAttlist() + Write full DTD AttList tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteDTDAttlist + stringname + stringcontent + + + Procedural style: boolxmlwriter_write_dtd_attlist resourcexmlwriter stringname stringcontent - - &warn.undocumented.func; - + + Writes a DTD attribute list. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The name of the DTD attribute list. @@ -42,100 +45,30 @@ content - Its description + The content of the DTD attribute list. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-dtd-element.xml b/reference/xmlwriter/functions/xmlwriter-write-dtd-element.xml index f108ab818d..4ed71f3afb 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-dtd-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-dtd-element.xml @@ -1,40 +1,43 @@ - + - xmlwriter_write_dtd_element - Write full DTD element tag - returns FALSE on error + XMLWriter->writeDTDElement() + Write full DTD element tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteDTDElement + stringname + stringcontent + + + Procedural style: boolxmlwriter_write_dtd_element resourcexmlwriter stringname stringcontent - - &warn.undocumented.func; - + + Writes a full DTD element. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The name of the DTD element. @@ -42,100 +45,30 @@ content - Its description + The content of the element. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml b/reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml index 81b5a76ce1..3f6c5c9ed2 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml @@ -1,40 +1,43 @@ - + - xmlwriter_write_dtd_entity - Write full DTD Entity tag - returns FALSE on error + XMLWriter->writeDTDEntity() + Write full DTD Entity tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteDTDEntity + stringname + stringcontent + + + Procedural style: boolxmlwriter_write_dtd_entity resourcexmlwriter stringname stringcontent - - &warn.undocumented.func; - + + Writes a full DTD entity. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The name of the entity. @@ -42,100 +45,30 @@ content - Its description + The content of the entity. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-dtd.xml b/reference/xmlwriter/functions/xmlwriter-write-dtd.xml index 4da55c55e6..e000ad0af8 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-dtd.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-dtd.xml @@ -1,58 +1,63 @@ - + - xmlwriter_write_dtd - Write full DTD tag - returns FALSE on error + XMLWriter->writeDTD() + Write full DTD tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteDTD + stringname + stringpublicId + stringsystemId + stringsubset + + + Procedural style: boolxmlwriter_write_dtd resourcexmlwriter stringname - stringpubid - stringsysid + stringpublicId + stringsystemId stringsubset - - &warn.undocumented.func; - + + Writes a full DTD. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The DTD name. - pubid + publicId - Its description + The external subset public identifier. - sysid + systemId - Its description + The external subset system identifier. @@ -60,100 +65,30 @@ subset - Its description + The content of the DTD. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml b/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml index f00533de66..83a3ad4dbd 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml @@ -1,13 +1,25 @@ - + - xmlwriter_write_element_ns - Write full namesapced element tag - returns FALSE on error + XMLWriter->writeElementNS() + Write full namesapced element tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteElementNS + stringprefix + stringname + stringuri + stringcontent + + + Procedural style: boolxmlwriter_write_element_ns resourcexmlwriter @@ -16,27 +28,20 @@ stringuri stringcontent - - &warn.undocumented.func; - + + Writes a full namesapced element tag. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; prefix - Its description + The namespace prefix. @@ -44,7 +49,7 @@ name - Its description + The element name. @@ -52,7 +57,7 @@ uri - Its description + The namespace URI. @@ -60,100 +65,31 @@ content - Its description + The element contents. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-element.xml b/reference/xmlwriter/functions/xmlwriter-write-element.xml index e978801132..42a0d38b14 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-element.xml @@ -1,40 +1,43 @@ - + - xmlwriter_write_element - Write full element tag - returns FALSE on error + XMLWriter->writeElement() + Write full element tag &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteElement + stringname + stringcontent + + + Procedural style: boolxmlwriter_write_element resourcexmlwriter stringname stringcontent - - &warn.undocumented.func; - + + Writes a full element taf. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; name - Its description + The element name. @@ -42,100 +45,31 @@ content - Its description + The element contents. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-pi.xml b/reference/xmlwriter/functions/xmlwriter-write-pi.xml index c7848c3056..2b9e1a29e2 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-pi.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-pi.xml @@ -1,40 +1,43 @@ - + - xmlwriter_write_pi - Write full PI tag - returns FALSE on error + XMLWriter->writePI() + Writes a PI &reftitle.description; + Object oriented style: + + XMLWriter + + boolwritePI + stringtarget + stringcontent + + + Procedural style: boolxmlwriter_write_pi resourcexmlwriter stringtarget stringcontent - - &warn.undocumented.func; - + + Writes a processing instruction. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; target - Its description + The target of the processing instruction. @@ -42,100 +45,30 @@ content - Its description + The content of the processing instruction. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/functions/xmlwriter-write-raw.xml b/reference/xmlwriter/functions/xmlwriter-write-raw.xml index 99215b6418..70f2c438c6 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-raw.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-raw.xml @@ -1,132 +1,63 @@ - + - xmlwriter_write_raw - Write text - returns FALSE on error + XMLWriter->writeRaw() + Write a raw XML text &reftitle.description; + Object oriented style: + + XMLWriter + + boolwriteRaw + stringcontent + + + Procedural style: boolxmlwriter_write_raw resourcexmlwriter stringcontent - - &warn.undocumented.func; - + + Writes a raw xml text. + &reftitle.parameters; - - xmlwriter - - - Its description - - - + &xmlwriter.xmlwriter.description; content - Its description + The text string to write. + &reftitle.returnvalues; - What the function returns, first on success, then on failure. See - also the &return.success; entity + &return.success; - - - - - - - - - - - diff --git a/reference/xmlwriter/reference.xml b/reference/xmlwriter/reference.xml index 9513fb856c..ec590f04bb 100644 --- a/reference/xmlwriter/reference.xml +++ b/reference/xmlwriter/reference.xml @@ -1,39 +1,186 @@ - + - xmlwriter Functions - xmlwriter + XMLWriter Functions + XMLWriter
&reftitle.intro; - This is the xmlwriter extension. It - currently only lists the proto definitions. + This is the XMLWriter extension. It wraps the libxml xmlWriter API. -
-
- &reftitle.required; - To be written. For example what external libraries are required + This extension represents a writer that provides a non-cached, + forward-only means of generating streams or files containing XML data. + + + This extension can be used in an object oriented style or a procedural + one. Every method documented describes the alternative procedural call.
- - - - +
+ &reftitle.classes; + + +
+ <classname>XMLWriter</classname> + + +
+ &reftitle.methods; + + + - End attribute + + + - End current CDATA + + + - Create end comment + + + - End current document + + + - End current DTD AttList + + + - End current DTD element + + + - End current DTD Entity + + + - End current DTD + + + - End current element + + + - End current PI + + + - Flush current buffer + + + - End current element + + + - Create new xmlwriter using memory for string output + + + - Create new xmlwriter using source uri for output + + + - Returns current buffer + + + - Set string used for indenting + + + - Toggle indentation on/off + + + - Create start namespaced attribute + + + - Create start attribute + + + - Create start CDATA tag + + + - Create start comment + + + - Create document tag + + + - Create start DTD AttList + + + - Create start DTD element + + + - Create start DTD Entity + + + - Create start DTD tag + + + - Create start namespaced element tag + + + - Create start element tag + + + - Create start PI tag + + + - Write text + + + - Write full namespaced attribute + + + - Write full attribute + + + - Write full CDATA tag + + + - Write full comment tag + + + - Write full DTD AttList tag + + + - Write full DTD element tag + + + - Write full DTD Entity tag + + + - Write full DTD tag + + + - Write full namesapced element tag + + + - Write full element tag + + + - Writes a PI + + + - Write a raw XML text + + +
+
+
+ +
&reftitle.resources; - Type of resource types (link id, etc.) this extension returns. + There is one resource used by the procedural version of the XMLWriter + extension: returned by xmlwriter_open_memory or + xmlwriter_open_uri. - &no.resource;
+ +
+ &reftitle.constants; + &no.constants; +
+ &reference.xmlwriter.functions;