Static Public Member Functions | |
| static | printfooter ($readOnly=False) |
| static | plainmsg ($strmsg) |
| static | msgbox ($strmsg, $icon, $noBeep=false, $buttons=array()) |
| static | xboxMsg ($strmsg, $buttons=array()) |
| static | boxMsg ($strmsg, $header="", $noBeep=false, $buttons=array()) |
| static | inputUnknown () |
| static | standardClearButton () |
| static | printheaderb () |
| static | printItem ($field2, $field3, $total, $field5, $trans_id=-1) |
| static | printItemColor ($color, $description, $comments, $total, $suffix, $trans_id=-1) |
| static | printItemColorHilite ($color, $description, $comments, $total, $suffix) |
| static | scaledisplaymsg ($input="") |
| static | termdisplaymsg () |
| static | drawNotifications () |
| static | listItems ($top_item, $highlight) |
| static | printReceiptfooter ($readOnly=False) |
| static | drawItems ($top_item, $rows, $highlight) |
| static | lastpage ($readOnly=False) |
| static | screenDisplay ($min, $max) |
| static | touchScreenScrollButtons ($selector='#search') |
Detailed Description
Functions for drawing display elements
Member Function Documentation
|
static |
Get a centered message box with "exclaimC" graphic
- Parameters
-
$strmsg the message $header title for the box $noBeep don't beep scale $buttons see msgbox()
- Returns
- An HTML string
An alias for msgbox().
- Examples:
- HelloWorld.php, and HW_Parser.php.
|
static |
Get the currently displayed items
- Parameters
-
$top_item is the trans_id of the first item to display $rows is the number of items to display $highlight is the trans_id of the selected item
- Returns
- An HTML string
This function probably shouldn't be used directly. Call listitems() or lastpage() instead.
30Oct2014 Andy Idea here is to look up the currently displayed items and perform any necessary transformations of the text in PHP instead of tucking that logic inside the screendisplay view. I'm leaving the query above for reference in case I screwed something up and the old method of drawing the screen needs to be quickly re-enabled.
14Nov2014 Andy Disabled for the sake of putting together a release. Will go into testing following the release and be included in the next one
03Dec2014 Andy Axing screen display isn't a super high priority right now With better unit testing in place, I want to write more tests to verify this method behaves the same as the screendisplay via. No ETA at this point.
11Mar14 Andy Ancient idea about displaying transaction line-items on credit card terminal screen. Current terminal does not even support this functionality.
I'm leaving the "get last relevant line" implementation for reference. if (is_object($td) && !empty($last_item)) { $due = sprintf('%.2f',CoreLocal::get("amtdue")); $dueline = 'Subtotal' .str_pad('',22-strlen($due),' ') .$due; $items = ""; $count = 0; for($i=count($last_item)-1;$i>=0;$i–) { $items = ":".$last_item[$i].$items; $count++; if ($count >= 3) break; } for($i=$count;$i<3;$i++) { $items = ": ".$items; } $td->WriteToScale("display:".$last_item.":".$dueline); }
|
static |
Use the right side of the screen to show various notifications
|
static |
|
static |
Get the currently displayed items
- Parameters
-
$readOnly don't update session
- Returns
- An HTML string
This will always display the most recently scanned items. If you want a specific subset, use listitems().
|
static |
Get the items currently on screen
- Parameters
-
$top_item is trans_id (localtemptrans) of the first item to display $highlight is the trans_id (localtemptrans) of the currently selected item
- Returns
- An HTML string
If you just want to show the most recently scanned items, use lastpage().
|
static |
Get a centered message box
- Parameters
-
$strmsg the message $icon graphic icon file $noBeep don't send a scale beep $buttons keyed array of touchable/clickable buttons - key is the text shown on the button
- value is javascript executed onclick
- Returns
- An HTML string
This function will include the header printheaderb().
|
static |
Wrap a message in a id="plainmsg" div
- Parameters
-
$strmsg the message
- Returns
- An HTML string
|
static |
Get the standard footer with total and amount(s) saved
- Parameters
-
$readOnly don't update any session info This would be set when rendering a separate, different customer display
- Returns
- A string of HTML
|
static |
Get the standard header row with CASHIER and MEMBER info
- Returns
- An HTML string
|
static |
Get a transaction line item
- Parameters
-
$field2 typically description $field3 comment section. Used for things like "0.59@1.99" on weight items. $total the right-hand number $field5 flags after the number $trans_id value from localtemptrans. Including the trans_id makes the lines selectable via mouseclick (or touchscreen).
- Returns
- An HTML string
|
static |
Get a transaction line item in a specific color
- Parameters
-
$color is a hex color code (do not include a '#') (see CSS notes) $description typically description $comments comment section. Used for things like "0.59@1.99" on weight items. $total the right-hand number $suffix flags after the number $trans_id value from localtemptrans. Including the trans_id makes the lines selectable via mouseclick (or touchscreen).
- Returns
- An HTML string
CSS Notes: In an effort to replace hard-coded colors, some values are re-written as CSS classes rather than inline styles. Current mapping:
- 004080 => coloredText
- 408080 => lightColorText
- 000000 => totalLine
- 800080 => fsLine
|
static |
Get a transaction line item in a specific color
- Parameters
-
$color is a hex color code (do not include a '#') (see CSS notes) $description typically description $comments comment section. Used for things like "0.59@1.99" on weight items. $total the right-hand number $suffix flags after the number
- Returns
- An HTML string
CSS Notes: In an effort to replace hard-coded colors, some values are re-written as CSS classes rather than inline styles. Current mapping:
- 004080 => coloredArea
- 408080 => lightColorArea
- 000000 => totalArea
- 800080 => fsArea
|
static |
Show some items and farewell message
- Parameters
-
$readOnly don't update totals
- Returns
- An HTML string
Show a few recent items and the "Thank you for shopping" messaging.
Yes, this function should be renamed. It has nothing to do with receipts.
|
static |
Get the scale display box
- Parameters
-
$input message from scale
- Returns
- An HTML string
If $input is specified, weight information in the session gets updated before returning the current value.
Known input values are:
- S11WWWW where WWWW is weight in hundreths (i.e., 1lb = 0100)
- S141 not settled on a weight yet
- S143 zero weight
- S145 an error condition
- S142 an error condition
|
static |
Select items from the transaction with formatting for on screen display
- Parameters
-
$min [int] minimum localtemptrans.trans_id $max [int] maximum localtemtprans.trans_id
- Returns
- array of records
Each record contains the following keys:
- description
- comment
- total
- status
- discounttype
- trans_status
- trans_type
- voided
- trans_id
Note: the outer array is indexed by localtemptrans.trans_id instead of zero through array.length.
|
static |
Display CC terminal state
- Returns
- HTML string
|
static |
The documentation for this class was generated from the following file:
- pos/is4c-nf/lib/DisplayLib.php
