<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Module: Hyde::DSL::ProbeConstructors — Documentation by YARD 0.9.34 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Hyde::DSL::ProbeConstructors"; relpath = '../../'; </script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../../_index.html">Index (P)</a> » <span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> » <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span> » <span class="title">ProbeConstructors</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Module: Hyde::DSL::ProbeConstructors </h1> <div class="box_info"> <dl> <dt>Included in:</dt> <dd><span class='object_link'><a href="../ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>, <span class='object_link'><a href="../TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/hyde/dsl/constructors_probe.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Probe (and subclasses) DSL construct</p> </div> </div> <div class="tags"> </div> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#erb-instance_method" title="#erb (instance method)">#<strong>erb</strong>(input, vars = {}) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Create a new erb template.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#erubi-instance_method" title="#erubi (instance method)">#<strong>erubi</strong>(input, vars = {}, freeze: true, capture: false) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Create a new erb template using Erubi engine.</p> </div></span> </li> </ul> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="erb-instance_method"> #<strong>erb</strong>(input, vars = {}) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Create a new erb template</p> </div> </div> <div class="tags"> <p class="tag_title">See Also:</p> <ul class="see"> <li>Hyde::DSL::ProbeConstructors.{Hyde{Hyde::Template{Hyde::Template#new}</li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 9 10 11 12 13</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_probe.rb', line 9</span> <span class='kw'>def</span> <span class='id identifier rubyid_erb'>erb</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates/ERB.html" title="Hyde::Templates::ERB (class)">ERB</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Templates/ERB.html#initialize-instance_method" title="Hyde::Templates::ERB#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="erubi-instance_method"> #<strong>erubi</strong>(input, vars = {}, freeze: true, capture: false) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Create a new erb template using Erubi engine</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>freeze</span> <span class='type'>(<tt>Boolean</tt>)</span> <em class="default">(defaults to: <tt>true</tt>)</em> — <div class='inline'><p>whether to use frozen string literal</p> </div> </li> <li> <span class='name'>capture</span> <span class='type'>(<tt>Boolean</tt>)</span> <em class="default">(defaults to: <tt>false</tt>)</em> — <div class='inline'><p>whether to enable output capturing</p> </div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li>Hyde::DSL::ProbeConstructors.{Hyde{Hyde::Template{Hyde::Template#new}</li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 19 20 21 22 23 24 25</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_probe.rb', line 19</span> <span class='kw'>def</span> <span class='id identifier rubyid_erubi'>erubi</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>freeze:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>capture:</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates/Erubi.html" title="Hyde::Templates::Erubi (class)">Erubi</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Templates/Erubi.html#initialize-instance_method" title="Hyde::Templates::Erubi#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='label'>freeze:</span> <span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span> <span class='label'>capture:</span> <span class='id identifier rubyid_capture'>capture</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sun Sep 17 00:23:45 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.0.6). </div> </div> </body> </html>