weareswat/invoicexpress-gem

View on GitHub
doc/yard/Invoicexpress/Models/BaseInvoice.html

Summary

Maintainability
Test Coverage
<!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>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Module: Invoicexpress::Models::BaseInvoice
  
    &mdash; Documentation by YARD 0.8.5
  
</title>

  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '../../';
  framesUrl = "../../frames.html#!" + escape(window.location.href);
</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 id="header">
      <div id="menu">
  
    <a href="../../_index.html">Index (B)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../Invoicexpress.html" title="Invoicexpress (module)">Invoicexpress</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Models.html" title="Invoicexpress::Models (module)">Models</a></span></span>
     &raquo; 
    <span class="title">BaseInvoice</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../../class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="../../method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="../../file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Module: Invoicexpress::Models::BaseInvoice
  
  
  
</h1>

<dl class="box">
  
  
    
  
    
  
  
    <dt class="r1">Included in:</dt>
    <dd class="r1"><span class='object_link'><a href="CashInvoice.html" title="Invoicexpress::Models::CashInvoice (class)">CashInvoice</a></span>, <span class='object_link'><a href="CoreCashInvoice.html" title="Invoicexpress::Models::CoreCashInvoice (class)">CoreCashInvoice</a></span>, <span class='object_link'><a href="CoreCreditNote.html" title="Invoicexpress::Models::CoreCreditNote (class)">CoreCreditNote</a></span>, <span class='object_link'><a href="CoreDebitNote.html" title="Invoicexpress::Models::CoreDebitNote (class)">CoreDebitNote</a></span>, <span class='object_link'><a href="CoreInvoice.html" title="Invoicexpress::Models::CoreInvoice (class)">CoreInvoice</a></span>, <span class='object_link'><a href="CoreSimplifiedInvoice.html" title="Invoicexpress::Models::CoreSimplifiedInvoice (class)">CoreSimplifiedInvoice</a></span>, <span class='object_link'><a href="CreditNote.html" title="Invoicexpress::Models::CreditNote (class)">CreditNote</a></span>, <span class='object_link'><a href="DebitNote.html" title="Invoicexpress::Models::DebitNote (class)">DebitNote</a></span>, <span class='object_link'><a href="Invoice.html" title="Invoicexpress::Models::Invoice (class)">Invoice</a></span>, <span class='object_link'><a href="InvoiceTemplate.html" title="Invoicexpress::Models::InvoiceTemplate (class)">InvoiceTemplate</a></span>, <span class='object_link'><a href="SimplifiedInvoice.html" title="Invoicexpress::Models::SimplifiedInvoice (class)">SimplifiedInvoice</a></span></dd>
    
  
  
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">lib/invoicexpress/models/invoice.rb</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    <p>Fields common to all invoice models, necessary for create/update</p>


  </div>
</div>
<div class="tags">
  

</div>






  
    <h2>
      Class Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
</div></span>
  
</li>

      
    </ul>
  



  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="included-class_method">
  
    + (<tt>Object</tt>) <strong>included</strong>(base) 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/invoicexpress/models/invoice.rb', line 43</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
    <span class='id identifier rubyid_include'>include</span> <span class='const'>HappyMapper</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='const'>Integer</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:date</span><span class='comma'>,</span> <span class='const'>Date</span><span class='comma'>,</span> <span class='symbol'>:on_save</span> <span class='op'>=&gt;</span> <span class='const'>DATE_FORMAT</span> 
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:due_date</span><span class='comma'>,</span> <span class='const'>Date</span><span class='comma'>,</span> <span class='symbol'>:on_save</span> <span class='op'>=&gt;</span> <span class='const'>DATE_FORMAT</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:reference</span><span class='comma'>,</span> <span class='const'>String</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:observations</span><span class='comma'>,</span> <span class='const'>String</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:retention</span><span class='comma'>,</span> <span class='const'>Float</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:tax_exemption</span><span class='comma'>,</span> <span class='const'>String</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:sequence_id</span><span class='comma'>,</span> <span class='const'>Integer</span>
    <span class='id identifier rubyid_element'>element</span> <span class='symbol'>:mb_reference</span><span class='comma'>,</span> <span class='const'>String</span>
    <span class='id identifier rubyid_has_one'>has_one</span> <span class='symbol'>:client</span><span class='comma'>,</span> <span class='const'>Client</span>
    <span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:items</span><span class='comma'>,</span> <span class='const'>Item</span><span class='comma'>,</span> <span class='symbol'>:on_save</span> <span class='op'>=&gt;</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
      <span class='const'>Items</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:items</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
    <span class='rbrace'>}</span>
  <span class='kw'>end</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

    <div id="footer">
  Generated on Thu Jun 20 18:40:54 2013 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.5 (ruby-1.9.3).
</div>

  </body>
</html>