| 
| 
static  | loanSchedule ($loan) | 
|   | 
| static  | allocateCheck ($map_model, $mapped=true) | 
|   | 
| 
static  | getCheck ($map_model) | 
|   | 
| static  | getSetting ($key, $default='') | 
|   | 
  
  
      
        
          | static GumLib::allocateCheck  | 
          ( | 
            | 
          $map_model,  | 
         
        
           | 
           | 
            | 
          $mapped = true  | 
         
        
           | 
          ) | 
           |  | 
         
       
   | 
  
static   | 
  
 
Create an entry in GumPayoffs representing a new check 
- Parameters
 - 
  
    | $map_model | a model for a mapping table (e.g., GumLoanPayoffMapModel) where the new gumPayoffID can be saved  | 
    | $mapped | [boolean, default true] save a reference in the $map_model Set to false if simply allocating a check number for use from outside the plugin. Turning off mapping will return the check number rather than the gumPayoffID  | 
  
   
- Returns
 - [int] gumPayoffID or [boolean] false on failure 
 
Create a new GumPayoffs entry for the check then save its ID in the provided map. If the 2nd step fails somehow, delete the GumPayoffs record so the check number is wasted.
 
 
  
  
      
        
          | static GumLib::getSetting  | 
          ( | 
            | 
          $key,  | 
         
        
           | 
           | 
            | 
          $default = ''  | 
         
        
           | 
          ) | 
           |  | 
         
       
   | 
  
static   | 
  
 
Get value for a given setting 
- Parameters
 - 
  
    | $key | [string] setting key  | 
    | $default | [string] value to use if setting is missing  | 
  
   
- Returns
 - [string] setting value or $default 
 
 
 
The documentation for this class was generated from the following file:
- fannie/modules/plugins2.0/GiveUsMoneyPlugin/GumLib.php