doc/classes/MCollective/Translatable.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Module: MCollective::Translatable</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Module</strong></td>
  53           <td class="class-name-in-header">MCollective::Translatable</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/mcollective/translatable_rb.html">
  59                 lib/mcollective/translatable.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         </table>
  66     </div>
  67   <!-- banner header -->
  68
  69   <div id="bodyContent">
  70
  71
  72
  73   <div id="contextContent">
  74
  75
  76
  77    </div>
  78
  79     <div id="method-list">
  80       <h3 class="section-bar">Methods</h3>
  81
  82       <div class="name-list">
  83       <a href="#M000246">log_code</a>&nbsp;&nbsp;
  84       <a href="#M000248">logexception</a>&nbsp;&nbsp;
  85       <a href="#M000247">raise_code</a>&nbsp;&nbsp;
  86       <a href="#M000245">t</a>&nbsp;&nbsp;
  87       </div>
  88     </div>
  89
  90   </div>
  91
  92
  93     <!-- if includes -->
  94
  95     <div id="section">
  96
  97
  98
  99
 100
 101
 102
 103
 104     <!-- if method_list -->
 105     <div id="methods">
 106       <h3 class="section-bar">Public Instance methods</h3>
 107
 108       <div id="method-M000246" class="method-detail">
 109         <a name="M000246"></a>
 110
 111         <div class="method-heading">
 112           <a href="#M000246" class="method-signature">
 113           <span class="method-name">log_code</span><span class="method-args">(msgid, default, level, args={})</span>
 114           </a>
 115         </div>
 116
 117         <div class="method-description">
 118           <p><a class="source-toggle" href="#"
 119             onclick="toggleCode('M000246-source');return false;">[Source]</a></p>
 120           <div class="method-source-code" id="M000246-source">
 121 <pre>
 122     <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 7</span>
 123  7:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
 124  8:       <span class="ruby-identifier">msg</span> = <span class="ruby-value str">&quot;%s: %s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))]
 125  9:
 126 10:       <span class="ruby-constant">Log</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span>]))
 127 11:     <span class="ruby-keyword kw">end</span>
 128 </pre>
 129           </div>
 130         </div>
 131       </div>
 132
 133       <div id="method-M000248" class="method-detail">
 134         <a name="M000248"></a>
 135
 136         <div class="method-heading">
 137           <a href="#M000248" class="method-signature">
 138           <span class="method-name">logexception</span><span class="method-args">(msgid, default, level, e, backtrace=false)</span>
 139           </a>
 140         </div>
 141
 142         <div class="method-description">
 143           <p><a class="source-toggle" href="#"
 144             onclick="toggleCode('M000248-source');return false;">[Source]</a></p>
 145           <div class="method-source-code" id="M000248-source">
 146 <pre>
 147     <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 20</span>
 148 20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>)
 149 21:       <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>)
 150 22:     <span class="ruby-keyword kw">end</span>
 151 </pre>
 152           </div>
 153         </div>
 154       </div>
 155
 156       <div id="method-M000247" class="method-detail">
 157         <a name="M000247"></a>
 158
 159         <div class="method-heading">
 160           <a href="#M000247" class="method-signature">
 161           <span class="method-name">raise_code</span><span class="method-args">(msgid, default, level, args={})</span>
 162           </a>
 163         </div>
 164
 165         <div class="method-description">
 166           <p><a class="source-toggle" href="#"
 167             onclick="toggleCode('M000247-source');return false;">[Source]</a></p>
 168           <div class="method-source-code" id="M000247-source">
 169 <pre>
 170     <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 13</span>
 171 13:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
 172 14:       <span class="ruby-identifier">exception</span> = <span class="ruby-constant">CodedError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>)
 173 15:       <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
 174 16:
 175 17:       <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
 176 18:     <span class="ruby-keyword kw">end</span>
 177 </pre>
 178           </div>
 179         </div>
 180       </div>
 181
 182       <div id="method-M000245" class="method-detail">
 183         <a name="M000245"></a>
 184
 185         <div class="method-heading">
 186           <a href="#M000245" class="method-signature">
 187           <span class="method-name">t</span><span class="method-args">(msgid, default, args={})</span>
 188           </a>
 189         </div>
 190
 191         <div class="method-description">
 192           <p><a class="source-toggle" href="#"
 193             onclick="toggleCode('M000245-source');return false;">[Source]</a></p>
 194           <div class="method-source-code" id="M000245-source">
 195 <pre>
 196    <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 3</span>
 197 3:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">args</span>={})
 198 4:       <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
 199 5:     <span class="ruby-keyword kw">end</span>
 200 </pre>
 201           </div>
 202         </div>
 203       </div>
 204
 205
 206     </div>
 207
 208
 209   </div>
 210
 211
 212 <div id="validator-badges">
 213   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 214 </div>
 215
 216 </body>
 217 </html>