1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Module: MCollective::Translatable</title>
10 <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
12 <script src="../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../lib/mcollective/translatable_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/translatable.rb">lib/mcollective/translatable.rb</a></li>
41 <div id="class-metadata">
46 <!-- Namespace Contents -->
49 <!-- Method Quickref -->
51 <div id="method-list-section" class="section">
52 <h3 class="section-header">Methods</h3>
53 <ul class="link-list">
55 <li><a href="#M000235">#log_code</a></li>
57 <li><a href="#M000237">#logexception</a></li>
59 <li><a href="#M000236">#raise_code</a></li>
61 <li><a href="#M000234">#t</a></li>
67 <!-- Included Modules -->
71 <div id="project-metadata">
74 <div id="fileindex-section" class="section project-section">
75 <h3 class="section-header">Files</h3>
78 <li class="file"><a href="../COPYING.html">COPYING</a></li>
80 <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
82 <li class="file"><a href="../README.html">README</a></li>
84 <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
86 <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
88 <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
90 <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
92 <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
94 <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
96 <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
98 <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
100 <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
102 <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
104 <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
106 <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
108 <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
110 <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
112 <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
114 <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
116 <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
122 <div id="classindex-section" class="section project-section">
123 <h3 class="section-header">Class Index
124 <span class="search-toggle"><img src="../images/find.png"
125 height="16" width="16" alt="[+]"
126 title="show/hide quicksearch" /></span></h3>
127 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
129 <legend>Quicksearch</legend>
130 <input type="text" name="quicksearch" value=""
131 class="quicksearch-field" />
135 <ul class="link-list">
137 <li><a href="../MCollective.html">MCollective</a></li>
139 <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
141 <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
143 <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
145 <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
147 <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
149 <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
151 <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
153 <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
155 <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
157 <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
159 <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
161 <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
163 <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
165 <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
167 <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
169 <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
171 <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
173 <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
175 <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
177 <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
179 <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
181 <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
183 <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
185 <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
187 <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
189 <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
191 <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
193 <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
195 <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
197 <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
199 <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
201 <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
203 <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
205 <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
207 <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
209 <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
211 <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
213 <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
215 <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
217 <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
219 <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
221 <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
223 <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
225 <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
227 <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
229 <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
231 <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
233 <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
235 <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
237 <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
239 <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
241 <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
243 <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
245 <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
247 <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
249 <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
251 <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
253 <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
255 <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
257 <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
259 <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
261 <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
263 <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
265 <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
267 <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
269 <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
271 <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
273 <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
275 <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
277 <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
279 <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
281 <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
283 <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
285 <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
287 <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
289 <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
291 <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
293 <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
295 <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
297 <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
299 <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
301 <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
303 <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
305 <li><a href="../Array.html">Array</a></li>
307 <li><a href="../Dir.html">Dir</a></li>
309 <li><a href="../Object.html">Object</a></li>
311 <li><a href="../String.html">String</a></li>
313 <li><a href="../Symbol.html">Symbol</a></li>
316 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
323 <div id="documentation">
324 <h1 class="module">MCollective::Translatable</h1>
326 <div id="description">
338 <div id="public-instance-method-details" class="method-section section">
339 <h3 class="section-header">Public Instance Methods</h3>
342 <div id="log-code-method" class="method-detail ">
343 <a name="M000235"></a>
345 <div class="method-heading">
347 <span class="method-name">log_code</span><span
348 class="method-args">(msgid, default, level, args={})</span>
349 <span class="method-click-advice">click to toggle source</span>
353 <div class="method-description">
355 <p class="missing-docs">(Not documented)</p>
359 <div class="method-source-code"
360 id="log-code-source">
362 <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 7</span>
363 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>={})
364 8: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</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">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))]
366 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>]))
367 11: <span class="ruby-keyword kw">end</span></pre>
376 <div id="logexception-method" class="method-detail ">
377 <a name="M000237"></a>
379 <div class="method-heading">
381 <span class="method-name">logexception</span><span
382 class="method-args">(msgid, default, level, e, backtrace=false)</span>
383 <span class="method-click-advice">click to toggle source</span>
387 <div class="method-description">
389 <p class="missing-docs">(Not documented)</p>
393 <div class="method-source-code"
394 id="logexception-source">
396 <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 20</span>
397 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>)
398 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>)
399 22: <span class="ruby-keyword kw">end</span></pre>
408 <div id="raise-code-method" class="method-detail ">
409 <a name="M000236"></a>
411 <div class="method-heading">
413 <span class="method-name">raise_code</span><span
414 class="method-args">(msgid, default, level, args={})</span>
415 <span class="method-click-advice">click to toggle source</span>
419 <div class="method-description">
421 <p class="missing-docs">(Not documented)</p>
425 <div class="method-source-code"
426 id="raise-code-source">
428 <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 13</span>
429 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>={})
430 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>)
431 15: <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
433 17: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
434 18: <span class="ruby-keyword kw">end</span></pre>
443 <div id="t-method" class="method-detail ">
444 <a name="M000234"></a>
446 <div class="method-heading">
448 <span class="method-name">t</span><span
449 class="method-args">(msgid, default, args={})</span>
450 <span class="method-click-advice">click to toggle source</span>
454 <div class="method-description">
456 <p class="missing-docs">(Not documented)</p>
460 <div class="method-source-code"
463 <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 3</span>
464 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>={})
465 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">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
466 5: <span class="ruby-keyword kw">end</span></pre>
481 <div id="rdoc-debugging-section-dump" class="debugging-section">
483 <p>Disabled; run with --debug to generate this.</p>
487 <div id="validator-badges">
488 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
489 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
490 Rdoc Generator</a> 1.1.6</small>.</p>