<html>
<head>
<title>Library methods</title>
<meta name="keywords" content="">
</head>

<body bgcolor=#113377 text=#000000 vlink=#551a8b alink=#00c0ff link=#0000ee>




















































<table width=100% border=0>
<tr>
  <td valign=top>
  <table width=100% cellpadding=5 cellspacing=0 border=0>
    <tr><td bgcolor="#ffffff" align=center>
       <img border=0 alt="" height=40 src="../../img/logga.gif" width=102>
    </td></tr>
    <tr><td valign=top>
      <img src=internal-roxen-unit width=1 height=3 alt="">
    </td></tr>
    <tr valign=top>
      <td bgcolor="#ffffff">




        <table cellpadding=0 cellspacing=0 border=0>
          
       <!--a1  Introduction manual.tmpl-->
    
            <tr><td><a href="../introduction/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../introduction/index.html">Introduction</a></td>
	    </tr>
    
          
       <!--a1  CGI and SSI manual.tmpl-->
    
            <tr><td><a href="../cgi/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../cgi/index.html">CGI and SSI</a></td>
	    </tr>
    
          
       <!--a1  &lt;pike&gt; tag manual.tmpl-->
    
            <tr><td><a href="../pike-tag/index.html"><img src="../../img/chapter.gif" border=0></a>&nbsp;</td>
	      <td><a href="../pike-tag/index.html">&lt;pike&gt; tag</a></td>
	    </tr>
    
          
       <!--a1  Pike script manual.tmpl-->
    
            <tr><td><a href="../pike-scripts/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../pike-scripts/index.html">Pike script</a></td>
	    </tr>
    
          
       <!--a1  Modules manual.tmpl-->
    
            <tr><td><a href="../modules/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../modules/index.html">Modules</a></td>
	    </tr>
    
          
       <!--a1  Parser modules manual.tmpl-->
    
            <tr><td><a href="../tag-modules/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../tag-modules/index.html">Parser modules</a></td>
	    </tr>
    
          
       <!--a1  Location modules manual.tmpl-->
    
            <tr><td><a href="../location-modules/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../location-modules/index.html">Location modules</a></td>
	    </tr>
    
          
       <!--a1  Other module types manual.tmpl-->
    
            <tr><td><a href="../other-modules/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../other-modules/index.html">Other module types</a></td>
	    </tr>
    
          
       <!--a1  Request information object manual.tmpl-->
    
            <tr><td><a href="../id/index.html"><img src="../../img/chapter.gif" border=0></a>&nbsp;</td>
	      <td><a href="../id/index.html">Request information object</a></td>
	    </tr>
    
          
       <!--a1  Responses manual.tmpl-->
    
            <tr><td><a href="../responses/index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="../responses/index.html">Responses</a></td>
	    </tr>
    
          
       <!--a1  Library methods manual.tmpl-->
    
            <tr><td><a href="index.html"><img border=0 src="../../img/chapter.gif"></a>&nbsp;</td>
	      <td><a href="index.html"><b>Library methods</b></a></td>
	    </tr>
    
          
	</table>
	
        <table cellpadding=0 cellspacing=0 border=0>
	  
        </table>

        <table cellpadding=0 cellspacing=0 border=0>
          
	</table>

      </td>
    </tr>
    <tr><td height=100%>&nbsp;</td></tr>
  </table>
  </td>
  <td>
    <img src=internal-roxen-unit width=3 height=1 alt="">
  </td>

  <td valign=top>
    <table cellspacing=0 cellpadding=5 width=100% height=100% border=0>
    <tr>
      <td bgcolor="#ffffff">
       <b><font size=+2>Library methods</font></b>

	<p>This chapter gives an overview of the various methods available to a
module that has inherited <i>roxenlib</i>.

<dl>

<dt><b>string html_encode_string( string s )</b><dd>



convert a string to HTML by quoting all characters that have special
meaning in HTML. Should always be used when inserting user input into
RXML code.

<p>
<dt><b>string html_decode_string( string s )</b><dd>



convert an HTML string to a plain string by unquoting HTML escape
sequences.

<p>
<dt><b>string do_output_tag( mapping args, array (mapping)
var_array, string contents, object id )</b><dd>



is used to process output tags, like <tt>&lt;sqloutput&gt;</tt>. <i>att</i>
is the attributes sent to the tag, they are necessary since there are
certain attributes that affect all output tag. <i>var_array</i>
contains an array of mappings with string, string
pairs. <tt>do_output_tag()</tt> will loop over the array and
insert the variables in the mappings in appropriate places in the
<i>contents</i>. 

<p>
<dt><b>string make_tag( string tag, mapping att )</b><dd>



creates a HTML tag with the name <i>tag</i> and the attributes from
<i>att</i>.

<p>
<dt><b>string make_container( string tag, mapping att, string
contents )</b><dd>



creates a HTML container tag, with the name <i>tag</i> the attributes
<i>att</i> and the contents <i>contents</i>.

<p>
<dt><b>string parse_rxml( string rxml, object id );</b><dd>



runs the RXML parser on the string <i>rxml</i>.
</dl>


      </td>
    </tr>
    </table>
  </td>
</tr>
<tr>
</table>
</body>
</html>
