user_guide_src/source/helpers/xml_helper.rst
########## XML Helper ##########
The XML Helper file contains functions that assist in working with XML data.
.. contents:: :local: :depth: 2
This helper is loaded using the following code
.. literalinclude:: xml_helper/001.php
The following functions are available:
.. php:function:: xml_convert($str[, $protect_all = false])
:param string $str: the text string to convert
:param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g., &foo;
:returns: XML-converted string
:rtype: string
Takes a string as input and converts the following reserved XML
characters to entities:
- Ampersands: &
- Less than and greater than characters: < >
- Single and double quotes: ' "
- Dashes: -
This function ignores ampersands if they are part of existing numbered
character entities, e.g., {. Example:
.. literalinclude:: xml_helper/002.php
outputs:
.. code-block:: html
<p>Here is a paragraph & an entity ({).</p>