CORE POS - IS4C
The CORE POS front end
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
COREPOS\pos\lib\gui\BasicCorePage Class Reference
Inheritance diagram for COREPOS\pos\lib\gui\BasicCorePage:
boxMsg2 COREPOS\pos\lib\gui\InputCorePage COREPOS\pos\lib\gui\NoInputCorePage login2 login3 PaycardEmvSuccess PaycardProcessPage paycardSuccess PaycardTransLookupPage pos2 posCustDisplay QuantityEntryPage SigCapturePage StripeAmountPage undo_confirm UnpaidAR WicOverridePage WicTenderPage

Public Member Functions

 __construct ()
 
 head_content ()
 
 getHeader ()
 
 getFooter ()
 
 hide_input ($bool)
 
 footer ()
 

Protected Member Functions

 input_header ($action='')
 
 dateJS ()
 
 commonHeader ()
 
 noinput_header ()
 
 scale_box ()
 
 scanner_scale_polling ($include_scans=true)
 
 change_page ($url)
 
 default_parsewrapper_js ($input="reginput", $form="formlocal")
 
 noscan_parsewrapper_js ()
 

Protected Attributes

 $page_url
 
 $body_class ='mainBGimage'
 
 $title = "COREPOS"
 
 $hardware_polling = true
 
 $mask_input = false
 

Detailed Description

This is the base class for all display scripts

Display scripts are not required to use this base class but it does provide a lot of common functionality for building HTML pages with standard headers, footers, and styling.

Constructor & Destructor Documentation

COREPOS\pos\lib\gui\BasicCorePage::__construct ( )

Constructor

The constructor automatically runs the preprocess and print_page methods (if applicable). Creating a new instance will output the entire page contents

Member Function Documentation

COREPOS\pos\lib\gui\BasicCorePage::change_page (   $url)
protected

Go to a different page

Parameters
$urlthe new page URL

Use this function instead of manual redirects to allow debug output.

COREPOS\pos\lib\gui\BasicCorePage::default_parsewrapper_js (   $input = "reginput",
  $form = "formlocal" 
)
protected

Callback for javascript scanner-scale polling This one sends scan input to a form field on the page and other inputs through the normal parser

COREPOS\pos\lib\gui\BasicCorePage::footer ( )

Print the standard footer

Returns
None
COREPOS\pos\lib\gui\BasicCorePage::head_content ( )

Add output in the <head> section

Returns
None

This function should print anything that belongs inside the HTML head tags

COREPOS\pos\lib\gui\BasicCorePage::input_header (   $action = '')
protected

Display the standard header with input box

Parameters
$actionWhat the form does
Returns
None

The default action is for a page to POST back to itself. Any specified action will be included in the form tag exactly as is. You can pass "action=..." or "onsubmit=..." (or both) but $action should have one or the other attributes

COREPOS\pos\lib\gui\BasicCorePage::noinput_header ( )
protected

Display the standard header without input box

Returns
None
COREPOS\pos\lib\gui\BasicCorePage::noscan_parsewrapper_js ( )
protected

Callback for javascript scanner-scale polling This one ignores scan input and runs anything else through the parser

COREPOS\pos\lib\gui\BasicCorePage::scale_box ( )
protected

Output the standard scale display box

Returns
None
COREPOS\pos\lib\gui\BasicCorePage::scanner_scale_polling (   $include_scans = true)
protected

Read input from scale

Returns
None

Outputs the javascript used to poll for scale input and activates it on page load.

Member Data Documentation

COREPOS\pos\lib\gui\BasicCorePage::$page_url
protected

Relative URL for POS root directory Pages often need this.


The documentation for this class was generated from the following file: