diff options
Diffstat (limited to 'user_guide_src/source/helpers/xml_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/xml_helper.rst | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst deleted file mode 100644 index 903e925c2..000000000 --- a/user_guide_src/source/helpers/xml_helper.rst +++ /dev/null @@ -1,55 +0,0 @@ -########## -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. {. Example:: - - $string = '<p>Here is a paragraph & an entity ({).</p>'; - $string = xml_convert($string); - echo $string; - - outputs: - - .. code-block:: html - - <p>Here is a paragraph & an entity ({).</p>
\ No newline at end of file |