Docs For Class PEAR_PackageFile_Generator_v2_XML

string apiVersion(
)

return API version

Return: API version
Access: public

[ Top ]

string attributesToString(
array
$attributes, [boolean|array
$sort = true], [boolean
$multiline = false], [string
$indent = '    '], [string
$linebreak = "\n"], [integer
$entities = PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML])

create string representation of an attribute list

 require_once 'XML/Util.php';

 
 // build an attribute string
 $att = array(
              "foo"   =>  "bar",
              "argh"  =>  "tomato"
            );
 
 $attList = PEAR_PackageFile_Generator_v2_XML_Util::attributesToString($att);

Return: string representation of the attributes
Todo: allow sort also to be an options array
Access: public
Usedby: PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray() - to serialize the attributes of the tag
Uses: PEAR_PackageFile_Generator_v2_XML_Util::replaceEntities() - to replace XML entities in attribute values
Usedby: PEAR_PackageFile_Generator_v2_XML_Util::getXMLDeclaration() - to serialize the attributes of the XML declaration

Parameters:

array	`$attributes`	—	attribute array
boolean\|array	`$sort`	—	sort attribute list alphabetically, may also be an assoc array containing the keys 'sort', 'multiline', 'indent', 'linebreak' and 'entities'
boolean	`$multiline`	—	use linebreaks, if more than one attribute is given
string	`$indent`	—	string used for indentation of multiline attributes
string	`$linebreak`	—	string used for linebreaks of multiline attributes
integer	`$entities`	—	setting for entities in attribute values (one of PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_NONE, PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML, PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML_REQUIRED, PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_HTML)

[ Top ]

string createCDataSection(
string
$data)

create a CData section

 require_once 'XML/Util.php';

 
 // create a CData section
 $tag = PEAR_PackageFile_Generator_v2_XML_Util::createCDataSection("I am content.");

Return: CData section with content
Access: public

Parameters:

string $data — data of the CData section

[ Top ]

string createComment(
string
$content)

create an XML comment

 require_once 'XML/Util.php';

 
 // create an XML start element:
 $tag = PEAR_PackageFile_Generator_v2_XML_Util::createComment("I am a comment");

Return: XML comment
Access: public

Parameters:

string $content — content of the comment

[ Top ]

string createEndElement(
string
$qname)

create an end element

 require_once 'XML/Util.php';

 
 // create an XML start element:
 $tag = PEAR_PackageFile_Generator_v2_XML_Util::createEndElement("myNs:myTag");

Return: XML end element
See: PEAR_PackageFile_Generator_v2_XML_Util::createStartElement(), PEAR_PackageFile_Generator_v2_XML_Util::createTag()
Access: public

Parameters:

string $qname — qualified tagname (including namespace)

[ Top ]

string createStartElement(
string
$qname, [array
$attributes = array()], [string
$namespaceUri = null], [boolean
$multiline = false], [string
$indent = '_auto'], [string
$linebreak = "\n"])

create a start element

 require_once 'XML/Util.php';

 
 // create an XML start element:
 $tag = PEAR_PackageFile_Generator_v2_XML_Util::createStartElement("myNs:myTag", array("foo" => "bar") ,"http://www.w3c.org/myNs#");

Return: XML start element
See: PEAR_PackageFile_Generator_v2_XML_Util::createEndElement(), PEAR_PackageFile_Generator_v2_XML_Util::createTag()
Access: public

Parameters:

string	`$qname`	—	qualified tagname (including namespace)
array	`$attributes`	—	array containg attributes
string	`$namespaceUri`	—	URI of the namespace
boolean	`$multiline`	—	whether to create a multiline tag where each attribute gets written to a single line
string	`$indent`	—	string used to indent attributes (_auto indents attributes so they start at the same column)
string	`$linebreak`	—	string used for linebreaks

[ Top ]

string createTag(
string
$qname, [array
$attributes = array()], [mixed
$content = null], [string
$namespaceUri = null], [integer
$replaceEntities = PEAR_PackageFile_Generator_v2_XML_Util_REPLACE_ENTITIES], [boolean
$multiline = false], [string
$indent = "_auto"], [string
$linebreak = "\n"], [string
$encoding = PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML])

create a tag

This method will call PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray(), which is more flexible.

 require_once 'XML/Util.php';

 
 // create an XML tag:
 $tag = PEAR_PackageFile_Generator_v2_XML_Util::createTag("myNs:myTag", array("foo" => "bar"), "This is inside the tag", "http://www.w3c.org/myNs#");

Return: XML tag
See: PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray()
Access: public
Uses: PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray() - to create the tag

Parameters:

string	`$qname`	—	qualified tagname (including namespace)
array	`$attributes`	—	array containg attributes
mixed	`$content`	—
string	`$namespaceUri`	—	URI of the namespace
integer	`$replaceEntities`	—	whether to replace XML special chars in content, embedd it in a CData section or none of both
boolean	`$multiline`	—	whether to create a multiline tag where each attribute gets written to a single line
string	`$indent`	—	string used to indent attributes (_auto indents attributes so they start at the same column)
string	`$linebreak`	—	string used for linebreaks
string	`$encoding`	—	encoding that should be used to translate content

[ Top ]

string createTagFromArray(
array
$tag, [integer
$replaceEntities = PEAR_PackageFile_Generator_v2_XML_Util_REPLACE_ENTITIES], [boolean
$multiline = false], [string
$indent = "_auto"], [string
$linebreak = "\n"], [
$encoding = PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML])

create a tag from an array

this method awaits an array in the following format

 array(
  "qname"        => $qname         // qualified name of the tag
  "namespace"    => $namespace     // namespace prefix (optional, if qname is specified or no namespace)
  "localpart"    => $localpart,    // local part of the tagname (optional, if qname is specified)
  "attributes"   => array(),       // array containing all attributes (optional)
  "content"      => $content,      // tag content (optional)
  "namespaceUri" => $namespaceUri  // namespaceUri for the given namespace (optional)
   )

 require_once 'XML/Util.php';

 
 $tag = array(
           "qname"        => "foo:bar",
           "namespaceUri" => "http://foo.com",
           "attributes"   => array( "key" => "value", "argh" => "fruit&vegetable" ),
           "content"      => "I'm inside the tag",
            );
 // creating a tag with qualified name and namespaceUri
 $string = PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray($tag);

Return: XML tag
See: PEAR_PackageFile_Generator_v2_XML_Util::createTag()
Access: public
Usedby: PEAR_PackageFile_Generator_v2_XML_Util::createTag() - to create the tag
Uses: PEAR_PackageFile_Generator_v2_XML_Util::attributesToString() - to serialize the attributes of the tag
Uses: PEAR_PackageFile_Generator_v2_XML_Util::splitQualifiedName() - to get local part and namespace of a qualified name

Parameters:

array	`$tag`	—	tag definition
integer	`$replaceEntities`	—	whether to replace XML special chars in content, embedd it in a CData section or none of both
boolean	`$multiline`	—	whether to create a multiline tag where each attribute gets written to a single line
string	`$indent`	—	string used to indent attributes (_auto indents attributes so they start at the same column)
string	`$linebreak`	—	string used for linebreaks
	`$encoding`	—

[ Top ]

string getDocTypeDeclaration(
string
$root, [string
$uri = null], [string
$internalDtd = null])

build a document type declaration

 require_once 'XML/Util.php';

 
 // get a doctype declaration:
 $xmlDecl = PEAR_PackageFile_Generator_v2_XML_Util::getDocTypeDeclaration("rootTag","myDocType.dtd");

Return: doctype declaration
Since: 0.2
Access: public

Parameters:

string	`$root`	—	name of the root tag
string	`$uri`	—	uri of the doctype definition (or array with uri and public id)
string	`$internalDtd`	—	internal dtd entries

[ Top ]

string getXMLDeclaration(
[string
$version = "1.0"], [string
$encoding = null], [
$standalone = null], boolean
$standAlone)

build an xml declaration

 require_once 'XML/Util.php';

 
 // get an XML declaration:
 $xmlDecl = PEAR_PackageFile_Generator_v2_XML_Util::getXMLDeclaration("1.0", "UTF-8", true);

Return: xml declaration
Access: public
Uses: PEAR_PackageFile_Generator_v2_XML_Util::attributesToString() - to serialize the attributes of the XML declaration

Parameters:

string	`$version`	—	xml version
string	`$encoding`	—	character encoding
boolean	`$standAlone`	—	document is standalone (or not)
	`$standalone`	—

[ Top ]

mixed isValidName(
string
$string)

check, whether string is valid XML name

XML names are used for tagname, attribute names and various other, lesser known entities.

An XML name may only consist of alphanumeric characters, dashes, undescores and periods, and has to start with a letter or an underscore.

 require_once 'XML/Util.php';

 
 // verify tag name
 $result = PEAR_PackageFile_Generator_v2_XML_Util::isValidName("invalidTag?");
 if (PEAR_PackageFile_Generator_v2_XML_Util::isError($result)) {
    print "Invalid XML name: " . $result->getMessage();
 }

Return: true, if string is a valid XML name, PEAR error otherwise
Todo: support for other charsets
Access: public

Parameters:

string $string — string that should be checked

[ Top ]

object PEAR_Error raiseError(
string
$msg, integer
$code)

replacement for PEAR_PackageFile_Generator_v2_XML_Util::raiseError

Avoids the necessity to always require PEAR.php

Access: public

Parameters:

string	`$msg`	—	error message
integer	`$code`	—	error code

[ Top ]

string replaceEntities(
string
$string, [integer
$replaceEntities = PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML])

replace XML entities

With the optional second parameter, you may select, which entities should be replaced.

 require_once 'XML/Util.php';

 
 // replace XML entites:
 $string = PEAR_PackageFile_Generator_v2_XML_Util::replaceEntities("This string contains < & >.");

Return: string with replaced chars
Access: public
Usedby: PEAR_PackageFile_Generator_v2_XML_Util::attributesToString() - to replace XML entities in attribute values

Parameters:

string	`$string`	—	string where XML special chars should be replaced
integer	`$replaceEntities`	—	setting for entities in attribute values (one of PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML, PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_XML_REQUIRED, PEAR_PackageFile_Generator_v2_XML_Util_ENTITIES_HTML)

[ Top ]

array splitQualifiedName(
string
$qname, [string
$defaultNs = null])

split qualified name and return namespace and local part

 require_once 'XML/Util.php';

 
 // split qualified tag
 $parts = PEAR_PackageFile_Generator_v2_XML_Util::splitQualifiedName("xslt:stylesheet");

the returned array will contain two elements:

 array(
       "namespace" => "xslt",
       "localPart" => "stylesheet"
      );

Return: array containing namespace and local part
Access: public
Usedby: PEAR_PackageFile_Generator_v2_XML_Util::createTagFromArray() - to get local part and namespace of a qualified name

Parameters:

string	`$qname`	—	qualified tag name
string	`$defaultNs`	—	default namespace (optional)

[ Top ]

Class: PEAR_PackageFile_Generator_v2_XML_Util

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

apiVersion [line 955]

attributesToString [line 1108]

Parameters:

createCDataSection [line 1426]

Parameters:

createComment [line 1405]

Parameters:

createEndElement [line 1384]

Parameters:

createStartElement [line 1334]

Parameters:

createTag [line 1190]

Parameters:

createTagFromArray [line 1249]

Parameters:

getDocTypeDeclaration [line 1064]

Parameters:

getXMLDeclaration [line 1029]

Parameters:

isValidName [line 1495]

Parameters:

raiseError [line 1521]

Parameters:

replaceEntities [line 979]

Parameters:

splitQualifiedName [line 1454]

Parameters: