<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: HTML</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">HTML</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/carat/html-helpers_rb.html">
lib/carat/html-helpers.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000409">CGI_include!</a>
<a href="#M000410">FCGI_include!</a>
<a href="#M000413">esc</a>
<a href="#M000414">escformat</a>
<a href="#M000412">marshal_from_html</a>
<a href="#M000411">marshal_to_html</a>
<a href="#M000415">render_object</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>
<div id="includes-list">
<span class="include-name">XHTML</span>
<span class="include-name">XHTML</span>
</div>
</div>
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000409" class="method-detail">
<a name="M000409"></a>
<div class="method-heading">
<a href="#M000409" class="method-signature">
<span class="method-name">CGI_include!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000409-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000409-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 26</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-constant">CGI_include!</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'cgi'</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">class_eval</span> { <span class="ruby-identifier">include</span> <span class="ruby-constant">XHTML</span> }
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000410" class="method-detail">
<a name="M000410"></a>
<div class="method-heading">
<a href="#M000410" class="method-signature">
<span class="method-name">FCGI_include!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000410-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000410-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 31</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-constant">FCGI_include!</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'fcgi'</span>
<span class="ruby-constant">FCGI</span>.<span class="ruby-identifier">class_eval</span> { <span class="ruby-identifier">include</span> <span class="ruby-constant">XHTML</span> }
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000413" class="method-detail">
<a name="M000413"></a>
<div class="method-heading">
<a href="#M000413" class="method-signature">
<span class="method-name">esc</span><span class="method-args">(str)</span>
</a>
</div>
<div class="method-description">
<p>
Return an html "safe" version of the string, where every &,
< and > are replaced with appropriate entities.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000413-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000413-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 57</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">esc</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/&/</span>,<span class="ruby-value str">'&amp;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/</</span>,<span class="ruby-value str">'&lt;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/>/</span>,<span class="ruby-value str">'&gt;'</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000414" class="method-detail">
<a name="M000414"></a>
<div class="method-heading">
<a href="#M000414" class="method-signature">
<span class="method-name">escformat</span><span class="method-args">(str)</span>
</a>
</div>
<div class="method-description">
<p>
Calls <a href="HTML.html#M000413">esc</a>, and then further replaces
carriage returns and quote characters with entities.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000414-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000414-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 62</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">escformat</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">xmlsafe</span>(<span class="ruby-identifier">str</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/[\r\n]+/</span>,<span class="ruby-value str">'&#13;&#10;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">%r|"|</span>,<span class="ruby-value str">'&quot;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">%r|'|</span>,<span class="ruby-value str">'&#39;'</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000412" class="method-detail">
<a name="M000412"></a>
<div class="method-heading">
<a href="#M000412" class="method-signature">
<span class="method-name">marshal_from_html</span><span class="method-args">(name)</span>
</a>
</div>
<div class="method-description">
<p>
Create an hidden input field throught which an object can can be
marshalled. This makes it very easy to pass from data betwenn requests.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000412-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000412-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 49</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">marshal_from_html</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword kw">return</span> <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-keyword kw">self</span>[<span class="ruby-node">"__#{name}__"</span>][<span class="ruby-value">0</span>])) <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-node">"__#{name}__"</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000411" class="method-detail">
<a name="M000411"></a>
<div class="method-heading">
<a href="#M000411" class="method-signature">
<span class="method-name">marshal_to_html</span><span class="method-args">(name, iobj)</span>
</a>
</div>
<div class="method-description">
<p>
Create an hidden input field through which an object can can be marshalled.
This makes it very easy to pass from data betwenn requests.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000411-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000411-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 42</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">marshal_to_html</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">iobj</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">iobj</span>))
<span class="ruby-keyword kw">return</span> <span class="ruby-node">%Q{<input type="hidden" name="__#{name}__" value="#{data}"/>\n}</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000415" class="method-detail">
<a name="M000415"></a>
<div class="method-heading">
<a href="#M000415" class="method-signature">
<span class="method-name">render_object</span><span class="method-args">(o, collection, edit)</span>
</a>
</div>
<div class="method-description">
<p>
Renders an object with annotations: <a
href="http://tinyurl.com/6xjnj">tinyurl.com/6xjnj</a> Creates a table
rendering <tt>o</tt>’s attributes.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000415-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000415-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/html-helpers.rb, line 68</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_object</span>(<span class="ruby-identifier">o</span>, <span class="ruby-identifier">collection</span>, <span class="ruby-identifier">edit</span>)
<span class="ruby-identifier">r</span> = <span class="ruby-value str">"<table>\n"</span>
<span class="ruby-identifier">o</span>.<span class="ruby-identifier">instance_variables</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr_name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">attr_value</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">attr_name</span>)
<span class="ruby-identifier">attr_anns</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">attr_name</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>])
<span class="ruby-identifier">r</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" <tr>\n"</span>
<span class="ruby-identifier">r</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" <td>"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attr_anns</span>[<span class="ruby-identifier">:description</span>] <span class="ruby-operator"><<</span> <span class="ruby-value str">"</td>\n"</span>
<span class="ruby-identifier">r</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" <td>"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">text_or_input</span>(<span class="ruby-identifier">edit</span>, <span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{collection}[#{o.class.name}][#{attr_name}]"</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">attr_value</span>) <span class="ruby-operator"><<</span> <span class="ruby-value str">"</td>\n"</span>
<span class="ruby-identifier">r</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" </tr>\n"</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">r</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"</table>"</span>
<span class="ruby-identifier">r</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>