doc/MCollective/Translatable.html

   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">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Module: MCollective::Translatable</title>
   9
  10         <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
  11
  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>
  20
  21 </head>
  22 <body class="module">
  23
  24         <div id="metadata">
  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">
  29                                         <ul>
  30
  31                                                 <li><a href="../lib/mcollective/translatable_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/translatable.rb">lib/mcollective/translatable.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45
  46                         <!-- Namespace Contents -->
  47
  48
  49                         <!-- Method Quickref -->
  50
  51                         <div id="method-list-section" class="section">
  52                                 <h3 class="section-header">Methods</h3>
  53                                 <ul class="link-list">
  54
  55                                         <li><a href="#M000235">#log_code</a></li>
  56
  57                                         <li><a href="#M000237">#logexception</a></li>
  58
  59                                         <li><a href="#M000236">#raise_code</a></li>
  60
  61                                         <li><a href="#M000234">#t</a></li>
  62
  63                                 </ul>
  64                         </div>
  65
  66
  67                         <!-- Included Modules -->
  68
  69                 </div>
  70
  71                 <div id="project-metadata">
  72
  73
  74                         <div id="fileindex-section" class="section project-section">
  75                                 <h3 class="section-header">Files</h3>
  76                                 <ul>
  77
  78                                         <li class="file"><a href="../COPYING.html">COPYING</a></li>
  79
  80                                         <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
  81
  82                                         <li class="file"><a href="../README.html">README</a></li>
  83
  84                                         <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
  85
  86                                         <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  87
  88                                         <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
  89
  90                                         <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  91
  92                                         <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  93
  94                                         <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  95
  96                                         <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
  97
  98                                         <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
  99
 100                                         <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 101
 102                                         <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 103
 104                                         <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 105
 106                                         <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 107
 108                                         <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 109
 110                                         <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 111
 112                                         <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 113
 114                                         <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 115
 116                                         <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
 117
 118                                 </ul>
 119                         </div>
 120
 121
 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">
 128                                 <fieldset>
 129                                         <legend>Quicksearch</legend>
 130                                         <input type="text" name="quicksearch" value=""
 131                                                 class="quicksearch-field" />
 132                                 </fieldset>
 133                                 </form>
 134
 135                                 <ul class="link-list">
 136
 137                                         <li><a href="../MCollective.html">MCollective</a></li>
 138
 139                                         <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
 140
 141                                         <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
 142
 143                                         <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 144
 145                                         <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 146
 147                                         <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 148
 149                                         <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 150
 151                                         <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 152
 153                                         <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 154
 155                                         <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
 156
 157                                         <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
 158
 159                                         <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
 160
 161                                         <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
 162
 163                                         <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
 164
 165                                         <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
 166
 167                                         <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
 168
 169                                         <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 170
 171                                         <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
 172
 173                                         <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 174
 175                                         <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 176
 177                                         <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 178
 179                                         <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 180
 181                                         <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 182
 183                                         <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 184
 185                                         <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
 186
 187                                         <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 188
 189                                         <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 190
 191                                         <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
 192
 193                                         <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
 194
 195                                         <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 196
 197                                         <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
 198
 199                                         <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 200
 201                                         <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 202
 203                                         <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 204
 205                                         <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 206
 207                                         <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
 208
 209                                         <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
 210
 211                                         <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 212
 213                                         <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 214
 215                                         <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 216
 217                                         <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 218
 219                                         <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
 220
 221                                         <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 222
 223                                         <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 224
 225                                         <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
 226
 227                                         <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 228
 229                                         <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 230
 231                                         <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 232
 233                                         <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 234
 235                                         <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 236
 237                                         <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 238
 239                                         <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 240
 241                                         <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 242
 243                                         <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 244
 245                                         <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
 246
 247                                         <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 248
 249                                         <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 250
 251                                         <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 252
 253                                         <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 254
 255                                         <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 256
 257                                         <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 258
 259                                         <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 260
 261                                         <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 262
 263                                         <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 264
 265                                         <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 266
 267                                         <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 268
 269                                         <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
 270
 271                                         <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
 272
 273                                         <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 274
 275                                         <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
 276
 277                                         <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 278
 279                                         <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
 280
 281                                         <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
 282
 283                                         <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 284
 285                                         <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 286
 287                                         <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
 288
 289                                         <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
 290
 291                                         <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 292
 293                                         <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 294
 295                                         <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 296
 297                                         <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
 298
 299                                         <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
 300
 301                                         <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 302
 303                                         <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 304
 305                                         <li><a href="../Array.html">Array</a></li>
 306
 307                                         <li><a href="../Dir.html">Dir</a></li>
 308
 309                                         <li><a href="../Object.html">Object</a></li>
 310
 311                                         <li><a href="../String.html">String</a></li>
 312
 313                                         <li><a href="../Symbol.html">Symbol</a></li>
 314
 315                                 </ul>
 316                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 317                         </div>
 318
 319
 320                 </div>
 321         </div>
 322
 323         <div id="documentation">
 324                 <h1 class="module">MCollective::Translatable</h1>
 325
 326                 <div id="description">
 327
 328                 </div>
 329
 330                 <!-- Constants -->
 331
 332
 333                 <!-- Attributes -->
 334
 335
 336                 <!-- Methods -->
 337
 338                 <div id="public-instance-method-details" class="method-section section">
 339                         <h3 class="section-header">Public Instance Methods</h3>
 340
 341
 342                         <div id="log-code-method" class="method-detail ">
 343                                 <a name="M000235"></a>
 344
 345                                 <div class="method-heading">
 346
 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>
 350
 351                                 </div>
 352
 353                                 <div class="method-description">
 354
 355                                         <p class="missing-docs">(Not documented)</p>
 356
 357
 358
 359                                         <div class="method-source-code"
 360                                                 id="log-code-source">
 361 <pre>
 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">&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>))]
 365  9:
 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>
 368                                         </div>
 369
 370                                 </div>
 371
 372
 373                         </div>
 374
 375
 376                         <div id="logexception-method" class="method-detail ">
 377                                 <a name="M000237"></a>
 378
 379                                 <div class="method-heading">
 380
 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>
 384
 385                                 </div>
 386
 387                                 <div class="method-description">
 388
 389                                         <p class="missing-docs">(Not documented)</p>
 390
 391
 392
 393                                         <div class="method-source-code"
 394                                                 id="logexception-source">
 395 <pre>
 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>
 400                                         </div>
 401
 402                                 </div>
 403
 404
 405                         </div>
 406
 407
 408                         <div id="raise-code-method" class="method-detail ">
 409                                 <a name="M000236"></a>
 410
 411                                 <div class="method-heading">
 412
 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>
 416
 417                                 </div>
 418
 419                                 <div class="method-description">
 420
 421                                         <p class="missing-docs">(Not documented)</p>
 422
 423
 424
 425                                         <div class="method-source-code"
 426                                                 id="raise-code-source">
 427 <pre>
 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>
 432 16:
 433 17:       <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
 434 18:     <span class="ruby-keyword kw">end</span></pre>
 435                                         </div>
 436
 437                                 </div>
 438
 439
 440                         </div>
 441
 442
 443                         <div id="t-method" class="method-detail ">
 444                                 <a name="M000234"></a>
 445
 446                                 <div class="method-heading">
 447
 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>
 451
 452                                 </div>
 453
 454                                 <div class="method-description">
 455
 456                                         <p class="missing-docs">(Not documented)</p>
 457
 458
 459
 460                                         <div class="method-source-code"
 461                                                 id="t-source">
 462 <pre>
 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">&gt;</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>
 467                                         </div>
 468
 469                                 </div>
 470
 471
 472                         </div>
 473
 474
 475                 </div>
 476
 477
 478         </div>
 479
 480
 481         <div id="rdoc-debugging-section-dump" class="debugging-section">
 482
 483                 <p>Disabled; run with --debug to generate this.</p>
 484
 485         </div>
 486
 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>
 491         </div>
 492
 493 </body>
 494 </html>
 495