Back to Codeigniter

XML Helper

user_guide_src/source/helpers/xml_helper.rst

3.1.131.2 KB
Original Source

########## XML Helper ##########

The XML Helper file contains functions that assist in working with XML data.

.. contents:: :local:

.. raw:: html

<div class="custom-index container"></div>

Loading this Helper

This helper is loaded using the following code

::

$this->load->helper('xml');

Available Functions

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. &#123;. Example::

	$string = '<p>Here is a paragraph & an entity (&#123;).</p>';
	$string = xml_convert($string);
	echo $string;

outputs:

.. code-block:: html

	&lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;