Documentation/utilities/xml.html

   1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   2 <head>
   3         <title>CarbonPHP Documentation</title>
   4         <style type="text/css">
   5                 * {
   6                         margin: 0;
   7                         padding: 0;
   8                 }
   9
  10                 a, a:hover {
  11                         background: transparent;
  12                         border-bottom: 1px dotted #666;
  13                         color: #666;
  14                         text-decoration: none;
  15                 }
  16
  17                 a:hover {
  18                         border: 0;
  19                 }
  20
  21                 html {
  22                         font-family: "Lucida Sans Unicode", "Lucida Grande";
  23                         font-size: 12px;
  24                 }
  25
  26                 body {
  27                         background: #fff;
  28                         color: #666;
  29                 }
  30
  31                 h1 {
  32                         font-size: 15px;
  33                         font-weight: bold;
  34                         margin: 0 0 5px 0;
  35                 }
  36
  37                 h2 {
  38                         font-size: 13px;
  39                         font-weight: bold;
  40                         margin: 5px 0 5px 0;
  41                 }
  42
  43                 ol, ul {
  44                         margin: 10px 0 10px 0;
  45                         list-style-position: inside;
  46                 }
  47
  48                 p {
  49                         margin: 5px 0 5px 0;
  50                 }
  51
  52                 .content {
  53                         border: 1px dotted #444;
  54                         margin: 10px;
  55                         padding: 10px;
  56                         text-align: justify;
  57                         width: 700px;
  58                 }
  59
  60                 .example {
  61                         border: 1px solid #ccc;
  62                         background: #eee;
  63                         margin: 10px;
  64                         padding: 10px;
  65                         text-align: left;
  66                 }
  67         </style>
  68 </head>
  69
  70 <body>
  71         <div class="content">
  72                 <h1>XML Utility</h1>
  73
  74                 <p>The XML utlity contains functions that help when working with XML data.  You load this utility using the
  75                 following piece of code.</p>
  76
  77                 <div class="example">
  78                         $this->load->utility('xml');
  79                 </div>
  80         </div>
  81
  82         <div class="content">
  83                 <h1>xml_convert('string')</h1>
  84
  85                 <p>This function takes a string as input and converts the following XML characters to entities.</p>
  86
  87                 <ul>
  88                         <li>Ampersands: &amp;</li>
  89                         <li>Less than and greater than: &lt; &gt;</li>
  90                         <li>Single and double quotes: ' "</li>
  91                         <li>Dashes: -</li>
  92                 </ul>
  93
  94                 <p>This function ignores ampersands if they are part of existing character entities.</p>
  95
  96                 <div class="examples">
  97                         $string = xml_convert($string);
  98                 </div>
  99         </div>
 100 </body>
 101
 102 </html>