From 3fe6bcadf0093486b0eb484a9712fb273773b3f2 Mon Sep 17 00:00:00 2001
From: GreenCRM <info@greencrm.it>
Date: Thu, 9 Nov 2017 21:40:32 +0100
Subject: [PATCH] Fix HTMLSax3 php7
---
.../MailManager/third-party/XML/HTMLSax3.php | 64 +-
.../third-party/XML/HTMLSax3/Decorators.php | 26 +-
.../third-party/XML/HTMLSax3/States.php | 10 +-
.../MailManager/third-party/XML/Util.php | 927 ++++++++++++++++++
4 files changed, 987 insertions(+), 40 deletions(-)
create mode 100644 pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/Util.php
diff --git a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3.php b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3.php
index 7cdc4c6a..5314404f 100644
--- a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3.php
+++ b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3.php
@@ -21,6 +21,16 @@
//
// $Id: HTMLSax3.php,v 1.2 2007/10/29 21:41:34 hfuecks Exp $
//
+
+/**
+* 2017 02 01 - 1st February 2017
+* Author: Steven B Clarke
+* replace all occurances of function CLASSNAME(...)
+* with __construct(...)
+
+replace all occurances of "=& new CLASSNAME" with "= new CLASSNAME"
+*/
+
/**
* Main parser components
* @package XML_HTMLSax3
@@ -156,17 +166,17 @@ class XML_HTMLSax3_StateParser {
* @var XML_HTMLSax3 instance of user front end class
* @access protected
*/
- function XML_HTMLSax3_StateParser (& $htmlsax) {
- $this->htmlsax = & $htmlsax;
- $this->State[XML_HTMLSAX3_STATE_START] =& new XML_HTMLSax3_StartingState();
+ function __construct(& $htmlsax) {
+ $this->htmlsax =& $htmlsax;
+ $this->State[XML_HTMLSAX3_STATE_START] = new XML_HTMLSax3_StartingState();
- $this->State[XML_HTMLSAX3_STATE_CLOSING_TAG] =& new XML_HTMLSax3_ClosingTagState();
- $this->State[XML_HTMLSAX3_STATE_TAG] =& new XML_HTMLSax3_TagState();
- $this->State[XML_HTMLSAX3_STATE_OPENING_TAG] =& new XML_HTMLSax3_OpeningTagState();
+ $this->State[XML_HTMLSAX3_STATE_CLOSING_TAG] = new XML_HTMLSax3_ClosingTagState();
+ $this->State[XML_HTMLSAX3_STATE_TAG] = new XML_HTMLSax3_TagState();
+ $this->State[XML_HTMLSAX3_STATE_OPENING_TAG] = new XML_HTMLSax3_OpeningTagState();
- $this->State[XML_HTMLSAX3_STATE_PI] =& new XML_HTMLSax3_PiState();
- $this->State[XML_HTMLSAX3_STATE_JASP] =& new XML_HTMLSax3_JaspState();
- $this->State[XML_HTMLSAX3_STATE_ESCAPE] =& new XML_HTMLSax3_EscapeState();
+ $this->State[XML_HTMLSAX3_STATE_PI] = new XML_HTMLSax3_PiState();
+ $this->State[XML_HTMLSAX3_STATE_JASP] = new XML_HTMLSax3_JaspState();
+ $this->State[XML_HTMLSAX3_STATE_ESCAPE] = new XML_HTMLSax3_EscapeState();
}
/**
@@ -241,14 +251,14 @@ class XML_HTMLSax3_StateParser {
*/
function parse($data) {
if ($this->parser_options['XML_OPTION_TRIM_DATA_NODES']==1) {
- $decorator =& new XML_HTMLSax3_Trim(
+ $decorator = new XML_HTMLSax3_Trim(
$this->handler_object_data,
$this->handler_method_data);
$this->handler_object_data =& $decorator;
$this->handler_method_data = 'trimData';
}
if ($this->parser_options['XML_OPTION_CASE_FOLDING']==1) {
- $open_decor =& new XML_HTMLSax3_CaseFolding(
+ $open_decor = new XML_HTMLSax3_CaseFolding(
$this->handler_object_element,
$this->handler_method_opening,
$this->handler_method_closing);
@@ -257,28 +267,28 @@ class XML_HTMLSax3_StateParser {
$this->handler_method_closing ='foldClose';
}
if ($this->parser_options['XML_OPTION_LINEFEED_BREAK']==1) {
- $decorator =& new XML_HTMLSax3_Linefeed(
+ $decorator = new XML_HTMLSax3_Linefeed(
$this->handler_object_data,
$this->handler_method_data);
$this->handler_object_data =& $decorator;
$this->handler_method_data = 'breakData';
}
if ($this->parser_options['XML_OPTION_TAB_BREAK']==1) {
- $decorator =& new XML_HTMLSax3_Tab(
+ $decorator = new XML_HTMLSax3_Tab(
$this->handler_object_data,
$this->handler_method_data);
$this->handler_object_data =& $decorator;
$this->handler_method_data = 'breakData';
}
if ($this->parser_options['XML_OPTION_ENTITIES_UNPARSED']==1) {
- $decorator =& new XML_HTMLSax3_Entities_Unparsed(
+ $decorator = new XML_HTMLSax3_Entities_Unparsed(
$this->handler_object_data,
$this->handler_method_data);
$this->handler_object_data =& $decorator;
$this->handler_method_data = 'breakData';
}
if ($this->parser_options['XML_OPTION_ENTITIES_PARSED']==1) {
- $decorator =& new XML_HTMLSax3_Entities_Parsed(
+ $decorator = new XML_HTMLSax3_Entities_Parsed(
$this->handler_object_data,
$this->handler_method_data);
$this->handler_object_data =& $decorator;
@@ -286,7 +296,7 @@ class XML_HTMLSax3_StateParser {
}
// Note switched on by default
if ($this->parser_options['XML_OPTION_STRIP_ESCAPES']==1) {
- $decorator =& new XML_HTMLSax3_Escape_Stripper(
+ $decorator = new XML_HTMLSax3_Escape_Stripper(
$this->handler_object_escape,
$this->handler_method_escape);
$this->handler_object_escape =& $decorator;
@@ -327,8 +337,8 @@ class XML_HTMLSax3_StateParser_Lt430 extends XML_HTMLSax3_StateParser {
* @var XML_HTMLSax3 instance of user front end class
* @access protected
*/
- function XML_HTMLSax3_StateParser_Lt430(& $htmlsax) {
- parent::XML_HTMLSax3_StateParser($htmlsax);
+ function __construct(& $htmlsax) {
+ parent::__construct($htmlsax);
$this->parser_options['XML_OPTION_TRIM_DATA_NODES'] = 0;
$this->parser_options['XML_OPTION_CASE_FOLDING'] = 0;
$this->parser_options['XML_OPTION_LINEFEED_BREAK'] = 0;
@@ -359,7 +369,7 @@ class XML_HTMLSax3_StateParser_Lt430 extends XML_HTMLSax3_StateParser {
* @return void
*/
function ignoreWhitespace() {
- while ($this->position < $this->length &&
+ while ($this->position < $this->length &&
strpos(" \n\r\t", $this->rawtext{$this->position}) !== FALSE) {
$this->position++;
}
@@ -391,8 +401,8 @@ class XML_HTMLSax3_StateParser_Gtet430 extends XML_HTMLSax3_StateParser {
* @var XML_HTMLSax3 instance of user front end class
* @access protected
*/
- function XML_HTMLSax3_StateParser_Gtet430(& $htmlsax) {
- parent::XML_HTMLSax3_StateParser($htmlsax);
+ function __construct(& $htmlsax) {
+ parent::__construct($htmlsax);
$this->parser_options['XML_OPTION_TRIM_DATA_NODES'] = 0;
$this->parser_options['XML_OPTION_CASE_FOLDING'] = 0;
$this->parser_options['XML_OPTION_LINEFEED_BREAK'] = 0;
@@ -481,13 +491,13 @@ class XML_HTMLSax3 {
* </pre>
* @access public
*/
- function XML_HTMLSax3() {
+ function __construct() {
if (version_compare(phpversion(), '4.3', 'ge')) {
- $this->state_parser =& new XML_HTMLSax3_StateParser_Gtet430($this);
+ $this->state_parser = new XML_HTMLSax3_StateParser_Gtet430($this);
} else {
- $this->state_parser =& new XML_HTMLSax3_StateParser_Lt430($this);
+ $this->state_parser = new XML_HTMLSax3_StateParser_Lt430($this);
}
- $nullhandler =& new XML_HTMLSax3_NullHandler();
+ $nullhandler = new XML_HTMLSax3_NullHandler();
$this->set_object($nullhandler);
$this->set_element_handler('DoNothing', 'DoNothing');
$this->set_data_handler('DoNothing');
@@ -528,7 +538,7 @@ class XML_HTMLSax3 {
* <li>XML_OPTION_ENTITIES_UNPARSED: XML entities are returned as
* seperate data handler calls in unparsed form</li>
* <li>XML_OPTION_ENTITIES_PARSED: (PHP 4.3.0+ only) XML entities are
- * returned as seperate data handler calls and are parsed with
+ * returned as seperate data handler calls and are parsed with
* PHP's html_entity_decode() function</li>
* <li>XML_OPTION_STRIP_ESCAPES: strips out the -- -- comment markers
* or CDATA markup inside an XML escape, if found.</li>
@@ -684,4 +694,4 @@ class XML_HTMLSax3 {
$this->state_parser->parse($data);
}
}
-?>
\ No newline at end of file
+?>
diff --git a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/Decorators.php b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/Decorators.php
index 156d709b..8a79c7b1 100644
--- a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/Decorators.php
+++ b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/Decorators.php
@@ -21,6 +21,15 @@
//
// $Id: Decorators.php,v 1.2 2007/10/29 21:41:35 hfuecks Exp $
//
+
+/*
+ * 2017 02 01 - 1st February 2017
+ * Author: Steven B Clarke
+ * replace all occurances of function CLASSNAME(...)
+ * with __construct(...)
+*/
+
+
/**
* Decorators for dealing with parser options
* @package XML_HTMLSax3
@@ -45,13 +54,14 @@ class XML_HTMLSax3_Trim {
* @access private
*/
var $orig_method;
+
/**
* Constructs XML_HTMLSax3_Trim
* @param object handler object being decorated
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_Trim(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -99,7 +109,7 @@ class XML_HTMLSax3_CaseFolding {
* @param string original close handler method
* @access protected
*/
- function XML_HTMLSax3_CaseFolding(&$orig_obj, $orig_open_method, $orig_close_method) {
+ function __construct(&$orig_obj, $orig_open_method, $orig_close_method) {
$this->orig_obj =& $orig_obj;
$this->orig_open_method = $orig_open_method;
$this->orig_close_method = $orig_close_method;
@@ -149,7 +159,7 @@ class XML_HTMLSax3_Linefeed {
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_LineFeed(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -191,7 +201,7 @@ class XML_HTMLSax3_Tab {
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_Tab(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -234,7 +244,7 @@ class XML_HTMLSax3_Entities_Parsed {
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_Entities_Parsed(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -286,7 +296,7 @@ class XML_HTMLSax3_Entities_Unparsed {
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_Entities_Unparsed(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -329,7 +339,7 @@ class XML_HTMLSax3_Escape_Stripper {
* @param string original handler method
* @access protected
*/
- function XML_HTMLSax3_Escape_Stripper(&$orig_obj, $orig_method) {
+ function __construct(&$orig_obj, $orig_method) {
$this->orig_obj =& $orig_obj;
$this->orig_method = $orig_method;
}
@@ -360,4 +370,4 @@ class XML_HTMLSax3_Escape_Stripper {
$this->orig_obj->{$this->orig_method}($this, $data);
}
}
-?>
\ No newline at end of file
+?>
diff --git a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/States.php b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/States.php
index b92b7b27..c9ef28e9 100644
--- a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/States.php
+++ b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/HTMLSax3/States.php
@@ -132,7 +132,7 @@ class XML_HTMLSax3_OpeningTagState {
*/
function parseAttributes(&$context) {
$Attributes = array();
-
+
$context->ignoreWhitespace();
$attributename = $context->scanUntilCharacters("=/> \n\r\t");
while ($attributename != '') {
@@ -158,7 +158,7 @@ class XML_HTMLSax3_OpeningTagState {
$context->unscanCharacter();
}
$Attributes[$attributename] = $attributevalue;
-
+
$context->ignoreWhitespace();
$attributename = $context->scanUntilCharacters("=/> \n\r\t");
}
@@ -182,14 +182,14 @@ class XML_HTMLSax3_OpeningTagState {
$context->unscanCharacter();
}
$context->handler_object_element->
- {$context->handler_method_opening}($context->htmlsax, $tag,
+ {$context->handler_method_opening}($context->htmlsax, $tag,
$Attributes, TRUE);
$context->handler_object_element->
- {$context->handler_method_closing}($context->htmlsax, $tag,
+ {$context->handler_method_closing}($context->htmlsax, $tag,
TRUE);
} else {
$context->handler_object_element->
- {$context->handler_method_opening}($context->htmlsax, $tag,
+ {$context->handler_method_opening}($context->htmlsax, $tag,
$Attributes, FALSE);
}
}
diff --git a/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/Util.php b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/Util.php
new file mode 100644
index 00000000..69caf24c
--- /dev/null
+++ b/pkg/vtiger/modules/MailManager/modules/MailManager/third-party/XML/Util.php
@@ -0,0 +1,927 @@
+<?php
+/**
+ * XML_Util
+ *
+ * XML Utilities package
+ *
+ * PHP versions 4 and 5
+ *
+ *********************************
+ * 2017 02 01 - 1st February 2017
+ * author: Steven B Clarke
+ * check for compatibility with
+ * PHP version 7.0.6
+ *********************************
+ * LICENSE:
+ *
+ * Copyright (c) 2003-2008 Stephan Schmidt <schst@php.net>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * The name of the author may not be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @category XML
+ * @package XML_Util
+ * @author Stephan Schmidt <schst@php.net>
+ * @copyright 2003-2008 Stephan Schmidt <schst@php.net>
+ * @license http://opensource.org/licenses/bsd-license New BSD License
+ * @version CVS: $Id$
+ * @link http://pear.php.net/package/XML_Util
+ */
+
+/**
+ * Error code for invalid chars in XML name
+ */
+define('XML_UTIL_ERROR_INVALID_CHARS', 51);
+
+/**
+ * Error code for invalid chars in XML name
+ */
+define('XML_UTIL_ERROR_INVALID_START', 52);
+
+/**
+ * Error code for non-scalar tag content
+ */
+define('XML_UTIL_ERROR_NON_SCALAR_CONTENT', 60);
+
+/**
+ * Error code for missing tag name
+ */
+define('XML_UTIL_ERROR_NO_TAG_NAME', 61);
+
+/**
+ * Replace XML entities
+ */
+define('XML_UTIL_REPLACE_ENTITIES', 1);
+
+/**
+ * Embedd content in a CData Section
+ */
+define('XML_UTIL_CDATA_SECTION', 5);
+
+/**
+ * Do not replace entitites
+ */
+define('XML_UTIL_ENTITIES_NONE', 0);
+
+/**
+ * Replace all XML entitites
+ * This setting will replace <, >, ", ' and &
+ */
+define('XML_UTIL_ENTITIES_XML', 1);
+
+/**
+ * Replace only required XML entitites
+ * This setting will replace <, " and &
+ */
+define('XML_UTIL_ENTITIES_XML_REQUIRED', 2);
+
+/**
+ * Replace HTML entitites
+ * @link http://www.php.net/htmlentities
+ */
+define('XML_UTIL_ENTITIES_HTML', 3);
+
+/**
+ * Collapse all empty tags.
+ */
+define('XML_UTIL_COLLAPSE_ALL', 1);
+
+/**
+ * Collapse only empty XHTML tags that have no end tag.
+ */
+define('XML_UTIL_COLLAPSE_XHTML_ONLY', 2);
+
+/**
+ * Utility class for working with XML documents
+ *
+ * @category XML
+ * @package XML_Util
+ * @author Stephan Schmidt <schst@php.net>
+ * @copyright 2003-2008 Stephan Schmidt <schst@php.net>
+ * @license http://opensource.org/licenses/bsd-license New BSD License
+ * @version Release: 1.3.0
+ * @link http://pear.php.net/package/XML_Util
+ */
+class XML_Util
+{
+ /**
+ * Return API version
+ *
+ * @return string $version API version
+ */
+ public static function apiVersion()
+ {
+ return '1.1';
+ }
+
+ /**
+ * Replace XML entities
+ *
+ * With the optional second parameter, you may select, which
+ * entities should be replaced.
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // replace XML entites:
+ * $string = XML_Util::replaceEntities('This string contains < & >.');
+ * </code>
+ *
+ * With the optional third parameter, you may pass the character encoding
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // replace XML entites in UTF-8:
+ * $string = XML_Util::replaceEntities(
+ * 'This string contains < & > as well as ä, ö, ß, à and ê',
+ * XML_UTIL_ENTITIES_HTML,
+ * 'UTF-8'
+ * );
+ * </code>
+ *
+ * @param string $string string where XML special chars
+ * should be replaced
+ * @param int $replaceEntities setting for entities in attribute values
+ * (one of XML_UTIL_ENTITIES_XML,
+ * XML_UTIL_ENTITIES_XML_REQUIRED,
+ * XML_UTIL_ENTITIES_HTML)
+ * @param string $encoding encoding value (if any)...
+ * must be a valid encoding as determined
+ * by the htmlentities() function
+ *
+ * @return string string with replaced chars
+ * @see reverseEntities()
+ */
+ public static function replaceEntities(
+ $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1'
+ ) {
+ switch ($replaceEntities) {
+ case XML_UTIL_ENTITIES_XML:
+ return strtr(
+ $string,
+ array(
+ '&' => '&',
+ '>' => '>',
+ '<' => '<',
+ '"' => '"',
+ '\'' => '''
+ )
+ );
+ break;
+ case XML_UTIL_ENTITIES_XML_REQUIRED:
+ return strtr(
+ $string,
+ array(
+ '&' => '&',
+ '<' => '<',
+ '"' => '"'
+ )
+ );
+ break;
+ case XML_UTIL_ENTITIES_HTML:
+ return htmlentities($string, ENT_COMPAT, $encoding);
+ break;
+ }
+ return $string;
+ }
+
+ /**
+ * Reverse XML entities
+ *
+ * With the optional second parameter, you may select, which
+ * entities should be reversed.
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // reverse XML entites:
+ * $string = XML_Util::reverseEntities('This string contains < & >.');
+ * </code>
+ *
+ * With the optional third parameter, you may pass the character encoding
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // reverse XML entites in UTF-8:
+ * $string = XML_Util::reverseEntities(
+ * 'This string contains < & > as well as'
+ * . ' ä, ö, ß, à and ê',
+ * XML_UTIL_ENTITIES_HTML,
+ * 'UTF-8'
+ * );
+ * </code>
+ *
+ * @param string $string string where XML special chars
+ * should be replaced
+ * @param int $replaceEntities setting for entities in attribute values
+ * (one of XML_UTIL_ENTITIES_XML,
+ * XML_UTIL_ENTITIES_XML_REQUIRED,
+ * XML_UTIL_ENTITIES_HTML)
+ * @param string $encoding encoding value (if any)...
+ * must be a valid encoding as determined
+ * by the html_entity_decode() function
+ *
+ * @return string string with replaced chars
+ * @see replaceEntities()
+ */
+ public static function reverseEntities(
+ $string, $replaceEntities = XML_UTIL_ENTITIES_XML, $encoding = 'ISO-8859-1'
+ ) {
+ switch ($replaceEntities) {
+ case XML_UTIL_ENTITIES_XML:
+ return strtr(
+ $string,
+ array(
+ '&' => '&',
+ '>' => '>',
+ '<' => '<',
+ '"' => '"',
+ ''' => '\''
+ )
+ );
+ break;
+ case XML_UTIL_ENTITIES_XML_REQUIRED:
+ return strtr(
+ $string,
+ array(
+ '&' => '&',
+ '<' => '<',
+ '"' => '"'
+ )
+ );
+ break;
+ case XML_UTIL_ENTITIES_HTML:
+ return html_entity_decode($string, ENT_COMPAT, $encoding);
+ break;
+ }
+ return $string;
+ }
+
+ /**
+ * Build an xml declaration
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // get an XML declaration:
+ * $xmlDecl = XML_Util::getXMLDeclaration('1.0', 'UTF-8', true);
+ * </code>
+ *
+ * @param string $version xml version
+ * @param string $encoding character encoding
+ * @param bool $standalone document is standalone (or not)
+ *
+ * @return string xml declaration
+ * @uses attributesToString() to serialize the attributes of the
+ * XML declaration
+ */
+ public static function getXMLDeclaration(
+ $version = '1.0', $encoding = null, $standalone = null
+ ) {
+ $attributes = array(
+ 'version' => $version,
+ );
+ // add encoding
+ if ($encoding !== null) {
+ $attributes['encoding'] = $encoding;
+ }
+ // add standalone, if specified
+ if ($standalone !== null) {
+ $attributes['standalone'] = $standalone ? 'yes' : 'no';
+ }
+
+ return sprintf(
+ '<?xml%s?>',
+ XML_Util::attributesToString($attributes, false)
+ );
+ }
+
+ /**
+ * Build a document type declaration
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // get a doctype declaration:
+ * $xmlDecl = XML_Util::getDocTypeDeclaration('rootTag','myDocType.dtd');
+ * </code>
+ *
+ * @param string $root name of the root tag
+ * @param string $uri uri of the doctype definition
+ * (or array with uri and public id)
+ * @param string $internalDtd internal dtd entries
+ *
+ * @return string doctype declaration
+ * @since 0.2
+ */
+ public static function getDocTypeDeclaration(
+ $root, $uri = null, $internalDtd = null
+ ) {
+ if (is_array($uri)) {
+ $ref = sprintf(' PUBLIC "%s" "%s"', $uri['id'], $uri['uri']);
+ } elseif (!empty($uri)) {
+ $ref = sprintf(' SYSTEM "%s"', $uri);
+ } else {
+ $ref = '';
+ }
+
+ if (empty($internalDtd)) {
+ return sprintf('<!DOCTYPE %s%s>', $root, $ref);
+ } else {
+ return sprintf("<!DOCTYPE %s%s [\n%s\n]>", $root, $ref, $internalDtd);
+ }
+ }
+
+ /**
+ * Create string representation of an attribute list
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // build an attribute string
+ * $att = array(
+ * 'foo' => 'bar',
+ * 'argh' => 'tomato'
+ * );
+ *
+ * $attList = XML_Util::attributesToString($att);
+ * </code>
+ *
+ * @param array $attributes attribute array
+ * @param bool|array $sort sort attribute list alphabetically,
+ * may also be an assoc array containing
+ * the keys 'sort', 'multiline', 'indent',
+ * 'linebreak' and 'entities'
+ * @param bool $multiline use linebreaks, if more than
+ * one attribute is given
+ * @param string $indent string used for indentation of
+ * multiline attributes
+ * @param string $linebreak string used for linebreaks of
+ * multiline attributes
+ * @param int $entities setting for entities in attribute values
+ * (one of XML_UTIL_ENTITIES_NONE,
+ * XML_UTIL_ENTITIES_XML,
+ * XML_UTIL_ENTITIES_XML_REQUIRED,
+ * XML_UTIL_ENTITIES_HTML)
+ *
+ * @return string string representation of the attributes
+ * @uses replaceEntities() to replace XML entities in attribute values
+ * @todo allow sort also to be an options array
+ */
+ public static function attributesToString(
+ $attributes, $sort = true, $multiline = false,
+ $indent = ' ', $linebreak = "\n", $entities = XML_UTIL_ENTITIES_XML
+ ) {
+ /*
+ * second parameter may be an array
+ */
+ if (is_array($sort)) {
+ if (isset($sort['multiline'])) {
+ $multiline = $sort['multiline'];
+ }
+ if (isset($sort['indent'])) {
+ $indent = $sort['indent'];
+ }
+ if (isset($sort['linebreak'])) {
+ $multiline = $sort['linebreak'];
+ }
+ if (isset($sort['entities'])) {
+ $entities = $sort['entities'];
+ }
+ if (isset($sort['sort'])) {
+ $sort = $sort['sort'];
+ } else {
+ $sort = true;
+ }
+ }
+ $string = '';
+ if (is_array($attributes) && !empty($attributes)) {
+ if ($sort) {
+ ksort($attributes);
+ }
+ if (!$multiline || count($attributes) == 1) {
+ foreach ($attributes as $key => $value) {
+ if ($entities != XML_UTIL_ENTITIES_NONE) {
+ if ($entities === XML_UTIL_CDATA_SECTION) {
+ $entities = XML_UTIL_ENTITIES_XML;
+ }
+ $value = XML_Util::replaceEntities($value, $entities);
+ }
+ $string .= ' ' . $key . '="' . $value . '"';
+ }
+ } else {
+ $first = true;
+ foreach ($attributes as $key => $value) {
+ if ($entities != XML_UTIL_ENTITIES_NONE) {
+ $value = XML_Util::replaceEntities($value, $entities);
+ }
+ if ($first) {
+ $string .= ' ' . $key . '="' . $value . '"';
+ $first = false;
+ } else {
+ $string .= $linebreak . $indent . $key . '="' . $value . '"';
+ }
+ }
+ }
+ }
+ return $string;
+ }
+
+ /**
+ * Collapses empty tags.
+ *
+ * @param string $xml XML
+ * @param int $mode Whether to collapse all empty tags (XML_UTIL_COLLAPSE_ALL)
+ * or only XHTML (XML_UTIL_COLLAPSE_XHTML_ONLY) ones.
+ *
+ * @return string XML
+ */
+ public static function collapseEmptyTags($xml, $mode = XML_UTIL_COLLAPSE_ALL)
+ {
+ if ($mode == XML_UTIL_COLLAPSE_XHTML_ONLY) {
+ return preg_replace(
+ '/<(area|base(?:font)?|br|col|frame|hr|img|input|isindex|link|meta|'
+ . 'param)([^>]*)><\/\\1>/s',
+ '<\\1\\2 />',
+ $xml
+ );
+ } else {
+ return preg_replace('/<(\w+)([^>]*)><\/\\1>/s', '<\\1\\2 />', $xml);
+ }
+ }
+
+ /**
+ * Create a tag
+ *
+ * This method will call XML_Util::createTagFromArray(), which
+ * is more flexible.
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // create an XML tag:
+ * $tag = XML_Util::createTag('myNs:myTag',
+ * array('foo' => 'bar'),
+ * 'This is inside the tag',
+ * 'http://www.w3c.org/myNs#');
+ * </code>
+ *
+ * @param string $qname qualified tagname (including namespace)
+ * @param array $attributes array containg attributes
+ * @param mixed $content the content
+ * @param string $namespaceUri URI of the namespace
+ * @param int $replaceEntities whether to replace XML special chars in
+ * content, embedd it in a CData section
+ * or none of both
+ * @param bool $multiline whether to create a multiline tag where
+ * each attribute gets written to a single line
+ * @param string $indent string used to indent attributes
+ * (_auto indents attributes so they start
+ * at the same column)
+ * @param string $linebreak string used for linebreaks
+ * @param bool $sortAttributes Whether to sort the attributes or not
+ *
+ * @return string XML tag
+ * @see createTagFromArray()
+ * @uses createTagFromArray() to create the tag
+ */
+ public static function createTag(
+ $qname, $attributes = array(), $content = null,
+ $namespaceUri = null, $replaceEntities = XML_UTIL_REPLACE_ENTITIES,
+ $multiline = false, $indent = '_auto', $linebreak = "\n",
+ $sortAttributes = true
+ ) {
+ $tag = array(
+ 'qname' => $qname,
+ 'attributes' => $attributes
+ );
+
+ // add tag content
+ if ($content !== null) {
+ $tag['content'] = $content;
+ }
+
+ // add namespace Uri
+ if ($namespaceUri !== null) {
+ $tag['namespaceUri'] = $namespaceUri;
+ }
+
+ return XML_Util::createTagFromArray(
+ $tag, $replaceEntities, $multiline,
+ $indent, $linebreak, $sortAttributes
+ );
+ }
+
+ /**
+ * Create a tag from an array.
+ * This method awaits an array in the following format
+ * <pre>
+ * array(
+ * // qualified name of the tag
+ * 'qname' => $qname
+ *
+ * // namespace prefix (optional, if qname is specified or no namespace)
+ * 'namespace' => $namespace
+ *
+ * // local part of the tagname (optional, if qname is specified)
+ * 'localpart' => $localpart,
+ *
+ * // array containing all attributes (optional)
+ * 'attributes' => array(),
+ *
+ * // tag content (optional)
+ * 'content' => $content,
+ *
+ * // namespaceUri for the given namespace (optional)
+ * 'namespaceUri' => $namespaceUri
+ * )
+ * </pre>
+ *
+ * <code>
+ * 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 = XML_Util::createTagFromArray($tag);
+ * </code>
+ *
+ * @param array $tag tag definition
+ * @param int $replaceEntities whether to replace XML special chars in
+ * content, embedd it in a CData section
+ * or none of both
+ * @param bool $multiline whether to create a multiline tag where each
+ * attribute gets written to a single line
+ * @param string $indent string used to indent attributes
+ * (_auto indents attributes so they start
+ * at the same column)
+ * @param string $linebreak string used for linebreaks
+ * @param bool $sortAttributes Whether to sort the attributes or not
+ *
+ * @return string XML tag
+ *
+ * @see createTag()
+ * @uses attributesToString() to serialize the attributes of the tag
+ * @uses splitQualifiedName() to get local part and namespace of a qualified name
+ * @uses createCDataSection()
+ * @uses raiseError()
+ */
+ public static function createTagFromArray(
+ $tag, $replaceEntities = XML_UTIL_REPLACE_ENTITIES,
+ $multiline = false, $indent = '_auto', $linebreak = "\n",
+ $sortAttributes = true
+ ) {
+ if (isset($tag['content']) && !is_scalar($tag['content'])) {
+ return XML_Util::raiseError(
+ 'Supplied non-scalar value as tag content',
+ XML_UTIL_ERROR_NON_SCALAR_CONTENT
+ );
+ }
+
+ if (!isset($tag['qname']) && !isset($tag['localPart'])) {
+ return XML_Util::raiseError(
+ 'You must either supply a qualified name '
+ . '(qname) or local tag name (localPart).',
+ XML_UTIL_ERROR_NO_TAG_NAME
+ );
+ }
+
+ // if no attributes hav been set, use empty attributes
+ if (!isset($tag['attributes']) || !is_array($tag['attributes'])) {
+ $tag['attributes'] = array();
+ }
+
+ if (isset($tag['namespaces'])) {
+ foreach ($tag['namespaces'] as $ns => $uri) {
+ $tag['attributes']['xmlns:' . $ns] = $uri;
+ }
+ }
+
+ if (!isset($tag['qname'])) {
+ // qualified name is not given
+
+ // check for namespace
+ if (isset($tag['namespace']) && !empty($tag['namespace'])) {
+ $tag['qname'] = $tag['namespace'] . ':' . $tag['localPart'];
+ } else {
+ $tag['qname'] = $tag['localPart'];
+ }
+ } elseif (isset($tag['namespaceUri']) && !isset($tag['namespace'])) {
+ // namespace URI is set, but no namespace
+
+ $parts = XML_Util::splitQualifiedName($tag['qname']);
+
+ $tag['localPart'] = $parts['localPart'];
+ if (isset($parts['namespace'])) {
+ $tag['namespace'] = $parts['namespace'];
+ }
+ }
+
+ if (isset($tag['namespaceUri']) && !empty($tag['namespaceUri'])) {
+ // is a namespace given
+ if (isset($tag['namespace']) && !empty($tag['namespace'])) {
+ $tag['attributes']['xmlns:' . $tag['namespace']]
+ = $tag['namespaceUri'];
+ } else {
+ // define this Uri as the default namespace
+ $tag['attributes']['xmlns'] = $tag['namespaceUri'];
+ }
+ }
+
+ // check for multiline attributes
+ if ($multiline === true) {
+ if ($indent === '_auto') {
+ $indent = str_repeat(' ', (strlen($tag['qname'])+2));
+ }
+ }
+
+ // create attribute list
+ $attList = XML_Util::attributesToString(
+ $tag['attributes'],
+ $sortAttributes, $multiline, $indent, $linebreak
+ );
+ if (!isset($tag['content']) || (string)$tag['content'] == '') {
+ $tag = sprintf('<%s%s />', $tag['qname'], $attList);
+ } else {
+ switch ($replaceEntities) {
+ case XML_UTIL_ENTITIES_NONE:
+ break;
+ case XML_UTIL_CDATA_SECTION:
+ $tag['content'] = XML_Util::createCDataSection($tag['content']);
+ break;
+ default:
+ $tag['content'] = XML_Util::replaceEntities(
+ $tag['content'], $replaceEntities
+ );
+ break;
+ }
+ $tag = sprintf(
+ '<%s%s>%s</%s>', $tag['qname'], $attList, $tag['content'],
+ $tag['qname']
+ );
+ }
+ return $tag;
+ }
+
+ /**
+ * Create a start element
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // create an XML start element:
+ * $tag = XML_Util::createStartElement('myNs:myTag',
+ * array('foo' => 'bar') ,'http://www.w3c.org/myNs#');
+ * </code>
+ *
+ * @param string $qname qualified tagname (including namespace)
+ * @param array $attributes array containg attributes
+ * @param string $namespaceUri URI of the namespace
+ * @param bool $multiline whether to create a multiline tag where each
+ * attribute gets written to a single line
+ * @param string $indent string used to indent attributes (_auto indents
+ * attributes so they start at the same column)
+ * @param string $linebreak string used for linebreaks
+ * @param bool $sortAttributes Whether to sort the attributes or not
+ *
+ * @return string XML start element
+ * @see createEndElement(), createTag()
+ */
+ public static function createStartElement(
+ $qname, $attributes = array(), $namespaceUri = null,
+ $multiline = false, $indent = '_auto', $linebreak = "\n",
+ $sortAttributes = true
+ ) {
+ // if no attributes hav been set, use empty attributes
+ if (!isset($attributes) || !is_array($attributes)) {
+ $attributes = array();
+ }
+
+ if ($namespaceUri != null) {
+ $parts = XML_Util::splitQualifiedName($qname);
+ }
+
+ // check for multiline attributes
+ if ($multiline === true) {
+ if ($indent === '_auto') {
+ $indent = str_repeat(' ', (strlen($qname)+2));
+ }
+ }
+
+ if ($namespaceUri != null) {
+ // is a namespace given
+ if (isset($parts['namespace']) && !empty($parts['namespace'])) {
+ $attributes['xmlns:' . $parts['namespace']] = $namespaceUri;
+ } else {
+ // define this Uri as the default namespace
+ $attributes['xmlns'] = $namespaceUri;
+ }
+ }
+
+ // create attribute list
+ $attList = XML_Util::attributesToString(
+ $attributes, $sortAttributes,
+ $multiline, $indent, $linebreak
+ );
+ $element = sprintf('<%s%s>', $qname, $attList);
+ return $element;
+ }
+
+ /**
+ * Create an end element
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // create an XML start element:
+ * $tag = XML_Util::createEndElement('myNs:myTag');
+ * </code>
+ *
+ * @param string $qname qualified tagname (including namespace)
+ *
+ * @return string XML end element
+ * @see createStartElement(), createTag()
+ */
+ public static function createEndElement($qname)
+ {
+ $element = sprintf('</%s>', $qname);
+ return $element;
+ }
+
+ /**
+ * Create an XML comment
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // create an XML start element:
+ * $tag = XML_Util::createComment('I am a comment');
+ * </code>
+ *
+ * @param string $content content of the comment
+ *
+ * @return string XML comment
+ */
+ public static function createComment($content)
+ {
+ $comment = sprintf('<!-- %s -->', $content);
+ return $comment;
+ }
+
+ /**
+ * Create a CData section
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // create a CData section
+ * $tag = XML_Util::createCDataSection('I am content.');
+ * </code>
+ *
+ * @param string $data data of the CData section
+ *
+ * @return string CData section with content
+ */
+ public static function createCDataSection($data)
+ {
+ return sprintf(
+ '<![CDATA[%s]]>',
+ preg_replace('/\]\]>/', ']]]]><![CDATA[>', strval($data))
+ );
+ }
+
+ /**
+ * Split qualified name and return namespace and local part
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // split qualified tag
+ * $parts = XML_Util::splitQualifiedName('xslt:stylesheet');
+ * </code>
+ * the returned array will contain two elements:
+ * <pre>
+ * array(
+ * 'namespace' => 'xslt',
+ * 'localPart' => 'stylesheet'
+ * );
+ * </pre>
+ *
+ * @param string $qname qualified tag name
+ * @param string $defaultNs default namespace (optional)
+ *
+ * @return array array containing namespace and local part
+ */
+ public static function splitQualifiedName($qname, $defaultNs = null)
+ {
+ if (strstr($qname, ':')) {
+ $tmp = explode(':', $qname);
+ return array(
+ 'namespace' => $tmp[0],
+ 'localPart' => $tmp[1]
+ );
+ }
+ return array(
+ 'namespace' => $defaultNs,
+ 'localPart' => $qname
+ );
+ }
+
+ /**
+ * Check, whether string is valid XML name
+ *
+ * <p>XML names are used for tagname, attribute names and various
+ * other, lesser known entities.</p>
+ * <p>An XML name may only consist of alphanumeric characters,
+ * dashes, undescores and periods, and has to start with a letter
+ * or an underscore.</p>
+ *
+ * <code>
+ * require_once 'XML/Util.php';
+ *
+ * // verify tag name
+ * $result = XML_Util::isValidName('invalidTag?');
+ * if (is_a($result, 'PEAR_Error')) {
+ * print 'Invalid XML name: ' . $result->getMessage();
+ * }
+ * </code>
+ *
+ * @param string $string string that should be checked
+ *
+ * @return mixed true, if string is a valid XML name, PEAR error otherwise
+ *
+ * @todo support for other charsets
+ * @todo PEAR CS - unable to avoid 85-char limit on second preg_match
+ */
+ public static function isValidName($string)
+ {
+ // check for invalid chars
+ if (!preg_match('/^[[:alpha:]_]\\z/', $string{0})) {
+ return XML_Util::raiseError(
+ 'XML names may only start with letter or underscore',
+ XML_UTIL_ERROR_INVALID_START
+ );
+ }
+
+ // check for invalid chars
+ $match = preg_match(
+ '/^([[:alpha:]_]([[:alnum:]\-\.]*)?:)?'
+ . '[[:alpha:]_]([[:alnum:]\_\-\.]+)?\\z/',
+ $string
+ );
+ if (!$match) {
+ return XML_Util::raiseError(
+ 'XML names may only contain alphanumeric '
+ . 'chars, period, hyphen, colon and underscores',
+ XML_UTIL_ERROR_INVALID_CHARS
+ );
+ }
+ // XML name is valid
+ return true;
+ }
+
+ /**
+ * Replacement for XML_Util::raiseError
+ *
+ * Avoids the necessity to always require
+ * PEAR.php
+ *
+ * @param string $msg error message
+ * @param int $code error code
+ *
+ * @return PEAR_Error
+ * @todo PEAR CS - should this use include_once instead?
+ */
+ public static function raiseError($msg, $code)
+ {
+ include_once 'PEAR.php';
+ return PEAR::raiseError($msg, $code);
+ }
+}
+?>
--
GitLab