Docs For Class PEAR_PackageFile_Generator_v2_XML

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: XML_Util::attributesToString() - to serialize the attributes of the tag
Uses: 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 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

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 ]

Class: PEAR_PackageFile_Generator_v2_XML_Util

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

createTag [line 1055]

Parameters:

createTagFromArray [line 1118]

Parameters:

replaceEntities [line 1003]

Parameters: