egroupware/phpgwapi/js/jsolait/doc/codecs.xhtml

68 lines
3.1 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>.: jsolait :. | documentation | codecs</title>
<link rel="stylesheet" type="text/css" href="./html.css" />
<meta name="author" content="Jan-Klaas Kollhof" />
<meta name="keywords" content="jsolait.codecs" />
</head>
<body>
<a name="top" id="top"></a>
<div class="navigationBar"><a href="./index.xhtml">documentation</a> |
codecs</div>
<div class="menu">
<ul></ul>
<div class="copyright">copyright © 2004, Jan-Klaas Kollhof</div>
</div>
<div class="content">
<h1>Module codecs</h1>
This module extends the String class with encoding and decoding functionalities.<br />
<br />
<div class="contentItem"><h2>public methods:<a class="bttop" href="#top"></a></h2><div>
<h3>listEncoders()</h3><div class="indent">
Returns an Array with all encoder names.<br />
</div>
<h3>listDecoders()</h3><div class="indent">
Returns an Arra with all decoder names.<br />
</div>
</div></div>
<div class="contentItem"><h2>globals:<a class="bttop" href="#top"></a></h2><div>
<h3>String::decode(codec)</h3><div class="indent">
Decodes an encoded string using the codec specified by the <code>codec</code>parameter .<br />
All parameters but the <code>codec</code> parameter are forwarded to the codec.<br />
</div>
<h3>String::encode(codec)</h3><div class="indent">
Encodes a string using the codec specified by the <code>codec</code> parameter.<br />
All Parameters but the <code>codec</code> parameter are forwarded to the codec.<br />
</div>
<h3>String::decode_base64()</h3><div class="indent">
Decodes a Base64 encoded string to a byte string.<br />
</div>
<h3>String::encode_base64()</h3><div class="indent">
Encodes a string using Base64.<br />
</div>
<h3>String::decode_uri()</h3><div class="indent">
Decodes a URI using decodeURI.<br />
</div>
<h3>String::encode_uri()</h3><div class="indent">
Encodes a URI using encodeURI.<br />
</div>
</div></div>
<div class="contentItem"><h2>codecs<a class="bttop" href="#top"></a></h2><div>
Currently there are only two codecs <b>base64</b> and <b>uri</b>.<br />
If you want to add your own codecs at runtime just extend the Stringl class by adding a
<code>String.prototype.encode_yourCodec</code> or
<code>String.prototype.decode_yourCodec</code> method.
</div></div>
</div>
</body>
</html>