Inheritance diagram for COREPOS\pos\lib\Tenders\TenderModule:
Public Member Functions | |
| __construct ($code, $amt) | |
| errorCheck () | |
| preReqCheck () | |
| add () | |
| changeType () | |
| changeMsg () | |
| allowDefault () | |
| defaultTotal () | |
| defaultPrompt () | |
| disabledPrompt () | |
Protected Member Functions | |
| frankingPrompt () | |
Protected Attributes | |
| $tender_code | |
| $amount | |
| $name_string = '' | |
| $change_type = 'CA' | |
| $change_string = 'Change' | |
| $min_limit = 0 | |
| $max_limit = 0 | |
Detailed Description
Base class for modular tenders
Constructor & Destructor Documentation
| COREPOS\pos\lib\Tenders\TenderModule::__construct | ( | $code, | |
| $amt | |||
| ) |
Constructor
- Parameters
-
$code two letter tender code $amt tender amount
If you override this, be sure to call the parent constructor
Member Function Documentation
| COREPOS\pos\lib\Tenders\TenderModule::add | ( | ) |
Add tender to the transaction
| COREPOS\pos\lib\Tenders\TenderModule::allowDefault | ( | ) |
Allow the tender to be used without specifying a total
- Returns
- boolean
| COREPOS\pos\lib\Tenders\TenderModule::changeMsg | ( | ) |
What description should be used for change records associated with this tender
- Returns
- string change description
| COREPOS\pos\lib\Tenders\TenderModule::changeType | ( | ) |
What type should be used for change records associated with this tender.
- Returns
- string tender code
| COREPOS\pos\lib\Tenders\TenderModule::defaultPrompt | ( | ) |
Prompt for the cashier when no total is provided
- Returns
- string URL
Typically this sets up session variables and returns the URL for boxMsg2.php.
| COREPOS\pos\lib\Tenders\TenderModule::defaultTotal | ( | ) |
Value to use if no total is provided
- Returns
- number
| COREPOS\pos\lib\Tenders\TenderModule::disabledPrompt | ( | ) |
Error message shown if tender cannot be used without specifying a total
- Returns
- html string
| COREPOS\pos\lib\Tenders\TenderModule::errorCheck | ( | ) |
Check for errors
- Returns
- True or an error message string
| COREPOS\pos\lib\Tenders\TenderModule::preReqCheck | ( | ) |
Set up state and redirect if needed
- Returns
- True or a URL to redirect
The documentation for this class was generated from the following file:
- pos/is4c-nf/lib/Tenders/TenderModule.php
