Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2026-02-13 03:12:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12306 from frederic34/escpos

Browse Source 
Escpos
This commit is contained in:
Laurent Destailleur
2019-11-04 20:40:12 +01:00
committed by GitHub
parent 4566159e69 6ad983bb7b
commit 17ea978cea
147 changed files with 7797 additions and 6571 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.stickler.yml
View File

@@ -8,3 +8,7 @@ linters:
fixers:
enable: true
files:
ignore:
- 'htdocs/includes/*'

8
COPYRIGHT
View File

@@ -2,7 +2,7 @@
License
-------
Dolibarr is released under the terms of the GNU General Public License as
Dolibarr is released under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version (GPL-3+).
More information: https://www.gnu.org/licenses/gpl-3.0.txt
@@ -15,13 +15,13 @@ PHP libraries:
AdoDb-Date 0.36 Modified BSD License Yes Date convertion (not into rpm package)
CKEditor 4.12.1 LGPL-2.1+ Yes Editor WYSIWYG
EvalMath 1.0 BSD Yes Safe math expressions evaluation
Escpos-php ? MIT License Yes Thermal receipt printer library, for use with ESC/POS compatible printers
Escpos-php 2.2 MIT License Yes Thermal receipt printer library, for use with ESC/POS compatible printers
GeoIP 1.4 LGPL-2.1+ Yes Sample code to make geoip convert (not into deb package)
Mobiledetect 2.8.33 MIT License Yes Detect mobile devices browsers
NuSoap 0.9.5 LGPL 2.1+ Yes Library to develop SOAP Web services (not into rpm and deb package)
PEAR Mail_MIME 1.8.9 BSD Yes NuSoap dependency
ParseDown 1.6 MIT License Yes Markdown parser
PHPDebugBar 1.15.0 MIT License Yes Used only by the module "debugbar" for developers
PHPDebugBar 1.15.0 MIT License Yes Used only by the module "debugbar" for developers
PHPExcel 1.8.1 LGPL-2.1+ Yes Read/Write XLS files, read ODS files
PHPSpreadSheet ? LGPL-2.1+ Yes Read/Write XLS files, read ODS files
php-iban 1.4.7 LGPL-3+ Yes Parse and validate IBAN (and IIBAN) bank account information in PHP
@@ -37,7 +37,7 @@ TCPDF 6.3.2 LGPL-3+ Yes
TCPDI 1.0.0 LGPL-3+ / Apache 2.0 Yes FPDI replacement
JS libraries:
Ace 1.4.6 BSD Yes JS library to get code syntaxique coloration in a textarea.
Ace 1.4.6 BSD Yes JS library to get code syntaxique coloration in a textarea.
jQuery 3.4.1 MIT License Yes JS library
jQuery UI 1.12.1 GPL and MIT License Yes JS library plugin UI
jQuery select2 4.0.5 GPL and Apache License Yes JS library plugin for sexier multiselect

99
htdocs/admin/receiptprinter.php
View File

@@ -166,6 +166,29 @@ if ($action == 'testprinter' && $user->admin) {
$action = '';
}
if ($action == 'testtemplate' && $user->admin) {
$error=0;
// if (empty($printerid)) {
// $error++;
// setEventMessages($langs->trans("PrinterIdEmpty"), null, 'errors');
// }
// if (! $error) {
// test
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
$object = new Facture($db);
//$object->initAsSpecimen();
$object->fetch(18);
//var_dump($object->lines);
$ret = $printer->sendToPrinter($object, $templateid, 1);
if ($ret == 0) {
setEventMessages($langs->trans("TestTemplateToPrinter", $printername), null);
} else {
setEventMessages($printer->error, $printer->errors, 'errors');
}
//}
$action = '';
}
if ($action == 'updatetemplate' && $user->admin) {
$error=0;
@@ -190,6 +213,29 @@ if ($action == 'updatetemplate' && $user->admin) {
$action = '';
}
if ($action == 'addtemplate' && $user->admin) {
$error=0;
$db->begin();
if (empty($templatename)) {
$error++;
setEventMessages($langs->trans("TemplateNameEmpty"), null, 'errors');
}
if (! $error) {
$result= $printer->addTemplate($templatename, $template);
if ($result > 0) $error++;
if (! $error) {
$db->commit();
setEventMessages($langs->trans("TemplateAdded", $templatename), null);
} else {
$db->rollback();
dol_print_error($db);
}
}
$action = '';
}
/*
* View
@@ -217,15 +263,13 @@ if ($mode == 'config' && $user->admin) {
print $langs->trans("ReceiptPrinterDesc")."<br><br>\n";
print '<table class="noborder" width="100%">'."\n";
print '<table class="noborder centpercent">'."\n";
print '<tr class="liste_titre">';
print '<th>'.$langs->trans("Name").'</th>';
print '<th>'.$langs->trans("Type").'</th>';
print '<th>'.$langs->trans("Profile").'</th>';
print '<th>'.$langs->trans("Parameters").'</th>';
print '<th></th>';
print '<th></th>';
print '<th></th>';
print "</tr>\n";
$ret = $printer->listprinters();
$nbofprinters = count($printer->listprinters);
@@ -244,8 +288,6 @@ if ($mode == 'config' && $user->admin) {
print '<td>'.$printer->profileresprint.'</td>';
print '<td><input size="60" type="text" name="parameter" value="'.$printer->listprinters[$line]['parameter'].'"></td>';
print '<td></td>';
print '<td></td>';
print '<td></td>';
print '</tr>';
} else {
print '<td>'.$printer->listprinters[$line]['name'].'</td>';
@@ -255,13 +297,13 @@ if ($mode == 'config' && $user->admin) {
// edit icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=config&amp;action=editprinter&amp;printerid='.$printer->listprinters[$line]['rowid'].'">';
print img_picto($langs->trans("Edit"), 'edit');
print '</a></td>';
print '</a>';
// delete icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=config&amp;action=deleteprinter&amp;printerid='.$printer->listprinters[$line]['rowid'].'&amp;printername='.$printer->listprinters[$line]['name'].'">';
print '<a href="'.$_SERVER['PHP_SELF'].'?mode=config&amp;action=deleteprinter&amp;printerid='.$printer->listprinters[$line]['rowid'].'&amp;printername='.$printer->listprinters[$line]['name'].'">';
print img_picto($langs->trans("Delete"), 'delete');
print '</a></td>';
print '</a>';
// test icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=config&amp;action=testprinter&amp;printerid='.$printer->listprinters[$line]['rowid'].'&amp;printername='.$printer->listprinters[$line]['name'].'">';
print '<a href="'.$_SERVER['PHP_SELF'].'?mode=config&amp;action=testprinter&amp;printerid='.$printer->listprinters[$line]['rowid'].'&amp;printername='.$printer->listprinters[$line]['name'].'">';
print img_picto($langs->trans("TestPrinter"), 'printer');
print '</a></td>';
print '</tr>';
@@ -269,7 +311,7 @@ if ($mode == 'config' && $user->admin) {
}
}
if ($action!='editprinter') {
if ($action != 'editprinter') {
if ($nbofprinters > 0) {
print '<tr class="liste_titre">';
print '<th>'.$langs->trans("Name").'</th>';
@@ -277,8 +319,6 @@ if ($mode == 'config' && $user->admin) {
print '<th>'.$langs->trans("Profile").'</th>';
print '<th>'.$langs->trans("Parameters").'</th>';
print '<th></th>';
print '<th></th>';
print '<th></th>';
print "</tr>\n";
}
@@ -345,7 +385,7 @@ if ($mode == 'template' && $user->admin) {
dol_fiche_head($head, $mode, $langs->trans("ModuleSetup"), 0, 'technic');
print $langs->trans("ReceiptPrinterTemplateDesc")."<br><br>\n";
print '<table class="noborder" width="100%">'."\n";
print '<table class="noborder centpercent">'."\n";
print '<tr class="liste_titre">';
print '<th>'.$langs->trans("Name").'</th>';
print '<th>'.$langs->trans("Template").'</th>';
@@ -359,8 +399,7 @@ if ($mode == 'template' && $user->admin) {
setEventMessages($printer->error, $printer->errors, 'errors');
} else {
$max = count($printer->listprinterstemplates);
for ($line=0; $line < $max; $line++)
{
for ($line=0; $line < $max; $line++) {
print '<tr class="oddeven">';
if ($action=='edittemplate' && $printer->listprinterstemplates[$line]['rowid']==$templateid) {
print '<input type="hidden" name="templateid" value="'.$printer->listprinterstemplates[$line]['rowid'].'">';
@@ -368,21 +407,19 @@ if ($mode == 'template' && $user->admin) {
print '<td><textarea name="template" wrap="soft" cols="120" rows="12">'.$printer->listprinterstemplates[$line]['template'].'</textarea>';
print '</td>';
print '<td></td>';
print '<td></td>';
print '<td></td>';
} else {
print '<td>'.$printer->listprinterstemplates[$line]['name'].'</td>';
print '<td>'.nl2br(htmlentities($printer->listprinterstemplates[$line]['template'])).'</td>';
// edit icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=template&amp;action=edittemplate&amp;templateid='.$printer->listprinterstemplates[$line]['rowid'].'">';
print img_picto($langs->trans("Edit"), 'edit');
print '</a></td>';
print '</a>';
// delete icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=template&amp;action=deletetemplate&amp;templateid='.$printer->listprinterstemplates[$line]['rowid'].'&amp;templatename='.$printer->listprinterstemplates[$line]['name'].'">';
print '<a href="'.$_SERVER['PHP_SELF'].'?mode=template&amp;action=deletetemplate&amp;templateid='.$printer->listprinterstemplates[$line]['rowid'].'&amp;templatename='.$printer->listprinterstemplates[$line]['name'].'">';
print img_picto($langs->trans("Delete"), 'delete');
print '</a></td>';
print '</a>';
// test icon
print '<td><a href="'.$_SERVER['PHP_SELF'].'?mode=template&amp;action=testtemplate&amp;templateid='.$printer->listprinterstemplates[$line]['rowid'].'&amp;templatename='.$printer->listprinterstemplates[$line]['name'].'">';
print '<a href="'.$_SERVER['PHP_SELF'].'?mode=template&amp;action=testtemplate&amp;templateid='.$printer->listprinterstemplates[$line]['rowid'].'&amp;templatename='.$printer->listprinterstemplates[$line]['name'].'">';
print img_picto($langs->trans("TestPrinterTemplate"), 'printer');
print '</a></td>';
}
@@ -392,13 +429,19 @@ if ($mode == 'template' && $user->admin) {
print '</table>';
if ($action!='edittemplate') {
print '<input type="hidden" name="templateid" value="'.$printer->listprinterstemplates[$line]['rowid'].'">';
print '<td><input size="50" type="text" name="templatename" value="'.$printer->listprinterstemplates[$line]['name'].'"></td>';
print '<td><textarea name="template" wrap="soft" cols="120" rows="12">'.$printer->listprinterstemplates[$line]['template'].'</textarea>';
print '</td>';
print '<td></td>';
print '<div class="center"><input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Add")).'"></div>';
} else {
print '<div class="center"><input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Save")).'"></div>';
}
print '</form>';
print '<div><p></div>';
print '<table class="noborder" width="100%">'."\n";
print '<table class="noborder centpercent">'."\n";
print '<tr class="liste_titre">';
print '<th>'.$langs->trans("Tag").'</th>';
print '<th>'.$langs->trans("Description").'</th>';
@@ -414,18 +457,6 @@ if ($mode == 'template' && $user->admin) {
dol_fiche_end();
}
// to remove after test
// $object=new stdClass();
// $object->date_time = '2015-11-02 22:30:25';
// $object->id = 1234;
// $object->customer_firstname = 'John';
// $object->customer_lastname = 'Deuf';
// $object->vendor_firstname = 'Jim';
// $object->vendor_lastname = 'Big';
// $object->barcode = '3700123862396';
//$printer->sendToPrinter($object, 1, 16);
//setEventMessages($printer->error, $printer->errors, 'errors');
// End of page
llxFooter();
$db->close();

399
htdocs/core/class/dolreceiptprinter.class.php
View File

@@ -1,5 +1,5 @@
<?php
/* Copyright (C) 2015-2018 Frédéric France <frederic.france@free.fr>
/* Copyright (C) 2015-2019 Frédéric France <frederic.france@netlogic.fr>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -37,67 +37,83 @@
* <dol_underline_2dots> </dol_underline_2dots> Underline with double line
* <dol_emphasized> </dol_emphasized> Emphasized text
* <dol_switch_colors> </dol_switch_colors> Print in white on black
* <dol_print_barcode> Print barcode
* <dol_print_barcode_customer_id> Print barcode customer id
* <dol_set_print_width_57> Ticket print width of 57mm
* <dol_cut_paper_full> Cut ticket completely
* <dol_cut_paper_partial> Cut ticket partially
* <dol_open_drawer> Open cash drawer
* <dol_activate_buzzer> Activate buzzer
*
* Code which can be placed everywhere
* <dol_print_barcode> Print barcode
* <dol_print_qrcode> Print QR Code
* <dol_print_date> Print date AAAA-MM-DD
* <dol_print_date_time> Print date and time AAAA-MM-DD HH:MM:SS
* <dol_print_year> Print Year
* <dol_print_month_letters> Print month in letters (example : november)
* <dol_print_month> Print month number
* <dol_print_day> Print day number
* <dol_print_day_letters> Print day number
* <dol_print_table> Print table number (for restaurant, bar...)
* <dol_print_cutlery> Print number of cutlery (for restaurant)
* <dol_print_payment> Print payment method
* <dol_print_logo> Print logo stored on printer. Example : <print_logo>32|32
* <dol_print_logo_old> Print logo stored on printer. Must be followed by logo code. For old printers.
* <dol_print_order_lines> Print order lines
* <dol_print_order_tax> Print order total tax
* <dol_print_order_local_tax> Print order local tax
* <dol_print_order_total> Print order total
* <dol_print_order_number> Print order number
* <dol_print_order_number_unique> Print order number after validation
* <dol_print_customer_firstname> Print customer firstname
* <dol_print_customer_lastname> Print customer name
* <dol_print_customer_mail> Print customer mail
* <dol_print_customer_phone> Print customer phone
* <dol_print_customer_mobile> Print customer mobile
* <dol_print_customer_skype> Print customer skype
* <dol_print_customer_tax_number> Print customer VAT number
* <dol_print_customer_account_balance> Print customer account balance
* <dol_print_vendor_lastname> Print vendor name
* <dol_print_vendor_firstname> Print vendor firstname
* <dol_print_vendor_mail> Print vendor mail
* <dol_print_customer_points> Print customer points
* <dol_print_order_points> Print number of points for this order
* <dol_print_object_lines> Print object lines
* <dol_print_object_tax> Print object total tax
* <dol_print_object_local_tax> Print object local tax
* <dol_print_object_total> Print object total
* <dol_print_payment> Print payment method
*
* Conditional code at line start (if<69>then Print)
* <dol_print_if_customer> Print the line IF a customer is affected to the order
* <dol_print_if_vendor> Print the line IF a vendor is affected to the order
* Code which can be placed everywhere
* <dol_value_date> Replaced by date AAAA-MM-DD
* <dol_value_date_time> Replaced by date and time AAAA-MM-DD HH:MM:SS
* <dol_value_year> Replaced by Year
* <dol_value_month_letters> Replaced by month in letters (example : november)
* <dol_value_month> Replaced by month number
* <dol_value_day> Replaced by day number
* <dol_value_day_letters> Replaced by day number
* <dol_value_table> Replaced by table number (for restaurant, bar...)
* <dol_value_cutlery> Replaced by number of cutlery (for restaurant)
* <dol_object_id> Replaced by object id
* <dol_object_ref> Replaced by object ref
* <dol_value_customer_firstname> Replaced by customer firstname
* <dol_value_customer_lastname> Replaced by customer name
* <dol_value_customer_mail> Replaced by customer mail
* <dol_value_customer_phone> Replaced by customer phone
* <dol_value_customer_mobile> Replaced by customer mobile
* <dol_value_customer_skype> Replaced by customer skype
* <dol_value_customer_tax_number> Replaced by customer VAT number
* <dol_value_customer_account_balance> Replaced by customer account balance
* <dol_value_mysoc_name> Replaced by mysoc name
* <dol_value_mysoc_address> Replaced by mysoc address
* <dol_value_mysoc_zip> Replaced by mysoc zip
* <dol_value_mysoc_town> Replaced by mysoc town
* <dol_value_mysoc_country> Replaced by mysoc country
* <dol_value_mysoc_idprof1> Replaced by mysoc idprof1
* <dol_value_mysoc_idprof2> Replaced by mysoc idprof2
* <dol_value_mysoc_idprof3> Replaced by mysoc idprof3
* <dol_value_mysoc_idprof4> Replaced by mysoc idprof4
* <dol_value_mysoc_idprof5> Replaced by mysoc idprof5
* <dol_value_mysoc_idprof6> Replaced by mysoc idprof6
* <dol_value_vendor_lastname> Replaced by vendor name
* <dol_value_vendor_firstname> Replaced by vendor firstname
* <dol_value_vendor_mail> Replaced by vendor mail
* <dol_value_customer_points> Replaced by customer points
* <dol_value_object_points> Replaced by number of points for this object
*
* Conditional code at line start (if then Print)
* <dol_print_if_customer> Print the line IF a customer is affected to the object
* <dol_print_if_vendor> Print the line IF a vendor is affected to the object
* <dol_print_if_happy_hour> Print the line IF Happy Hour
* <dol_print_if_num_order_unique> Print the line IF order is validated
* <dol_print_if_num_object_unique> Print the line IF object is validated
* <dol_print_if_customer_points> Print the line IF customer points > 0
* <dol_print_if_order_points> Print the line IF points of the order > 0
* <dol_print_if_object_points> Print the line IF points of the object > 0
* <dol_print_if_customer_tax_number> Print the line IF customer has vat number
* <dol_print_if_customer_account_balance_positive> Print the line IF customer balance > 0
*
*/
require_once DOL_DOCUMENT_ROOT .'/includes/mike42/escpos-php/Escpos.php';
require_once DOL_DOCUMENT_ROOT .'/includes/mike42/escpos-php/autoload.php';
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\PrintConnectors\NetworkPrintConnector;
use Mike42\Escpos\PrintConnectors\WindowsPrintConnector;
use Mike42\Escpos\CapabilityProfile;
use Mike42\Escpos\Printer;
use Mike42\Escpos\EscposImage;
/**
* Class to manage Receipt Printers
*/
class dolReceiptPrinter extends Escpos
class dolReceiptPrinter extends Printer
{
const CONNECTOR_DUMMY = 1;
const CONNECTOR_FILE_PRINT = 2;
@@ -110,6 +126,9 @@ class dolReceiptPrinter extends Escpos
*/
public $db;
/*
* @var string[] array of tags
*/
public $tags;
public $printer;
public $template;
@@ -124,8 +143,6 @@ class dolReceiptPrinter extends Escpos
*/
public $errors = array();
/**
* Constructor
*
@@ -135,6 +152,8 @@ class dolReceiptPrinter extends Escpos
{
$this->db=$db;
$this->tags = array(
'dol_line_feed',
'dol_line_feed_reverse',
'dol_align_left',
'dol_align_center',
'dol_align_right',
@@ -155,51 +174,65 @@ class dolReceiptPrinter extends Escpos
'/dol_emphasized',
'dol_switch_colors',
'/dol_switch_colors',
'dol_print_barcode',
'dol_print_barcode_customer_id',
'dol_set_print_width_57',
'dol_cut_paper_full',
'dol_cut_paper_partial',
'dol_open_drawer',
'dol_activate_buzzer',
//'dol_activate_buzzer',
'dol_print_text',
'dol_print_qrcode',
'dol_print_date',
'dol_print_date_time',
'dol_print_year',
'dol_print_month_letters',
'dol_print_month',
'dol_print_day',
'dol_print_day_letters',
'dol_print_table',
'dol_print_cutlery',
'dol_print_barcode',
'dol_value_date',
'dol_value_date_time',
'dol_value_year',
'dol_value_month_letters',
'dol_value_month',
'dol_value_day',
'dol_value_day_letters',
'dol_value_table',
'dol_value_cutlery',
'dol_print_payment',
'dol_print_logo',
'dol_print_logo_old',
'dol_print_order_lines',
'dol_print_order_tax',
'dol_print_order_local_tax',
'dol_print_order_total',
'dol_print_order_number',
'dol_print_order_number_unique',
'dol_print_customer_firstname',
'dol_print_customer_lastname',
'dol_print_customer_mail',
'dol_print_customer_phone',
'dol_print_customer_mobile',
'dol_print_customer_skype',
'dol_print_customer_tax_number',
'dol_print_customer_account_balance',
'dol_print_vendor_lastname',
'dol_print_vendor_firstname',
'dol_print_vendor_mail',
'dol_print_customer_points',
'dol_print_order_points',
'dol_value_object_id',
'dol_value_object_ref',
'dol_print_object_lines',
'dol_print_object_tax',
'dol_print_object_local_tax',
'dol_print_object_total',
'dol_print_object_number',
'dol_value_customer_firstname',
'dol_value_customer_lastname',
'dol_value_customer_mail',
'dol_value_customer_phone',
'dol_value_customer_mobile',
'dol_value_customer_skype',
'dol_value_customer_tax_number',
'dol_value_customer_account_balance',
'dol_value_mysoc_name',
'dol_value_mysoc_address',
'dol_value_mysoc_zip',
'dol_value_mysoc_town',
'dol_value_mysoc_country',
'dol_value_mysoc_idprof1',
'dol_value_mysoc_idprof2',
'dol_value_mysoc_idprof3',
'dol_value_mysoc_idprof4',
'dol_value_mysoc_idprof5',
'dol_value_mysoc_idprof6',
'dol_value_mysoc_tva_intra',
'dol_value_mysoc_capital',
'dol_value_vendor_lastname',
'dol_value_vendor_firstname',
'dol_value_vendor_mail',
'dol_value_customer_points',
'dol_value_object_points',
'dol_print_if_customer',
'dol_print_if_vendor',
'dol_print_if_happy_hour',
'dol_print_if_num_order_unique',
'dol_print_if_num_object_unique',
'dol_print_if_customer_points',
'dol_print_if_order_points',
'dol_print_if_object_points',
'dol_print_if_customer_tax_number',
'dol_print_if_customer_account_balance_positive',
);
@@ -318,7 +351,7 @@ class dolReceiptPrinter extends Escpos
1 => $langs->trans('CONNECTOR_DUMMY'),
2 => $langs->trans('CONNECTOR_FILE_PRINT'),
3 => $langs->trans('CONNECTOR_NETWORK_PRINT'),
4 => $langs->trans('CONNECTOR_WINDOWS_PRINT')
4 => $langs->trans('CONNECTOR_WINDOWS_PRINT'),
);
$this->resprint = Form::selectarray($htmlname, $options, $selected);
@@ -343,7 +376,7 @@ class dolReceiptPrinter extends Escpos
1 => $langs->trans('PROFILE_SIMPLE'),
2 => $langs->trans('PROFILE_EPOSTEP'),
3 => $langs->trans('PROFILE_P822D'),
4 => $langs->trans('PROFILE_STAR')
4 => $langs->trans('PROFILE_STAR'),
);
$this->profileresprint = Form::selectarray($htmlname, $options, $selected);
@@ -423,6 +456,29 @@ class dolReceiptPrinter extends Escpos
return $error;
}
/**
* Function to add a printer template in db
*
* @param string $name Template name
* @param int $template Template
* @return int 0 if OK; >0 if KO
*/
public function addTemplate($name, $template)
{
global $conf;
$error = 0;
$sql = 'INSERT INTO '.MAIN_DB_PREFIX.'printer_receipt_template';
$sql.= ' (name, template, entity) VALUES ("'.$this->db->escape($name).'"';
$sql.= ', "'.$this->db->escape($template).'", '.$conf->entity.')';
$resql = $this->db->query($sql);
if (! $resql) {
$error++;
$this->errors[] = $this->db->lasterror;
}
return $error;
}
/**
* Function to Update a printer template in db
*
@@ -458,16 +514,18 @@ class dolReceiptPrinter extends Escpos
{
global $conf;
$error = 0;
$img = new EscposImage(DOL_DOCUMENT_ROOT .'/theme/common/dolibarr_logo_bw.png');
$img = EscposImage::load(DOL_DOCUMENT_ROOT .'/theme/common/dolibarr_logo_bw.png');
//$this->profile = CapabilityProfile::load("TM-T88IV");
$ret = $this->initPrinter($printerid);
if ($ret>0) {
setEventMessages($this->error, $this->errors, 'errors');
} else {
try {
$this->printer->graphics($img);
$this->printer->bitImage($img);
$this->printer->text("Hello World!\n");
$testStr = "Testing 123";
$this->printer->qrCode($testStr);
$testStr = "1234567890";
$this->printer->barcode($testStr);
//$this->printer->qrcode($testStr, Printer::QR_ECLEVEL_M, 5, Printer::QR_MODEL_1);
$this->printer->text("Most simple example\n");
$this->printer->feed();
$this->printer->cut();
@@ -491,34 +549,48 @@ class dolReceiptPrinter extends Escpos
*/
public function sendToPrinter($object, $templateid, $printerid)
{
global $conf;
global $conf, $mysoc, $langs;
$error = 0;
$ret = $this->loadTemplate($templateid);
// tags a remplacer par leur valeur avant de parser
$this->template = str_replace('<dol_print_num_order>', $object->id, $this->template);
$this->template = str_replace('<dol_print_customer_firstname>', $object->customer_firstname, $this->template);
$this->template = str_replace('<dol_print_customer_lastname>', $object->customer_lastname, $this->template);
$this->template = str_replace('<dol_print_customer_mail>', $object->customer_mail, $this->template);
$this->template = str_replace('<dol_print_customer_phone>', $object->customer_phone, $this->template);
$this->template = str_replace('<dol_print_customer_mobile>', $object->customer_mobile, $this->template);
$this->template = str_replace('<dol_print_customer_skype>', $object->customer_skype, $this->template);
$this->template = str_replace('<dol_print_customer_tax_number>', $object->customer_tax_number, $this->template);
$this->template = str_replace('<dol_print_customer_account_balance>', $object->customer_account_balance, $this->template);
$this->template = str_replace('<dol_print_customer_points>', $object->customer_points, $this->template);
$this->template = str_replace('<dol_print_order_points>', $object->order_points, $this->template);
$this->template = str_replace('<dol_print_vendor_firstname>', $object->vendor_firstname, $this->template);
$this->template = str_replace('<dol_print_vendor_lastname>', $object->vendor_lastname, $this->template);
$this->template = str_replace('<dol_print_vendor_mail>', $object->vendor_mail, $this->template);
$this->template = str_replace('<dol_print_date>', $object->date, $this->template);
$this->template = str_replace('<dol_print_date_time>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_year>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_month_letters>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_month>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_day>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_day_letters>', $object->date_time, $this->template);
$this->template = str_replace('<dol_print_table>', $object->table, $this->template);
$this->template = str_replace('<dol_print_cutlery>', $object->cutlery, $this->template);
// tags a remplacer par leur valeur avant de parser (dol_value_xxx)
$this->template = str_replace('<dol_value_object_id>', $object->id, $this->template);
$this->template = str_replace('<dol_value_object_ref>', $object->ref, $this->template);
$this->template = str_replace('<dol_value_object_points>', $object->points, $this->template);
$this->template = str_replace('<dol_value_customer_firstname>', $object->customer_firstname, $this->template);
$this->template = str_replace('<dol_value_customer_lastname>', $object->customer_lastname, $this->template);
$this->template = str_replace('<dol_value_customer_mail>', $object->customer_mail, $this->template);
$this->template = str_replace('<dol_value_customer_phone>', $object->customer_phone, $this->template);
$this->template = str_replace('<dol_value_customer_mobile>', $object->customer_mobile, $this->template);
$this->template = str_replace('<dol_value_customer_skype>', $object->customer_skype, $this->template);
$this->template = str_replace('<dol_value_customer_tax_number>', $object->customer_tax_number, $this->template);
$this->template = str_replace('<dol_value_customer_account_balance>', $object->customer_account_balance, $this->template);
$this->template = str_replace('<dol_value_customer_points>', $object->customer_points, $this->template);
$this->template = str_replace('<dol_value_mysoc_name>', $mysoc->name, $this->template);
$this->template = str_replace('<dol_value_mysoc_address>', $mysoc->address, $this->template);
$this->template = str_replace('<dol_value_mysoc_zip>', $mysoc->zip, $this->template);
$this->template = str_replace('<dol_value_mysoc_town>', $mysoc->town, $this->template);
$this->template = str_replace('<dol_value_mysoc_country>', $mysoc->country, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof1>', $mysoc->idprof1, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof2>', $mysoc->idprof2, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof3>', $mysoc->idprof3, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof4>', $mysoc->idprof4, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof5>', $mysoc->idprof5, $this->template);
$this->template = str_replace('<dol_value_mysoc_idprof6>', $mysoc->idprof6, $this->template);
$this->template = str_replace('<dol_value_mysoc_tva_intra>', $mysoc->tva_intra, $this->template);
$this->template = str_replace('<dol_value_mysoc_capital>', $mysoc->capital, $this->template);
$this->template = str_replace('<dol_value_vendor_firstname>', $object->vendor_firstname, $this->template);
$this->template = str_replace('<dol_value_vendor_lastname>', $object->vendor_lastname, $this->template);
$this->template = str_replace('<dol_value_vendor_mail>', $object->vendor_mail, $this->template);
$this->template = str_replace('<dol_value_date>', $object->date, $this->template);
$this->template = str_replace('<dol_value_date_time>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_year>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_month_letters>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_month>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_day>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_day_letters>', $object->date_time, $this->template);
$this->template = str_replace('<dol_value_table>', $object->table, $this->template);
$this->template = str_replace('<dol_value_cutlery>', $object->cutlery, $this->template);
// parse template
$p = xml_parser_create();
@@ -528,78 +600,119 @@ class dolReceiptPrinter extends Escpos
//print '<pre>'.print_r($vals, true).'</pre>';
// print ticket
$level = 0;
$html = '<table border="1" style="width:210px"><pre>';
$nbcharactbyline = 48;
$ret = $this->initPrinter($printerid);
if ($ret>0) {
setEventMessages($this->error, $this->errors, 'errors');
} else {
$nboflines = count($vals);
for ($line=0; $line < $nboflines; $line++) {
switch ($vals[$line]['tag']) {
for ($tplline=0; $tplline < $nboflines; $tplline++) {
//var_dump($vals[$tplline]['value']);
switch ($vals[$tplline]['tag']) {
case 'DOL_PRINT_TEXT':
$this->printer->text($vals[$tplline]['value']);
break;
case 'DOL_PRINT_OBJECT_LINES':
foreach ($object->lines as $line) {
//var_dump($line);
$spacestoadd = $nbcharactbyline - strlen($line->ref)- strlen($line->qty) - 10 - 1;
$spaces = str_repeat(' ', $spacestoadd);
$this->printer->text($line->ref.$spaces.$line->qty.' '.str_pad(price($line->total_ttc), 10, ' ', STR_PAD_LEFT)."\n");
$this->printer->text(strip_tags(htmlspecialchars_decode($line->desc))."\n");
}
break;
case 'DOL_PRINT_OBJECT_TAX':
//var_dump($object);
$vatarray = array();
foreach ($object->lines as $line) {
$vatarray[$line->tva_tx] += $line->total_tva;
}
foreach($vatarray as $vatkey => $vatvalue) {
$spacestoadd = $nbcharactbyline - strlen($vatkey)- 12;
$spaces = str_repeat(' ', $spacestoadd);
$this->printer->text($spaces. $vatkey.'% '.str_pad(price($vatvalue), 10, ' ', STR_PAD_LEFT)."\n");
}
break;
case 'DOL_PRINT_OBJECT_TOTAL':
$title = $langs->trans('TotalHT');
$spacestoadd = $nbcharactbyline - strlen($title) - 10;
$spaces = str_repeat(' ', $spacestoadd);
$this->printer->text($title.$spaces.str_pad(price($object->total_ht), 10, ' ', STR_PAD_LEFT)."\n");
$title = $langs->trans('TotalVAT');
$spacestoadd = $nbcharactbyline - strlen($title) - 10;
$spaces = str_repeat(' ', $spacestoadd);
$this->printer->text($title.$spaces.str_pad(price($object->total_tva), 10, ' ', STR_PAD_LEFT)."\n");
$title = $langs->trans('TotalTTC');
$spacestoadd = $nbcharactbyline - strlen($title) - 10;
$spaces = str_repeat(' ', $spacestoadd);
$this->printer->text($title.$spaces.str_pad(price($object->total_ttc), 10, ' ', STR_PAD_LEFT)."\n");
break;
case 'DOL_LINE_FEED':
$this->printer->feed();
break;
case 'DOL_LINE_FEED_REVERSE':
$this->printer->feedReverse();
break;
case 'DOL_ALIGN_CENTER':
$this->printer->setJustification(Escpos::JUSTIFY_CENTER);
$html.='<center>';
$this->printer->text($vals[$line]['value']);
$this->printer->setJustification(Printer::JUSTIFY_CENTER);
break;
case 'DOL_ALIGN_RIGHT':
$this->printer->setJustification(Escpos::JUSTIFY_RIGHT);
$html.='<right>';
$this->printer->setJustification(Printer::JUSTIFY_RIGHT);
break;
case 'DOL_ALIGN_LEFT':
$this->printer->setJustification(Escpos::JUSTIFY_LEFT);
$html.='<left>';
$this->printer->setJustification(Printer::JUSTIFY_LEFT);
break;
case 'DOL_OPEN_DRAWER':
$this->printer->pulse();
$html.= ' &#991;'.nl2br($vals[$line]['value']);
break;
case 'DOL_ACTIVATE_BUZZER':
//$this->printer->buzzer();
$html.= ' &#x266b;'.nl2br($vals[$line]['value']);
break;
case 'DOL_PRINT_BARCODE':
// $vals[$line]['value'] -> barcode($content, $type)
$this->printer->barcode($object->barcode);
// $vals[$tplline]['value'] -> barcode($content, $type)
// var_dump($vals[$tplline]['value']);
try {
$this->printer->barcode($vals[$tplline]['value']);
} catch (Exception $e) {
$this->errors[] = 'Invalid Barcode value: '.$vals[$tplline]['value'];
$error++;
}
break;
case 'DOL_PRINT_BARCODE_CUSTOMER_ID':
// $vals[$line]['value'] -> barcode($content, $type)
$this->printer->barcode($object->customer_id);
case 'DOL_PRINT_LOGO':
$img = EscposImage::load(DOL_DATA_ROOT .'/mycompany/logos/'.$mysoc->logo);
$this->printer->graphics($img);
break;
case 'DOL_PRINT_LOGO_OLD':
$img = EscposImage::load(DOL_DATA_ROOT .'/mycompany/logos/'.$mysoc->logo);
$this->printer->bitImage($img);
break;
case 'DOL_PRINT_QRCODE':
// $vals[$line]['value'] -> qrCode($content, $ec, $size, $model)
$this->printer->qrcode($vals[$line]['value']);
$html.='QRCODE: '.$vals[$line]['value'];
// $vals[$tplline]['value'] -> qrCode($content, $ec, $size, $model)
$this->printer->qrcode($vals[$tplline]['value']);
break;
case 'DOL_CUT_PAPER_FULL':
$this->printer->cut(Escpos::CUT_FULL);
$html.= ' &#9986;'.nl2br($vals[$line]['value']);
$this->printer->cut(Printer::CUT_FULL);
break;
case 'DOL_CUT_PAPER_PARTIAL':
$this->printer->cut(Escpos::CUT_PARTIAL);
$html.= ' &#9986;'.nl2br($vals[$line]['value']);
$this->printer->cut(Printer::CUT_PARTIAL);
break;
case 'DOL_USE_FONT_A':
$this->printer->setFont(Escpos::FONT_A);
$this->printer->text($vals[$line]['value']);
$this->printer->setFont(Printer::FONT_A);
break;
case 'DOL_USE_FONT_B':
$this->printer->setFont(Escpos::FONT_B);
$this->printer->text($vals[$line]['value']);
$this->printer->setFont(Printer::FONT_B);
break;
case 'DOL_USE_FONT_C':
$this->printer->setFont(Escpos::FONT_C);
$this->printer->text($vals[$line]['value']);
$this->printer->setFont(Printer::FONT_C);
break;
default:
$this->printer->text($vals[$line]['value']);
$html.= nl2br($vals[$line]['value']);
$this->errors[] = 'UnknowTag: &lt;'.strtolower($vals[$line]['tag']).'&gt;';
$this->printer->text($vals[$tplline]['tag']);
$this->printer->text($vals[$tplline]['value']);
$this->errors[] = 'UnknowTag: &lt;'.strtolower($vals[$tplline]['tag']).'&gt;';
$error++;
break;
}
}
$html.= '</pre></table>';
print $html;
// Close and print
// uncomment next line to see content sent to printer
//print '<pre>'.print_r($this->connector, true).'</pre>';
@@ -687,7 +800,7 @@ class dolReceiptPrinter extends Escpos
$this->connector = 'CONNECTOR_UNKNOWN';
break;
}
$this->printer = new Escpos($this->connector);
$this->printer = new Printer($this->connector, $this->profile);
} catch (Exception $e) {
$this->errors[] = $e->getMessage();
$error++;

4
htdocs/includes/mike42/escpos-php/.coveralls.yml Normal file
View File

@@ -0,0 +1,4 @@
service_name: travis-ci
coverage_clover: build/logs/clover.xml
json_path: build/logs/coveralls-upload.json

4
htdocs/includes/mike42/escpos-php/.gitignore vendored
View File

@@ -10,3 +10,7 @@ doc/doxygen_sqlite3.db
# composer files
vendor/
# other build files
build/*
*.phar

46
htdocs/includes/mike42/escpos-php/.travis.yml Normal file
View File

@@ -0,0 +1,46 @@
---
dist: trusty
sudo: required
language: php
php:
- 5.4
- 5.5
- 5.6
- 7.0
- 7.1
- 7.2
- nightly
- hhvm-3.21
- hhvm-nightly
matrix:
allow_failures:
- php: nightly
- php: hhvm-nightly
before_install:
- sudo apt-get -qq update
- sudo apt-get install -y imagemagick ghostscript
install:
- composer install
before_script:
# Install 'imagick' plugin
- bash -c 'if [[ $TRAVIS_PHP_VERSION != hhvm* ]]; then printf "\n" | pecl install imagick; fi'
# Directory for coverage report
- mkdir -p build/logs/
script:
# Check code style
- php vendor/bin/phpcs --standard=psr2 src/ -n
# Run tests
- php vendor/bin/phpunit --coverage-clover build/logs/clover.xml
after_success:
# Upload coverage statistics to coveralls service after test
- wget -c -nc https://github.com/satooshi/php-coveralls/releases/download/v1.0.1/coveralls.phar
- php coveralls.phar -v
...

65
htdocs/includes/mike42/escpos-php/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,65 @@
# How to contribute
This project is open to many different types of contribution. You can help with improving the documentation and examples, sharing your insights on the issue tracker, adding fixes to the code, providing test cases, or just [writing about your hardware setup that you use](https://github.com/mike42/escpos-php/issues/new).
## Issue tracker
Open issues of all sorts are tracked on the [issue tracker](https://github.com/mike42/escpos-php/issues). Please check [the FAQ](https://github.com/mike42/escpos-php/blob/development/doc/FAQ.md) before you post, and practice good [bug tracker etiquette](https://bugzilla.mozilla.org/page.cgi?id=etiquette.html) to keep it running smoothly.
Issues are [loosely categorised](https://github.com/mike42/escpos-php/labels), and will stay open while there is still something that can be resolved.
Anybody may add to the discussion on the bug tracker. Just be sure to add new questions as separate issues, and to avoid commenting on closed issues.
## Submitting changes
Code changes may be submitted as a "[pull request](https://help.github.com/articles/about-pull-requests/)" at [mike42/escpos-php](https://github.com/mike42/escpos-php). The description should include some information about how the change improves the library.
The project is MIT-licensed (see [LICENSE.md](https://github.com/mike42/escpos-php/blob/development/LICENSE.md) for details). You are not required to assign copyright in order to submit changes, but you do need to agree for your code to be distributed under this license in order for it to be accepted.
### Documentation changes
The official documentaton is also located in the main repository, under the [doc/](https://github.com/mike42/escpos-php/tree/development/doc) folder.
You are welcome to post any suggested improvements as pull requests.
### Release process
Once a pull request is accepted, it usually appears in a release a few days later.
Branches:
- "development" is the most recent code, possibly containing unreleased fixes
- "master" contains the most recently released code (old versions are not maintained).
The release process for your changes is:
- Changes are submitted via pull request to the shared "development" branch.
- A new release is staged on the "master" branch via another pull request, and then tagged.
## Code style
This project uses the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) for all PHP source code.
## Testing and CI
The tests are executed on [Travis CI](https://travis-ci.org/mike42/escpos-php) over PHP 5.4, 5.5, 5.6, 7.0, 7.1 and 7.2, plus the latest LTS version of HHVM, 3.21. Older versions of PHP are not supported in current releases.
For development, it's suggested that you load `imagick`, `gd` and `Xdebug` PHP exensions, and install `composer`.
Fetch a copy of this code and load dependencies with composer:
git clone https://github.com/mike42/escpos-php
cd escpos-php/
composer install
Execute unit tests via `phpunit`:
php vendor/bin/phpunit --coverage-text
Code style can be checked via [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer):
php vendor/bin/phpcs --standard=psr2 src/ -n
The developer docs are built with [doxygen](https://github.com/doxygen/doxygen). Re-build them to check for documentation warnings:
make -C doc clean && make -C doc

25
htdocs/includes/mike42/escpos-php/CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,25 @@
# escpos-php contributors
This file contains a list of people who have made contributions of
code which appear in the public repository of escpos-php.
Main repository: [mike42/escpos-php](https://github.com/mike42/escpos-php) ([online contributor list](https://github.com/mike42/escpos-php/graphs/contributors))
- [Michael Billington](https://github.com/mike42)
- [Alif Maulana El Fattah Nataly](https://github.com/alif25r)
- [Mareks Sudniks](https://github.com/marech)
- [matiasgaston](https://github.com/matiasgaston)
- [Mike Stivala](https://github.com/brndwgn)
- [Nicholas Long](https://github.com/longsview)
- [Evandro Araújo](https://github.com/evsar3)
Via fork: [wdoyle/EpsonESCPOS-PHP](https://github.com/wdoyle/EpsonESCPOS-PHP):
- [Warren Doyle](https://github.com/wdoyle)
Via fork: [ronisaha/php-esc-pos](https://github.com/ronisaha/php-esc-pos):
- [Roni Saha](https://github.com/ronisaha)
- [Gergely Radics](https://github.com/Gerifield)
- [vharo](https://github.com/vharo)

853
htdocs/includes/mike42/escpos-php/Escpos.php
View File

@@ -1,853 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This class generates ESC/POS printer control commands for compatible printers.
* See README.md for a summary of compatible printers and supported commands, and
* basic usage.
*
* See example/demo.php for a detailed print-out demonstrating the range of commands
* implemented in this project.
*
* Note that some functions have not been implemented:
* - Set paper sensors
* - Select print colour
*
* Please direct feature requests, bug reports and contributions to escpos-php
* on Github:
* - https://github.com/mike42/escpos-php
*/
require_once(dirname(__FILE__) . "/src/EscposImage.php");
require_once(dirname(__FILE__) . "/src/PrintBuffer.php");
require_once(dirname(__FILE__) . "/src/EscposPrintBuffer.php");
require_once(dirname(__FILE__) . "/src/PrintConnector.php");
require_once(dirname(__FILE__) . "/src/WindowsPrintConnector.php");
require_once(dirname(__FILE__) . "/src/FilePrintConnector.php");
require_once(dirname(__FILE__) . "/src/NetworkPrintConnector.php");
require_once(dirname(__FILE__) . "/src/AbstractCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/DefaultCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/SimpleCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/EposTepCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/StarCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/P822DCapabilityProfile.php");
require_once(dirname(__FILE__) . "/src/CodePage.php");
require_once(dirname(__FILE__) . "/src/ImagePrintBuffer.php");
class Escpos {
/* ASCII codes */
const NUL = "\x00";
const LF = "\x0a";
const ESC = "\x1b";
const FS = "\x1c";
const FF = "\x0c";
const GS = "\x1d";
const DLE = "\x10";
const EOT = "\x04";
/* Barcode types */
const BARCODE_UPCA = 65;
const BARCODE_UPCE = 66;
const BARCODE_JAN13 = 67;
const BARCODE_JAN8 = 68;
const BARCODE_CODE39 = 69;
const BARCODE_ITF = 70;
const BARCODE_CODABAR = 71;
const BARCODE_CODE93 = 72;
const BARCODE_CODE128 = 73;
/* Barcode HRI (human-readable interpretation) text position */
const BARCODE_TEXT_NONE = 0;
const BARCODE_TEXT_ABOVE = 1;
const BARCODE_TEXT_BELOW = 2;
/* Cut types */
const CUT_FULL = 65;
const CUT_PARTIAL = 66;
/* Fonts */
const FONT_A = 0;
const FONT_B = 1;
const FONT_C = 2;
/* Image sizing options */
const IMG_DEFAULT = 0;
const IMG_DOUBLE_WIDTH = 1;
const IMG_DOUBLE_HEIGHT = 2;
/* Justifications */
const JUSTIFY_LEFT = 0;
const JUSTIFY_CENTER = 1;
const JUSTIFY_RIGHT = 2;
/* Print mode constants */
const MODE_FONT_A = 0;
const MODE_FONT_B = 1;
const MODE_EMPHASIZED = 8;
const MODE_DOUBLE_HEIGHT = 16;
const MODE_DOUBLE_WIDTH = 32;
const MODE_UNDERLINE = 128;
/* QR code error correction levels */
const QR_ECLEVEL_L = 0;
const QR_ECLEVEL_M = 1;
const QR_ECLEVEL_Q = 2;
const QR_ECLEVEL_H = 3;
/* QR code models */
const QR_MODEL_1 = 1;
const QR_MODEL_2 = 2;
const QR_MICRO = 3;
/* Printer statuses */
const STATUS_PRINTER = 1;
const STATUS_OFFLINE_CAUSE = 2;
const STATUS_ERROR_CAUSE = 3;
const STATUS_PAPER_ROLL = 4;
const STATUS_INK_A = 7;
const STATUS_INK_B = 6;
const STATUS_PEELER = 8;
/* Underline */
const UNDERLINE_NONE = 0;
const UNDERLINE_SINGLE = 1;
const UNDERLINE_DOUBLE = 2;
/**
* @var PrintBuffer The printer's output buffer.
*/
private $buffer;
/**
* @var PrintConnector
* @CHANGE
*/
protected $connector;
// private $connector;
/**
* @var AbstractCapabilityProfile
*/
private $profile;
/**
* @var int Current character code table
*/
private $characterTable;
/**
* Construct a new print object
*
* @param PrintConnector $connector The PrintConnector to send data to. If not set, output is sent to standard output.
* @param AbstractCapabilityProfile $profile Supported features of this printer. If not set, the DefaultCapabilityProfile will be used, which is suitable for Epson printers.
* @throws InvalidArgumentException
*/
function __construct(PrintConnector $connector = null, AbstractCapabilityProfile $profile = null) {
if(is_null($connector)) {
if(php_sapi_name() == 'cli') {
$connector = new FilePrintConnector("php://stdout");
} else {
throw new InvalidArgumentException("Argument passed to Escpos::__construct() must implement interface PrintConnector, null given.");
}
}
/* Set connector */
$this -> connector = $connector;
/* Set capability profile */
if($profile === null) {
$profile = DefaultCapabilityProfile::getInstance();
}
$this -> profile = $profile;
/* Set buffer */
$buffer = new EscposPrintBuffer();
$this -> buffer = null;
$this -> setPrintBuffer($buffer);
$this -> initialize();
}
/**
* Print a barcode.
*
* @param string $content The information to encode.
* @param int $type The barcode standard to output. If not specified, `Escpos::BARCODE_CODE39` will be used. Note that some barcode formats only support specific lengths or sets of characters.
* @throws InvalidArgumentException Where the length or characters used in $content is invalid for the requested barcode format.
*/
function barcode($content, $type = self::BARCODE_CODE39) {
/* Validate input */
self::validateInteger($type, 65, 73, __FUNCTION__, "Barcode type");
$len = strlen($content);
switch($type) {
case self::BARCODE_UPCA:
self::validateInteger($len, 11, 12, __FUNCTION__, "UPCA barcode content length");
self::validateStringRegex($content, __FUNCTION__, "/^[0-9]{11,12}$/", "UPCA barcode content");
break;
case self::BARCODE_UPCE:
self::validateIntegerMulti($len, array(array(6, 8), array(11, 12)), __FUNCTION__, "UPCE barcode content length");
self::validateStringRegex($content, __FUNCTION__, "/^([0-9]{6,8}|[0-9]{11,12})$/", "UPCE barcode content");
break;
case self::BARCODE_JAN13:
self::validateInteger($len, 12, 13, __FUNCTION__, "JAN13 barcode content length");
self::validateStringRegex($content, __FUNCTION__, "/^[0-9]{12,13}$/", "JAN13 barcode content");
break;
case self::BARCODE_JAN8:
self::validateInteger($len, 7, 8, __FUNCTION__, "JAN8 barcode content length");
self::validateStringRegex($content, __FUNCTION__, "/^[0-9]{7,8}$/", "JAN8 barcode content");
break;
case self::BARCODE_CODE39:
self::validateInteger($len, 1, 255, __FUNCTION__, "CODE39 barcode content length"); // 255 is a limitation of the "function b" command, not the barcode format.
self::validateStringRegex($content, __FUNCTION__, "/^([0-9A-Z \$\%\+\-\.\/]+|\*[0-9A-Z \$\%\+\-\.\/]+\*)$/", "CODE39 barcode content");
break;
case self::BARCODE_ITF:
self::validateInteger($len, 2, 255, __FUNCTION__, "ITF barcode content length"); // 255 is a limitation of the "function b" command, not the barcode format.
self::validateStringRegex($content, __FUNCTION__, "/^([0-9]{2})+$/", "ITF barcode content");
break;
case self::BARCODE_CODABAR:
self::validateInteger($len, 1, 255, __FUNCTION__, "Codabar barcode content length"); // 255 is a limitation of the "function b" command, not the barcode format.
self::validateStringRegex($content, __FUNCTION__, "/^[A-Da-d][0-9\$\+\-\.\/\:]+[A-Da-d]$/", "Codabar barcode content");
break;
case self::BARCODE_CODE93:
self::validateInteger($len, 1, 255, __FUNCTION__, "Code93 barcode content length"); // 255 is a limitation of the "function b" command, not the barcode format.
self::validateStringRegex($content, __FUNCTION__, "/^[\\x00-\\x7F]+$/", "Code93 barcode content");
break;
case self::BARCODE_CODE128:
self::validateInteger($len, 1, 255, __FUNCTION__, "Code128 barcode content length"); // 255 is a limitation of the "function b" command, not the barcode format.
// The CODE128 encoder is quite complex, so only a very basic header-check is applied here.
self::validateStringRegex($content, __FUNCTION__, "/^\{[A-C][\\x00-\\x7F]+$/", "Code128 barcode content");
break;
}
if(!$this -> profile -> getSupportsBarcodeB()) {
// A simpler barcode command which supports fewer codes
self::validateInteger($type, 65, 71, __FUNCTION__);
$this -> connector -> write(self::GS . "k" . chr($type - 65) . $content . self::NUL);
return;
}
// More advanced function B, used in preference
$this -> connector -> write(self::GS . "k" . chr($type) . chr(strlen($content)) . $content);
}
/**
* Print an image, using the older "bit image" command. This creates padding on the right of the image,
* if its width is not divisible by 8.
*
* Should only be used if your printer does not support the graphics() command.
*
* @param EscposImage $img The image to print
* @param EscposImage $size Size modifier for the image.
*/
function bitImage(EscposImage $img, $size = self::IMG_DEFAULT) {
self::validateInteger($size, 0, 3, __FUNCTION__);
$header = self::dataHeader(array($img -> getWidthBytes(), $img -> getHeight()), true);
$this -> connector -> write(self::GS . "v0" . chr($size) . $header);
$this -> connector -> write($img -> toRasterFormat());
}
/**
* Close the underlying buffer. With some connectors, the
* job will not actually be sent to the printer until this is called.
*/
function close() {
$this -> connector -> finalize();
}
/**
* Cut the paper.
*
* @param int $mode Cut mode, either Escpos::CUT_FULL or Escpos::CUT_PARTIAL. If not specified, `Escpos::CUT_FULL` will be used.
* @param int $lines Number of lines to feed
*/
function cut($mode = self::CUT_FULL, $lines = 3) {
// TODO validation on cut() inputs
$this -> connector -> write(self::GS . "V" . chr($mode) . chr($lines));
}
/**
* Print and feed line / Print and feed n lines.
*
* @param int $lines Number of lines to feed
*/
function feed($lines = 1) {
self::validateInteger($lines, 1, 255, __FUNCTION__);
if($lines <= 1) {
$this -> connector -> write(self::LF);
} else {
$this -> connector -> write(self::ESC . "d" . chr($lines));
}
}
/**
* Some printers require a form feed to release the paper. On most printers, this
* command is only useful in page mode, which is not implemented in this driver.
*/
function feedForm() {
$this -> connector -> write(self::FF);
}
/**
* Print and reverse feed n lines.
*
* @param int $lines number of lines to feed. If not specified, 1 line will be fed.
*/
function feedReverse($lines = 1) {
self::validateInteger($lines, 1, 255, __FUNCTION__);
$this -> connector -> write(self::ESC . "e" . chr($lines));
}
/**
* @return number
*/
function getCharacterTable() {
return $this -> characterTable;
}
/**
* @return PrintBuffer
*/
function getPrintBuffer() {
return $this -> buffer;
}
/**
* @return PrintConnector
*/
function getPrintConnector() {
return $this -> connector;
}
/**
* @return AbstractCapabilityProfile
*/
function getPrinterCapabilityProfile() {
return $this -> profile;
}
/**
* @param int $type The type of status to request
* @return stdClass Class containing requested status, or null if either no status was received, or your print connector is unable to read from the printer.
*/
function getPrinterStatus($type = self::STATUS_PRINTER) {
self::validateIntegerMulti($type, array(array(1, 4), array(6, 8)), __FUNCTION__);
// Determine which flags we are looking for
$statusFlags = array(
self::STATUS_PRINTER => array(
4 => "pulseHigh", // connector pin 3, see pulse().
8 => "offline",
32 => "waitingForOnlineRecovery",
64 => "feedButtonPressed"
),
self::STATUS_OFFLINE_CAUSE => array(
4 => "coverOpen",
8 => "paperManualFeed",
32 => "paperEnd",
64 => "errorOccurred"
),
self::STATUS_ERROR_CAUSE => array(
4 => "recoverableError",
8 => "autocutterError",
32 => "unrecoverableError",
64 => "autorecoverableError"
),
self::STATUS_PAPER_ROLL => array(
4 => "paperNearEnd",
32 => "paperNotPresent"
),
self::STATUS_INK_A => array(
4 => "inkNearEnd",
8 => "inkEnd",
32 => "inkNotPresent",
64 => "cleaning"
),
self::STATUS_INK_B => array(
4 => "inkNearEnd",
8 => "inkEnd",
32 => "inkNotPresent"
),
self::STATUS_PEELER => array(
4 => "labelWaitingForRemoval",
32 => "labelPaperNotDetected"
)
);
$flags = $statusFlags[$type];
// Clear any previous statuses which haven't been read yet
$f = $this -> connector -> read(1);
// Make request
$reqC = chr($type);
switch($type) {
// Special cases: These are two-character requests
case self::STATUS_INK_A:
$reqC = chr(7) . chr(1);
break;
case self::STATUS_INK_B:
$reqC = chr(7) . chr(2);
break;
case self::STATUS_PEELER:
$reqC = chr(8) . chr(3);
break;
}
$this -> connector -> write(self::DLE . self::EOT . $reqC);
// Wait for single-character response
$f = $this -> connector -> read(1);
$i = 0;
while($f === false && $i < 50000) {
usleep(100);
$f = $this -> connector -> read(1);
$i++;
}
if($f === false) {
// Timeout
return null;
}
$ret = new stdClass();
foreach($flags as $num => $name) {
$ret -> $name = (ord($f) & $num) != 0;
}
return $ret;
}
/**
* Print an image to the printer.
*
* Size modifiers are:
* - IMG_DEFAULT (leave image at original size)
* - IMG_DOUBLE_WIDTH
* - IMG_DOUBLE_HEIGHT
*
* See the example/ folder for detailed examples.
*
* The function bitImage() takes the same parameters, and can be used if
* your printer doesn't support the newer graphics commands.
*
* @param EscposImage $img The image to print.
* @param int $size Output size modifier for the image.
*/
function graphics(EscposImage $img, $size = self::IMG_DEFAULT) {
self::validateInteger($size, 0, 3, __FUNCTION__);
$imgHeader = self::dataHeader(array($img -> getWidth(), $img -> getHeight()), true);
$tone = '0';
$colors = '1';
$xm = (($size & self::IMG_DOUBLE_WIDTH) == self::IMG_DOUBLE_WIDTH) ? chr(2) : chr(1);
$ym = (($size & self::IMG_DOUBLE_HEIGHT) == self::IMG_DOUBLE_HEIGHT) ? chr(2) : chr(1);
$header = $tone . $xm . $ym . $colors . $imgHeader;
$this -> wrapperSendGraphicsData('0', 'p', $header . $img -> toRasterFormat());
$this -> wrapperSendGraphicsData('0', '2');
}
/**
* Initialize printer. This resets formatting back to the defaults.
*/
function initialize() {
$this -> connector -> write(self::ESC . "@");
$this -> characterTable = 0;
}
/**
* Generate a pulse, for opening a cash drawer if one is connected.
* The default settings should open an Epson drawer.
*
* @param int $pin 0 or 1, for pin 2 or pin 5 kick-out connector respectively.
* @param int $on_ms pulse ON time, in milliseconds.
* @param int $off_ms pulse OFF time, in milliseconds.
*/
function pulse($pin = 0, $on_ms = 120, $off_ms = 240) {
self::validateInteger($pin, 0, 1, __FUNCTION__);
self::validateInteger($on_ms, 1, 511, __FUNCTION__);
self::validateInteger($off_ms, 1, 511, __FUNCTION__);
$this -> connector -> write(self::ESC . "p" . chr($pin + 48) . chr($on_ms / 2) . chr($off_ms / 2));
}
/**
* Print the given data as a QR code on the printer.
*
* @param string $content The content of the code. Numeric data will be more efficiently compacted.
* @param int $ec Error-correction level to use. One of Escpos::QR_ECLEVEL_L (default), Escpos::QR_ECLEVEL_M, Escpos::QR_ECLEVEL_Q or Escpos::QR_ECLEVEL_H. Higher error correction results in a less compact code.
* @param int $size Pixel size to use. Must be 1-16 (default 3)
* @param int $model QR code model to use. Must be one of Escpos::QR_MODEL_1, Escpos::QR_MODEL_2 (default) or Escpos::QR_MICRO (not supported by all printers).
*/
function qrCode($content, $ec = self::QR_ECLEVEL_L, $size = 3, $model = self::QR_MODEL_2) {
self::validateString($content, __FUNCTION__);
self::validateInteger($ec, 0, 3, __FUNCTION__);
self::validateInteger($size, 1, 16, __FUNCTION__);
self::validateInteger($model, 1, 3, __FUNCTION__);
if($content == "") {
return;
}
if(!$this -> profile -> getSupportsQrCode()) {
// TODO use software rendering via phpqrcode instead
throw new Exception("QR codes are not supported on your printer.");
}
$cn = '1'; // Code type for QR code
// Select model: 1, 2 or micro.
$this -> wrapperSend2dCodeData(chr(65), $cn, chr(48 + $model) . chr(0));
// Set dot size.
$this -> wrapperSend2dCodeData(chr(67), $cn, chr($size));
// Set error correction level: L, M, Q, or H
$this -> wrapperSend2dCodeData(chr(69), $cn, chr(48 + $ec));
// Send content & print
$this -> wrapperSend2dCodeData(chr(80), $cn, $content, '0');
$this -> wrapperSend2dCodeData(chr(81), $cn, '', '0');
}
/**
* Switch character table (code page) manually. Used in conjunction with textRaw() to
* print special characters which can't be encoded automatically.
*
* @param int $table The table to select. Available code tables are model-specific.
*/
function selectCharacterTable($table = 0) {
self::validateInteger($table, 0, 255, __FUNCTION__);
$supported = $this -> profile -> getSupportedCodePages();
if(!isset($supported[$table])) {
throw new InvalidArgumentException("There is no code table $table allowed by this printer's capability profile.");
}
$this -> characterTable = $table;
if($this -> profile -> getSupportsStarCommands()) {
/* Not an ESC/POS command: STAR printers stash all the extra code pages under a different command. */
$this -> connector -> write(self::ESC . self::GS . "t" . chr($table));
return;
}
$this -> connector -> write(self::ESC . "t" . chr($table));
}
/**
* Select print mode(s).
*
* Several MODE_* constants can be OR'd together passed to this function's `$mode` argument. The valid modes are:
* - MODE_FONT_A
* - MODE_FONT_B
* - MODE_EMPHASIZED
* - MODE_DOUBLE_HEIGHT
* - MODE_DOUBLE_WIDTH
* - MODE_UNDERLINE
*
* @param int $mode The mode to use. Default is Escpos::MODE_FONT_A, with no special formatting. This has a similar effect to running initialize().
*/
function selectPrintMode($mode = self::MODE_FONT_A) {
$allModes = self::MODE_FONT_B | self::MODE_EMPHASIZED | self::MODE_DOUBLE_HEIGHT | self::MODE_DOUBLE_WIDTH | self::MODE_UNDERLINE;
if(!is_integer($mode) || $mode < 0 || ($mode & $allModes) != $mode) {
throw new InvalidArgumentException("Invalid mode");
}
$this -> connector -> write(self::ESC . "!" . chr($mode));
}
/**
* Set barcode height.
*
* @param int $height Height in dots. If not specified, 8 will be used.
*/
function setBarcodeHeight($height = 8) {
self::validateInteger($height, 1, 255, __FUNCTION__);
$this -> connector -> write(self::GS . "h" . chr($height));
}
/**
* Set the position for the Human Readable Interpretation (HRI) of barcode characters.
*
* @param position $position. Use Escpos::BARCODE_TEXT_NONE to hide the text (default), or any combination of Escpos::BARCODE_TEXT_TOP and Escpos::BARCODE_TEXT_BOTTOM flags to display the text.
*/
function setBarcodeTextPosition($position = self::BARCODE_TEXT_NONE) {
self::validateInteger($position, 0, 3, __FUNCTION__, "Barcode text position");
$this -> connector -> write(self::GS . "H" . chr($position));
}
/**
* Turn double-strike mode on/off.
*
* @param boolean $on true for double strike, false for no double strike
*/
function setDoubleStrike($on = true) {
self::validateBoolean($on, __FUNCTION__);
$this -> connector -> write(self::ESC . "G". ($on ? chr(1) : chr(0)));
}
/**
* Turn emphasized mode on/off.
*
* @param boolean $on true for emphasis, false for no emphasis
*/
function setEmphasis($on = true) {
self::validateBoolean($on, __FUNCTION__);
$this -> connector -> write(self::ESC . "E". ($on ? chr(1) : chr(0)));
}
/**
* Select font. Most printers have two fonts (Fonts A and B), and some have a third (Font C).
*
* @param int $font The font to use. Must be either Escpos::FONT_A, Escpos::FONT_B, or Escpos::FONT_C.
*/
function setFont($font = self::FONT_A) {
self::validateInteger($font, 0, 2, __FUNCTION__);
$this -> connector -> write(self::ESC . "M" . chr($font));
}
/**
* Select justification.
*
* @param int $justification One of Escpos::JUSTIFY_LEFT, Escpos::JUSTIFY_CENTER, or Escpos::JUSTIFY_RIGHT.
*/
function setJustification($justification = self::JUSTIFY_LEFT) {
self::validateInteger($justification, 0, 2, __FUNCTION__);
$this -> connector -> write(self::ESC . "a" . chr($justification));
}
/**
* Attach a different print buffer to the printer. Buffers are responsible for handling text output to the printer.
*
* @param PrintBuffer $buffer The buffer to use.
* @throws InvalidArgumentException Where the buffer is already attached to a different printer.
*/
function setPrintBuffer(PrintBuffer $buffer) {
if($buffer === $this -> buffer) {
return;
}
if($buffer -> getPrinter() != null) {
throw new InvalidArgumentException("This buffer is already attached to a printer.");
}
if($this -> buffer !== null) {
$this -> buffer -> setPrinter(null);
}
$this -> buffer = $buffer;
$this -> buffer -> setPrinter($this);
}
/**
* Set black/white reverse mode on or off. In this mode, text is printed white on a black background.
*
* @param boolean $on True to enable, false to disable.
*/
function setReverseColors($on = true) {
self::validateBoolean($on, __FUNCTION__);
$this -> connector -> write(self::GS . "B" . ($on ? chr(1) : chr(0)));
}
/**
* Set the size of text, as a multiple of the normal size.
*
* @param int $widthMultiplier Multiple of the regular height to use (range 1 - 8)
* @param int $heightMultiplier Multiple of the regular height to use (range 1 - 8)
*/
function setTextSize($widthMultiplier, $heightMultiplier) {
self::validateInteger($widthMultiplier, 1, 8, __FUNCTION__);
self::validateInteger($heightMultiplier, 1, 8, __FUNCTION__);
$c = pow(2,4) * ($widthMultiplier - 1) + ($heightMultiplier - 1);
$this -> connector -> write(self::GS . "!" . chr($c));
}
/**
* Set underline for printed text.
*
* Argument can be true/false, or one of UNDERLINE_NONE,
* UNDERLINE_SINGLE or UNDERLINE_DOUBLE.
*
* @param int $underline Either true/false, or one of Escpos::UNDERLINE_NONE, Escpos::UNDERLINE_SINGLE or Escpos::UNDERLINE_DOUBLE. Defaults to Escpos::UNDERLINE_SINGLE.
*/
function setUnderline($underline = self::UNDERLINE_SINGLE) {
/* Map true/false to underline constants */
if($underline === true) {
$underline = self::UNDERLINE_SINGLE;
} else if($underline === false) {
$underline = self::UNDERLINE_NONE;
}
/* Set the underline */
self::validateInteger($underline, 0, 2, __FUNCTION__);
$this -> connector -> write(self::ESC . "-". chr($underline));
}
/**
* Add text to the buffer.
*
* Text should either be followed by a line-break, or feed() should be called
* after this to clear the print buffer.
*
* @param string $str Text to print
*/
function text($str = "") {
self::validateString($str, __FUNCTION__);
$this -> buffer -> writeText((string)$str);
}
/**
* Add text to the buffer without attempting to interpret chararacter codes.
*
* Text should either be followed by a line-break, or feed() should be called
* after this to clear the print buffer.
*
* @param string $str Text to print
*/
function textRaw($str = "") {
self::validateString($str, __FUNCTION__);
$this -> buffer -> writeTextRaw((string)$str);
}
/**
* Wrapper for GS ( k, to calculate and send correct data length.
*
* @param string $fn Function to use
* @param string $cn Output code type. Affects available data
* @param string $data Data to send.
* @param string $m Modifier/variant for function. Often '0' where used.
* @throws InvalidArgumentException Where the input lengths are bad.
*/
private function wrapperSend2dCodeData($fn, $cn, $data = '', $m = '') {
if(strlen($m) > 1 || strlen($cn) != 1 || strlen($fn) != 1) {
throw new InvalidArgumentException("wrapperSend2dCodeData: cn and fn must be one character each.");
}
$header = $this -> intLowHigh(strlen($data) + strlen($m) + 2, 2);
$this -> connector -> write(self::GS . "(k" . $header . $cn . $fn . $m . $data);
}
/**
* Wrapper for GS ( L, to calculate and send correct data length.
*
* @param string $m Modifier/variant for function. Usually '0'.
* @param string $fn Function number to use, as character.
* @param string $data Data to send.
* @throws InvalidArgumentException Where the input lengths are bad.
*/
private function wrapperSendGraphicsData($m, $fn, $data = '') {
if(strlen($m) != 1 || strlen($fn) != 1) {
throw new InvalidArgumentException("wrapperSendGraphicsData: m and fn must be one character each.");
}
$header = $this -> intLowHigh(strlen($data) + 2, 2);
$this -> connector -> write(self::GS . "(L" . $header . $m . $fn . $data);
}
/**
* Convert widths and heights to characters. Used before sending graphics to set the size.
*
* @param array $inputs
* @param boolean $long True to use 4 bytes, false to use 2
* @return string
*/
private static function dataHeader(array $inputs, $long = true) {
$outp = array();
foreach($inputs as $input) {
if($long) {
$outp[] = Escpos::intLowHigh($input, 2);
} else {
self::validateInteger($input, 0 , 255, __FUNCTION__);
$outp[] = chr($input);
}
}
return implode("", $outp);
}
/**
* Generate two characters for a number: In lower and higher parts, or more parts as needed.
* @param int $int Input number
* @param int $length The number of bytes to output (1 - 4).
*/
private static function intLowHigh($input, $length) {
$maxInput = (256 << ($length * 8) - 1);
self::validateInteger($length, 1, 4, __FUNCTION__);
self::validateInteger($input, 0, $maxInput, __FUNCTION__);
$outp = "";
for($i = 0; $i < $length; $i++) {
$outp .= chr($input % 256);
$input = (int)($input / 256);
}
return $outp;
}
/**
* Throw an exception if the argument given is not a boolean
*
* @param boolean $test the input to test
* @param string $source the name of the function calling this
*/
protected static function validateBoolean($test, $source) {
if(!($test === true || $test === false)) {
throw new InvalidArgumentException("Argument to $source must be a boolean");
}
}
/**
* Throw an exception if the argument given is not an integer within the specified range
*
* @param int $test the input to test
* @param int $min the minimum allowable value (inclusive)
* @param int $max the maximum allowable value (inclusive)
* @param string $source the name of the function calling this
* @param string $argument the name of the invalid parameter
*/
protected static function validateInteger($test, $min, $max, $source, $argument = "Argument") {
self::validateIntegerMulti($test, array(array($min, $max)), $source, $argument);
}
/**
* Throw an exception if the argument given is not an integer within one of the specified ranges
*
* @param int $test the input to test
* @param arrray $ranges array of two-item min/max ranges.
* @param string $source the name of the function calling this
* @param string $source the name of the function calling this
* @param string $argument the name of the invalid parameter
*/
protected static function validateIntegerMulti($test, array $ranges, $source, $argument = "Argument") {
if(!is_integer($test)) {
throw new InvalidArgumentException("$argument given to $source must be a number, but '$test' was given.");
}
$match = false;
foreach($ranges as $range) {
$match |= $test >= $range[0] && $test <= $range[1];
}
if(!$match) {
// Put together a good error "range 1-2 or 4-6"
$rangeStr = "range ";
for($i = 0; $i < count($ranges); $i++) {
$rangeStr .= $ranges[$i][0] . "-" . $ranges[$i][1];
if($i == count($ranges) - 1) {
continue;
} else if($i == count($ranges) - 2) {
$rangeStr .= " or ";
} else {
$rangeStr .= ", ";
}
}
throw new InvalidArgumentException("$argument given to $source must be in $rangeStr, but $test was given.");
}
}
/**
* Throw an exception if the argument given can't be cast to a string
*
* @param string $test the input to test
* @param string $source the name of the function calling this
* @param string $argument the name of the invalid parameter
*/
protected static function validateString($test, $source, $argument = "Argument") {
if (is_object($test) && !method_exists($test, '__toString')) {
throw new InvalidArgumentException("$argument to $source must be a string");
}
}
protected static function validateStringRegex($test, $source, $regex, $argument = "Argument") {
if(preg_match($regex, $test) === 0) {
throw new InvalidArgumentException("$argument given to $source is invalid. It should match regex '$regex', but '$test' was given.");
}
}
}

15
htdocs/includes/mike42/escpos-php/LICENSE.md
View File

@@ -1,11 +1,7 @@
escpos-php, a Thermal receipt printer library, for use with
ESC/POS compatible printers.
MIT License
Copyright (c) 2014-15 Michael Billington <michael.billington@gmail.com>,
incorporating modifications by:
- Roni Saha <roni.cse@gmail.com>
- Gergely Radics <gerifield@ustream.tv>
- Warren Doyle <w.doyle@fuelled.co>
Copyright (c) 2014-2016 Michael Billington, incorporating modifications by others.
See CONTRIBUTORS.md for a full list.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -13,10 +9,10 @@ in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -24,4 +20,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

451
htdocs/includes/mike42/escpos-php/README.md
View File

@@ -1,73 +1,14 @@
ESC/POS Print Driver for PHP
============================
# ESC/POS Print Driver for PHP
[![Build Status](https://travis-ci.org/mike42/escpos-php.svg?branch=master)](https://travis-ci.org/mike42/escpos-php) [![Latest Stable Version](https://poser.pugx.org/mike42/escpos-php/v/stable)](https://packagist.org/packages/mike42/escpos-php)
[![Total Downloads](https://poser.pugx.org/mike42/escpos-php/downloads)](https://packagist.org/packages/mike42/escpos-php)
[![License](https://poser.pugx.org/mike42/escpos-php/license)](https://packagist.org/packages/mike42/escpos-php)
[![Coverage Status](https://coveralls.io/repos/github/mike42/escpos-php/badge.svg?branch=development)](https://coveralls.io/github/mike42/escpos-php?branch=development)
This project implements a subset of Epson's ESC/POS protocol for thermal receipt printers. It allows you to generate and print receipts with basic formatting, cutting, and barcodes on a compatible printer.
The library was developed to add drop-in support for receipt printing to any PHP app, including web-based point-of-sale (POS) applications.
Basic usage
-----------
A "hello world" receipt can be generated easily (Call this `hello-world.php`):
```php
<?php
require_once(dirname(__FILE__) . "/Escpos.php");
$printer = new Escpos();
$printer -> text("Hello World!\n");
$printer -> cut();
$printer -> close();
```
This would be printed as:
```
# Networked printer
php hello-world.php | nc 10.x.x.x. 9100
# Local printer
php hello-world.php > /dev/...
# Windows local printer
php hello-world.php > foo.txt
net use LPT1 \\server\printer
copy foo.txt LPT1
del foo.txt
```
From your web app, you could pass the output directly to a socket if your printer is networked:
```php
<?php
require_once(dirname(__FILE__) . "/Escpos.php");
$connector = new NetworkPrintConnector("10.x.x.x", 9100);
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
$printer -> close();
```
Or to a local printer:
```php
<?php
require_once(dirname(__FILE__) . "/Escpos.php");
$connector = new FilePrintConnector("/dev/ttyS0");
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
$printer -> close();
```
### Basic workflow
The library should be initialised with a PrintConnector, which will pass on the data to your printer.
Use the table under "Compatibility", or the examples below to choose the appropriate connector for your
platform & interface. If no connector is specified, then standard output is used.
When you have finished using the print object, call `close()` to finalize any data transfers.
### Tips & examples
On Linux, your printer device file will be somewhere like `/dev/lp0` (parallel), `/dev/usb/lp1` (USB), `/dev/ttyUSB0` (USB-Serial), `/dev/ttyS0` (serial).
On Windows, the device files will be along the lines of `LPT1` (parallel) or `COM1` (serial). Use the `WindowsPrintConnector` to tap into system printing on Windows (eg. [Windows USB](https://github.com/mike42/escpos-php/tree/master/example/interface/windows-usb.php), [SMB](https://github.com/mike42/escpos-php/tree/master/example/interface/smb.php) or [Windows LPT](https://github.com/mike42/escpos-php/tree/master/example/interface/windows-lpt.php)) - this submits print jobs via a queue rather than communicating directly with the printer.
A complete real-world receipt can be found in the code of [Auth](https://github.com/mike42/Auth) in [ReceiptPrinter.php](https://github.com/mike42/Auth/blob/master/lib/misc/ReceiptPrinter.php). It includes justification, boldness, and a barcode.
Other examples are located in the [example/](https://github.com/mike42/escpos-php/blob/master/example/) directory.
Compatibility
-------------
## Compatibility
### Interfaces and operating systems
This driver is known to work with the following OS/interface combinations:
@@ -115,43 +56,276 @@ This driver is known to work with the following OS/interface combinations:
<td>No</td>
<td><a href="https://github.com/mike42/escpos-php/tree/master/example/interface/smb.php">Yes</a></td>
</tr>
<tr>
<th>CUPS hosted</th>
<td><a href="https://github.com/mike42/escpos-php/tree/master/example/interface/cups.php">Yes</a></td>
<td><a href="https://github.com/mike42/escpos-php/tree/master/example/interface/cups.php">Yes</a></td>
<td>No</td>
</tr>
</table>
### Printers
Many thermal receipt printers support ESC/POS to some degree. This driver has been known to work with:
- 3nStar RPT-008
- Approx APPPOS80AM
- AURES ODP-333
- AURES ODP-500
- Bematech-4200-TH
- Bematech LR2000E
- Birch PRP-085III
- Bixolon SRP-350III
- Bixolon SRP-350Plus
- Black Copper BC-85AC
- CHD TH-305N
- Citizen CBM1000-II
- Citizen CT-S310II
- Dapper-Geyi Q583P
- Daruma DR800
- DR-MP200 (manufacturer unknown)
- EPOS TEP 220M
- Elgin i9
- Epson EU-T332C
- Epson FX-890 (requires `feedForm()` to release paper).
- Epson TM-T20
- Epson TM-T20II
- Epson TM-T70
- Epson TM-T70II
- Epson TM-T81
- Epson TM-T82II
- Epson TM-T88II
- Epson TM-T88III
- Epson TM-T88IV
- Epson TM-T70
- Epson TM-T82II
- Epson TM-T20
- Epson TM-T70II
- Epson TM-T88V
- Epson TM-U220
- Epson FX-890 (requires `feedForm()` to release paper).
- Okipos 80 Plus III
- Epson TM-U295 (requires `release()` to release slip).
- Epson TM-U590 and TM-U590P
- Equal (EQ-IT-001) POS-58
- Everycom EC-58
- Excelvan HOP-E200
- Excelvan HOP-E58
- Excelvan HOP-E801
- Gainscha GP-2120TF
- Gainscha GP-5890x (Also marketed as EC Line 5890x)
- Gainscha GP-U80300I (Also marketed as gprinter GP-U80300I)
- gprinter GP-U80160I
- HOIN HOP-H58
- Ithaca iTherm 28
- Hasar HTP 250
- Metapace T-1
- Metapace T-25
- Nexa PX700
- Nyear NP100
- OKI RT322
- OKI 80 Plus III
- Orient BTP-R580
- P-822D
- P85A-401 (make unknown)
- Partner Tech RP320
- POSLIGNE ODP200H-III-G
- QPOS Q58M
- Rongta RP326US
- Rongta RP58-U
- Rongta RP80USE
- SAM4S GIANT-100DB
- Senor TP-100
- Sewoo SLK-TS400
- SEYPOS PRP-96
- SEYPOS PRP-300 (Also marketed as TYSSO PRP-300)
- SNBC BTP-R880NPIII
- Solux SX-TP-88300
- Sicar POS-80
- Silicon SP-201 / RP80USE
- SPRT SP-POS88V
- Star BSC10
- Star TSP100 ECO
- Star TSP100III FuturePRNT
- Star TSP-650
- Star TUP-592
- TVS RP45 Shoppe
- Venus V248T
- Xeumior SM-8330
- Xprinter F-900
- Xprinter XP-365B
- Xprinter XP-58 Series
- Xprinter XP-80C
- Xprinter XP-90
- XPrinter XP-Q20011
- Xprinter XP-Q800
- Zijang NT-58H
- Zijang ZJ-5870
- Zijang ZJ-5890T (Marketed as POS 5890T)
- Zjiang NT-58H
- Zjiang ZJ-5870
- Zjiang ZJ-5890 (Also sold as POS-5890 by many vendors; ZJ-5890K, ZJ-5890T also work).
- Zjiang ZJ-8220 (Also marketed as Excelvan ZJ-8220)
- Zjiang ZJ-8250
If you use any other printer with this code, please let me know so I can add it to the list.
If you use any other printer with this code, please [let us know](https://github.com/mike42/escpos-php/issues/new) so that it can be added to the list.
Available methods
-----------------
## Basic usage
### __construct(PrintConnector $connector, AbstractCapabilityProfile $profile)
### Include the library
#### Composer
If you are using composer, then add `mike42/escpos-php` as a dependency:
```bash
composer require mike42/escpos-php
```
In this case, you would include composer's auto-loader at the top of your source files:
```php
<?php
require __DIR__ . '/vendor/autoload.php';
```
#### Manually
If you don't have composer available, then simply download the code and include `autoload.php`:
```bash
git clone https://github.com/mike42/escpos-php vendor/mike42/escpos-php
```
```php
<?php
require __DIR__ . '/vendor/mike42/escpos-php/autoload.php';
```
#### Requirements
To maintain compatibility with as many systems as possible, this driver has few
hard dependencies:
- PHP 5.4 or above.
- `mbstring` extension, since the driver accepts UTF-8 encoding.
It is also suggested that you install either `imagick` or `gd`, so that you can
print images.
A number of optional packages can be added to enable more specific features. These
are described in the "suggest" section of [composer.json](https://github.com/mike42/escpos-php/tree/master/composer.json).
### The 'Hello World' receipt
To make use of this driver, your server (where PHP is installed) must be able to communicate with your printer. Start by generating a simple receipt and sending it to your printer using the command-line.
```php
<?php
/* Call this file 'hello-world.php' */
require __DIR__ . '/vendor/autoload.php';
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\Printer;
$connector = new FilePrintConnector("php://stdout");
$printer = new Printer($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
$printer -> close();
```
Some examples are below for common interfaces.
Communicate with a printer with an Ethernet interface using `netcat`:
```bash
php hello-world.php | nc 10.x.x.x. 9100
```
A USB local printer connected with `usblp` on Linux has a device file (Includes USB-parallel interfaces):
```bash
php hello-world.php > /dev/usb/lp0
```
A computer installed into the local `cups` server is accessed through `lp` or `lpr`:
```bash
php hello-world.php > foo.txt
lpr -o raw -H localhost -P printer foo.txt
```
A local or networked printer on a Windows computer is mapped in to a file, and generally requires you to share the printer first:
```
php hello-world.php > foo.txt
net use LPT1 \\server\printer
copy foo.txt LPT1
del foo.txt
```
If you have troubles at this point, then you should consult your OS and printer system documentation to try to find a working print command.
### Using a PrintConnector
To print receipts from PHP, use the most applicable [PrintConnector](https://github.com/mike42/escpos-php/tree/master/src/Mike42/Escpos/PrintConnectors) for your setup. The connector simply provides the plumbing to get data to the printer.
For example, a `NetworkPrintConnector` accepts an IP address and port:
```php
use Mike42\Escpos\PrintConnectors\NetworkPrintConnector;
use Mike42\Escpos\Printer;
$connector = new NetworkPrintConnector("10.x.x.x", 9100);
$printer = new Printer($connector);
try {
// ... Print stuff
} finally {
$printer -> close();
}
```
While a serial printer might use:
```php
use Mike42\Escpos\PrintConnectors\FilePrintConnector;
use Mike42\Escpos\Printer;
$connector = new FilePrintConnector("/dev/ttyS0");
$printer = new Printer($connector);
```
For each OS/interface combination that's supported, there are examples in the compatibility section of how a `PrintConnector` would be constructed. If you can't get a `PrintConnector` to work, then be sure to include the working print command in bug.
### Using a CapabilityProfile
Support for commands and code pages varies between printer vendors and models. By default, the driver will accept UTF-8, and output commands that are suitable for Epson TM-series printers.
When trying out a new brand of printer, it's a good idea to use the "simple" `CapabilityProfile`, which instructs the driver to avoid the use of advanced features (generally simpler image handling, ASCII-only text).
```php
use Mike42\Escpos\PrintConnectors\WindowsPrintConnector;
use Mike42\Escpos\CapabilityProfile;
$profile = CapabilityProfile::load("simple");
$connector = new WindowsPrintConnector("smb://computer/printer");
$printer = new Printer($connector, $profile);
```
As another example, Star-branded printers use different commands:
```php
use Mike42\Escpos\PrintConnectors\WindowsPrintConnector;
use Mike42\Escpos\CapabilityProfile;
$profile = CapabilityProfile::load("SP2000")
$connector = new WindowsPrintConnector("smb://computer/printer");
$printer = new Printer($connector, $profile);
```
For a list of available profiles, or to have support for your printer improved, please see the upstream [receipt-print-hq/escpos-printer-db](https://github.com/receipt-print-hq/escpos-printer-db) project.
### Tips & examples
On Linux, your printer device file will be somewhere like `/dev/lp0` (parallel), `/dev/usb/lp1` (USB), `/dev/ttyUSB0` (USB-Serial), `/dev/ttyS0` (serial).
On Windows, the device files will be along the lines of `LPT1` (parallel) or `COM1` (serial). Use the `WindowsPrintConnector` to tap into system printing on Windows (eg. [Windows USB](https://github.com/mike42/escpos-php/tree/master/example/interface/windows-usb.php), [SMB](https://github.com/mike42/escpos-php/tree/master/example/interface/smb.php) or [Windows LPT](https://github.com/mike42/escpos-php/tree/master/example/interface/windows-lpt.php)) - this submits print jobs via a queue rather than communicating directly with the printer.
A complete real-world receipt can be found in the code of [Auth](https://github.com/mike42/Auth) in [ReceiptPrinter.php](https://github.com/mike42/Auth/blob/master/lib/misc/ReceiptPrinter.php). It includes justification, boldness, and a barcode.
Other examples are located in the [example/](https://github.com/mike42/escpos-php/blob/master/example/) directory.
## Available methods
### __construct(PrintConnector $connector, CapabilityProfile $profile)
Construct new print object.
Parameters:
- `PrintConnector $connector`: The PrintConnector to send data to. If not set, output is sent to standard output.
- `AbstractCapabilityProfile $profile` Supported features of this printer. If not set, the DefaultCapabilityProfile will be used, which is suitable for Epson printers.
- `PrintConnector $connector`: The PrintConnector to send data to.
- `CapabilityProfile $profile` Supported features of this printer. If not set, the "default" CapabilityProfile will be used, which is suitable for Epson printers.
See [example/interface/]("https://github.com/mike42/escpos-php/tree/master/example/interface/) for ways to open connections for different platforms and interfaces.
See [example/interface/](https://github.com/mike42/escpos-php/tree/master/example/interface/) for ways to open connections for different platforms and interfaces.
### barcode($content, $type)
Print a barcode.
@@ -159,7 +333,7 @@ Print a barcode.
Parameters:
- `string $content`: The information to encode.
- `int $type`: The barcode standard to output. If not specified, `Escpos::BARCODE_CODE39` will be used.
- `int $type`: The barcode standard to output. If not specified, `Printer::BARCODE_CODE39` will be used.
Currently supported barcode standards are (depending on your printer):
@@ -181,7 +355,7 @@ Cut the paper.
Parameters:
- `int $mode`: Cut mode, either `Escpos::CUT_FULL` or `Escpos::CUT_PARTIAL`. If not specified, `Escpos::CUT_FULL` will be used.
- `int $mode`: Cut mode, either `Printer::CUT_FULL` or `Printer::CUT_PARTIAL`. If not specified, `Printer::CUT_FULL` will be used.
- `int $lines`: Number of lines to feed before cutting. If not specified, 3 will be used.
### feed($lines)
@@ -219,17 +393,29 @@ A minimal example:
```php
<?php
$img = new EscposImage("logo.png");
$img = EscposImage::load("logo.png");
$printer -> graphics($img);
```
See the [example/](https://github.com/mike42/escpos-php/blob/master/example/) folder for detailed examples.
The function [bitImage()](#bitimageescposimage-image-size) takes the same parameters, and can be used if your printer doesn't support the newer graphics commands.
The function [bitImage()](#bitimageescposimage-image-size) takes the same parameters, and can be used if your printer doesn't support the newer graphics commands. As an additional fallback, the `bitImageColumnFormat()` function is also provided.
### initialize()
Initialize printer. This resets formatting back to the defaults.
### pdf417Code($content, $width, $heightMultiplier, $dataColumnCount, $ec, $options)
Print a two-dimensional data code using the PDF417 standard.
Parameters:
- `string $content`: Text or numbers to store in the code
- `number $width`: Width of a module (pixel) in the printed code. Default is 3 dots.
- `number $heightMultiplier`: Multiplier for height of a module. Default is 3 times the width.
- `number $dataColumnCount`: Number of data columns to use. 0 (default) is to auto-calculate. Smaller numbers will result in a narrower code, making larger pixel sizes possible. Larger numbers require smaller pixel sizes.
- `real $ec`: Error correction ratio, from 0.01 to 4.00. Default is 0.10 (10%).
- `number $options`: Standard code `Printer::PDF417_STANDARD` with start/end bars, or truncated code `Printer::PDF417_TRUNCATED` with start bars only.
### pulse($pin, $on_ms, $off_ms)
Generate a pulse, for opening a cash drawer if one is connected. The default settings (0, 120, 240) should open an Epson drawer.
@@ -243,16 +429,16 @@ Parameters:
Print the given data as a QR code on the printer.
- `string $content`: The content of the code. Numeric data will be more efficiently compacted.
- `int $ec` Error-correction level to use. One of `Escpos::QR_ECLEVEL_L` (default), `Escpos::QR_ECLEVEL_M`, `Escpos::QR_ECLEVEL_Q` or `Escpos::QR_ECLEVEL_H`. Higher error correction results in a less compact code.
- `int $ec` Error-correction level to use. One of `Printer::QR_ECLEVEL_L` (default), `Printer::QR_ECLEVEL_M`, `Printer::QR_ECLEVEL_Q` or `Printer::QR_ECLEVEL_H`. Higher error correction results in a less compact code.
- `int $size`: Pixel size to use. Must be 1-16 (default 3)
- `int $model`: QR code model to use. Must be one of `Escpos::QR_MODEL_1`, `Escpos::QR_MODEL_2` (default) or `Escpos::QR_MICRO` (not supported by all printers).
- `int $model`: QR code model to use. Must be one of `Printer::QR_MODEL_1`, `Printer::QR_MODEL_2` (default) or `Printer::QR_MICRO` (not supported by all printers).
### selectPrintMode($mode)
Select print mode(s).
Parameters:
- `int $mode`: The mode to use. Default is `Escpos::MODE_FONT_A`, with no special formatting. This has a similar effect to running `initialize()`.
- `int $mode`: The mode to use. Default is `Printer::MODE_FONT_A`, with no special formatting. This has a similar effect to running `initialize()`.
Several MODE_* constants can be OR'd together passed to this function's `$mode` argument. The valid modes are:
@@ -270,6 +456,20 @@ Parameters:
- `int $height`: Height in dots. If not specified, 8 will be used.
### setBarcodeWidth($width)
Set barcode bar width.
Parameters:
- `int $width`: Bar width in dots. If not specified, 3 will be used. Values above 6 appear to have no effect.
### setColor($color)
Select print color - on printers that support multiple colors.
Parameters:
- `int $color`: Color to use. Must be either `Printer::COLOR_1` (default), or `Printer::COLOR_2`
### setDoubleStrike($on)
Turn double-strike mode on/off.
@@ -289,14 +489,40 @@ Select font. Most printers have two fonts (Fonts A and B), and some have a third
Parameters:
- `int $font`: The font to use. Must be either `Escpos::FONT_A`, `Escpos::FONT_B`, or `Escpos::FONT_C`.
- `int $font`: The font to use. Must be either `Printer::FONT_A`, `Printer::FONT_B`, or `Printer::FONT_C`.
### setJustification($justification)
Select justification.
Parameters:
- `int $justification`: One of `Escpos::JUSTIFY_LEFT`, `Escpos::JUSTIFY_CENTER`, or `Escpos::JUSTIFY_RIGHT`.
- `int $justification`: One of `Printer::JUSTIFY_LEFT`, `Printer::JUSTIFY_CENTER`, or `Printer::JUSTIFY_RIGHT`.
### setLineSpacing($height)
Set the height of the line.
Some printers will allow you to overlap lines with a smaller line feed.
Parameters:
- `int $height`: The height of each line, in dots. If not set, the printer will reset to its default line spacing.
### setPrintLeftMargin($margin)
Set print area left margin. Reset to default with `Printer::initialize()`.
Parameters:
- `int $margin`: The left margin to set on to the print area, in dots.
### setPrintWidth($width)
Set print area width. This can be used to add a right margin to the print area. Reset to default with `Printer::initialize()`.
Parameters:
- `int $width`: The width of the page print area, in dots.
### setReverseColors($on)
Set black/white reverse mode on or off. In this mode, text is printed white on a black background.
@@ -318,7 +544,7 @@ Set underline for printed text.
Parameters:
- `int $underline`: Either `true`/`false`, or one of `Escpos::UNDERLINE_NONE`, `Escpos::UNDERLINE_SINGLE` or `Escpos::UNDERLINE_DOUBLE`. Defaults to `Escpos::UNDERLINE_SINGLE`.
- `int $underline`: Either `true`/`false`, or one of `Printer::UNDERLINE_NONE`, `Printer::UNDERLINE_SINGLE` or `Printer::UNDERLINE_DOUBLE`. Defaults to `Printer::UNDERLINE_SINGLE`.
### text($str)
Add text to the buffer. Text should either be followed by a line-break, or `feed()` should be called after this.
@@ -327,26 +553,37 @@ Parameters:
- `string $str`: The string to print.
Further notes
-------------
# Further notes
Posts I've written up for people who are learning how to use receipt printers:
* [What is ESC/POS, and how do I use it?](http://mike.bitrevision.com/blog/what-is-escpos-and-how-do-i-use-it), which documents the output of test.php.
* [Setting up an Epson receipt printer](http://mike.bitrevision.com/blog/2014-20-26-setting-up-an-epson-receipt-printer)
* [Getting a USB receipt printer working on Linux](http://mike.bitrevision.com/blog/2015-03-getting-a-usb-receipt-printer-working-on-linux)
* [What is ESC/POS, and how do I use it?](https://mike42.me/blog/what-is-escpos-and-how-do-i-use-it), which documents the output of `example/demo.php`.
* [Setting up an Epson receipt printer](https://mike42.me/blog/2014-20-26-setting-up-an-epson-receipt-printer)
* [Getting a USB receipt printer working on Linux](https://mike42.me/blog/2015-03-getting-a-usb-receipt-printer-working-on-linux)
Other versions
--------------
Some forks of this project have been developed by others for specific use cases. Improvements from the following projects have been incorporated into escpos-php:
# Development
- [wdoyle/EpsonESCPOS-PHP](https://github.com/wdoyle/EpsonESCPOS-PHP)
- [ronisaha/php-esc-pos](https://github.com/ronisaha/php-esc-pos)
This code is MIT licensed, and you are encouraged to contribute any modifications back to the project.
Vendor documentation
--------------------
Epson notes that not all of its printers support all ESC/POS features, and includes a table in their documentation:
For development, it's suggested that you load `imagick`, `gd` and `Xdebug` PHP exensions, and install `composer`.
* [FAQ about ESC/POS from Epson](http://content.epson.de/fileadmin/content/files/RSD/downloads/escpos.pdf)
The tests are executed on [Travis CI](https://travis-ci.org/mike42/escpos-php) over PHP 5.4, 5.5, 5.6, 7.0, 7.1 and 7.2, plus the latest LTS version of HHVM, 3.21. Older versions of PHP are not supported in current releases.
Note that many printers produced by other vendors use the same standard, and are compatible by varying degrees.
Fetch a copy of this code and load dependencies with composer:
git clone https://github.com/mike42/escpos-php
cd escpos-php/
composer install
Execute unit tests via `phpunit`:
php vendor/bin/phpunit --coverage-text
This project uses the PSR-2 standard, which can be checked via [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer):
php vendor/bin/phpcs --standard=psr2 src/ -n
The developer docs are build with [doxygen](https://github.com/doxygen/doxygen). Re-build them to check for documentation warnings:
make -C doc clean && make -C doc
Pull requests and bug reports welcome.

26
htdocs/includes/mike42/escpos-php/autoload.php Normal file
View File

@@ -0,0 +1,26 @@
<?php
/**
* Users who do not have 'composer' to manage dependencies, include this
* file to provide auto-loading of the classes in this library.
*/
spl_autoload_register( function ($class) {
/*
* PSR-4 autoloader, based on PHP Framework Interop Group snippet (Under MIT License.)
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md
*/
$prefix = "Mike42\\";
$base_dir = __DIR__ . "/src/Mike42/";
/* Only continue for classes in this namespace */
$len = strlen($prefix);
if (strncmp($prefix, $class, $len) !== 0) {
return;
}
/* Require the file if it exists */
$relative_class = substr($class, $len);
$file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
if (file_exists($file)) {
require $file;
}
} );

70
htdocs/includes/mike42/escpos-php/composer.json
View File

@@ -1,36 +1,38 @@
{
"name": "mike42/escpos-php",
"type": "library",
"description": "Thermal receipt printer library, for use with ESC/POS compatible printers",
"homepage": "https://github.com/mike42/escpos-php",
"keywords": ["receipt", "print", "escpos", "ESC-POS", "driver"],
"license": "MIT",
"authors": [
{
"name": "Michael Billington",
"email": "michael.billington@gmail.com"
},
{
"name": "Roni Saha",
"email": "roni.cse@gmail.com"
},
{
"name": "Gergely Radics",
"email": "gerifield@ustream.tv"
},
{
"name": "Warren Doyle",
"email": "w.doyle@fuelled.co"
},
{
"name": "vharo",
"email": "vharo@geepok.com"
}
],
"require": {
"php": ">=5.3.0"
},
"require-dev": {
"phpunit/phpunit": "4.5.*"
}
"name": "mike42/escpos-php",
"type": "library",
"description": "PHP receipt printer library for use with ESC/POS-compatible thermal and impact printers",
"homepage": "https://github.com/mike42/escpos-php",
"keywords": ["receipt", "print", "escpos", "ESC-POS", "driver"],
"license": "MIT",
"authors": [
{
"name": "Michael Billington",
"email": "michael.billington@gmail.com"
}
],
"config": {
"platform": {
"php": "5.4.0"
}
},
"require": {
"php": ">=5.4.0",
"ext-mbstring": "*"
},
"suggest": {
"guzzlehttp/guzzle": "Allows the use of the ApiConnector to send print jobs over HTTP.",
"ext-imagick": "Will be used for image printing if present. Required for PDF printing or use of custom fonts.",
"ext-gd": "Used for image printing if present."
},
"require-dev": {
"phpunit/phpunit": "^4.8",
"squizlabs/php_codesniffer": "^3.2",
"guzzlehttp/guzzle": "^5.3"
},
"autoload": {
"psr-4": {
"Mike42\\": "src/Mike42"
}
}
}

615
htdocs/includes/mike42/escpos-php/composer.lock generated
View File

File diff suppressed because it is too large Load Diff

142
htdocs/includes/mike42/escpos-php/doc/FAQ.md Normal file
View File

@@ -0,0 +1,142 @@
# Frequently Asked Questions (FAQ)
## Can I print to File Format X with this?
If you are trying to generate XPS, PDF or DOCX or HTML files from PHP, then you are most likely in the wrong place.
The purpose of this driver it to generate binary ESC/POS code, which is understood by many embedded thermal receipt and impact printers.
## I have Printer X. Can I use this driver?
If the printer understands ESC/POS, and you know how to get raw binary data to it, then yes. Otherwise, no.
The [list of printers that are known to work](https://github.com/mike42/escpos-php/blob/development/README.md#printers) is crowd-sourced. We appreciate it when developers try out the driver, then [file information on the bug tracker](https://github.com/mike42/escpos-php/issues/new) with some information about which features worked on their model of printer.
To see how well your printer works, first check that it supports ESC/POS, then begin by attempting to send the text "Hello World" to your printer on the command-line, from the computer that will run PHP.
Once you solve this, [try to do the same from PHP](https://github.com/mike42/escpos-php/blob/development/README.md#basic-usage) using the default profile. Further details are in the [README](https://github.com/mike42/escpos-php/blob/development/README.md) file.
## Can you add support for Printer X?
Features vary between printers, so we collaborate on an ESC/POS printer compatibility database to collect known differences: [receipt-print-hq/escpos-printer-db](https://github.com/receipt-print-hq/escpos-printer-db).
If you encounter garbage output when you try to print images or special characters, then please submit a test page and a link to vendor documentation to the `escpos-printer-db` project, so that support can be improved for future versions.
## I have a printer that does not understand ESC/POS. Can I use this driver?
No. The purpose of this driver it to generate binary ESC/POS code. If your printer doesn't understand that, then this code wont be much use to you.
Some printers do have an emulation mode for ESC/POS. The vendor docs will tell if this is the case, and how to enable it.
## Why do I get this error when I try to print?
Start by testing that you can send text to your printer outside of escpos-php. The examples linked to in the README are commented with some commands to get you started.
Generally, initial setup problems seem to have one of these causes:
1. You are writing to the wrong place. Writing to `LPT1` does not output to parallel port on Linux, and `/dev/ttyS0` is not a serial printer on Windows.
2. The printer has not been set up to accept printing the way you expect. This means permissions on Linux, network printers being configured, and shared printers having user accounts and firewalls set up correctly on the print server.
3. Your printer actually doesn't work (rare but possible).
To be clear, these are not escpos-php issues: No amount of PHP code can set up your printer for you. Instead, the driver relies on developers determining how their setup is going to work before using a connector to transport data to their printer.
Once you have a working command to send text to your printer (from the PHP server), you are ready to use escpos-php. You can try to use a PrintConnector now, based on your operating system and printer interface. A table is located in the README to help you select the right one.
The connectors are-
- `FilePrintConnector` and `NetworkPrintConnector` directly use files or network sockets.
- `WindowsPrintConnector` and `CupsPrintConnector` tie in with Windows and Unix system printing.
- `DummyPrintConnector` does not connect to a real printer, and can be used to save ESC/POS receipts to a database, for example.
At this point, you might find that the way you would like to print is not supported by escpos-php. You can post your printing command as a feature request on the issue tracker.
Lastly, you may run in to the final common trap:
4. Your PHP is not running with the same sort of permissions as your login account. Again, no amount of PHP code can fix this. For example, on LAMP, your `www-data` user needs to be in the `lp` group, while on WAMP, `Local Service` account may run in to problems. SELinux and firewalls are also worth a look.
When printing fails, you can expect a PHP Exception that explains what went wrong. They are all clues:
- `Warning: copy(\\pc\printer): failed to open stream: Permission denied`
- `/dev/usb/lp0: Permission denied`
- `User name or password is incorrect`
Ensure that while you are developing, you configure PHP to show error messages, so that you can see these problems.
Please file a bug if you think that there is a specific situation which escpos-php could provide better error messages for.
## Can I print over the network?
Certainly, as long as your printer is available over the network.
- `NetworkPrintConnector` will speak directly to an Ethernet-connected printer on port 9100.
For USB or Serial printers, you need to install the printer on a computer and then share it, so that it becomes network-accessible.
- `WindowsPrintConnector` will connect to Windows shared printers from Windows or Linux (Linux users will need Samba).
- `CupsPrintConnector` will connect to CUPS-shared printers from Linux or Mac.
Always start by testing your shared printer setup outside of escpos-php. The examples linked to in the README are commented with some example commands to get you started. Typically, networks, firewalls and permissions need to be set up.
Once you have a working command to send text to your printer (from the PHP server), you are ready to use escpos-php.
If you have any issues at this stage, please ask on the issue tracker, and include the commands that you used to verify your setup.
## Can I print from my server on the Internet?
Since PHP is a server-side language, escpos-php is a server-side print library. The driver is able to transport data between a server and a printer in a few different ways, all of them server-side. For example, you may print to a USB printer *connected to the server running PHP*, or an Ethernet printer *on a network accessible to the server*.
Many developers dream of having an application that is hosted on the public Internet, with POS terminals accessing it, and printing via a web browser. Because the webserver cannot see the printer in this sort of setup, a server-side print driver is not much use.
Because of this, there are no cut-and-paste recipes available, but here are two top-level approaches you could take:
1. Architect your application so that the server can see your printer
2. Use an application which runs client-side to deliver print data instead
### Option 1: Allow the server to print
Server-side printing is viable if the server can get to the printer. Here are some ways it could work:
- Run your server on the LAN instead, and read the section above about printing over the network
- Set up a VPN so that your cloud-hosted server can also access the LAN
- Expose the printer via some other secure tunnel to the server, via SSH or TLS
Please do your own research to determine how these may apply to your setup- the escpos-php issue tracker is not a place where you should be requesting network support.
### Option 2: Use client software to print
If you aren't able to set up some network infrastructure to implement the above, then you cannot use a server-side print driver.
Here are some browser-based printing tools which you may like to consider instead.
- Use system printing with a vendor driver, and some good `@media print` CSS
- [Chrome Raw Print](https://github.com/receipt-print-hq/chrome-raw-print) app
- [qz](https://qz.io/)
- [ePOS-Device SDK for JavaScript](https://reference.epson-biz.com/modules/ref_epos_device_js_en/index.php?content_id=139). Requires network interface card that supports ePOS (UB-E04/R04)
Please direct queries about client-side printing products to the appropriate project.
## Why is image printing slow?
Three things tend to slow down the image processing:
1. Slow PHP code
2. Data link
3. The printer itself
First, ensure you have the Imagick plugin loaded. The driver will avoid a slower image processing implementation once you've got it.
Next, connect over a faster interface. Serial printers have a low bit-rate, and the printer spends a lot of time waiting for data. If you have USB or Ethernet, then use it (note: storing graphics to the printer memory is not currently implemented).
Lastly, the printer will go faster if you use less pixels. Since images are two-dimensional, scaling down by 50% removes 75% of the pixels. The driver can then print at a half the density, so that your lower resolution image appears the same size when printed.
## How can I get the status of the printer?
This feature is not implemented, but a solution for some Epson printers is planned.
Only `FilePrintConnector` or `NetworkPrintConnector` will support reading from the printer, ensure that you migrate to those if you would like these features.
## How do I produce this complex layout?
ESC/POS "page mode" is not currently supported, which would allow some printers to render some more complex layouts natively
Since the output is raster anyway, it is suggested that you render your output to an image and print that instead. The driver supports PDF printing via Imagick, and an example that uses `wkhtmltoimage` is available in the repository.

19
htdocs/includes/mike42/escpos-php/doc/Makefile
View File

@@ -1,9 +1,20 @@
html: ../Escpos.php escpos.conf
doxygen escpos.conf
html: escpos.doxyfile
# Compile
doxygen escpos.doxyfile
# Filter out warnings on README.md- doxygen cannot handle image links that
# are used there: [![Caption](https://example.com/target)](https://example.com/image)
sed -i '/README.md\:/d' warnings.log
# Show warnings log
cat warnings.log
# Return failure if there were any doc warnings
[ ! -s warnings.log ]
latex: html
# Do nothing
clean:
rm --preserve-root -Rf html latex doxygen_sqlite3.db
xml: html
xsltproc xml/combine.xslt xml/index.xml > all.xml
clean:
rm --preserve-root -Rf html latex xml doxygen_sqlite3.db all.xml warnings.log

18
htdocs/includes/mike42/escpos-php/doc/escpos.conf → htdocs/includes/mike42/escpos-php/doc/escpos.doxyfile
View File

@@ -20,7 +20,7 @@
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See https://www.gnu.org/software/libiconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
@@ -51,7 +51,7 @@ PROJECT_BRIEF =
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO = ../example/images/escpos-php-small.png
PROJECT_LOGO = ../example/resources/escpos-php-small.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@@ -741,7 +741,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
WARN_LOGFILE = warnings.log
#---------------------------------------------------------------------------
# Configuration options related to the input files
@@ -753,12 +753,12 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = ../Escpos.php ../src/ ../README.md
INPUT = ../src ../README.md ./
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: https://www.gnu.org/software/libiconv) for the list of
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
@@ -773,13 +773,13 @@ INPUT_ENCODING = UTF-8
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS =
FILE_PATTERNS = *.php *.md
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = NO
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
@@ -950,7 +950,7 @@ SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see https://www.gnu.org/software/global/global.html). You will need version
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
@@ -1820,7 +1820,7 @@ MAN_LINKS = NO
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

26
htdocs/includes/mike42/escpos-php/example/README.md
View File

@@ -1,26 +0,0 @@
Examples
--------
This folder contains a collectoion of feature examples.
Generally, demo.php is the fastest way to find out which features your
printer supports.
## Subfolders
- `interface/` - contains examples for output interfaces: eg, parallel, serial, USB, network, file-based.
- `specific/` - examples made in response to issues & questions. These cover specific languages, printers and interfaces, so hit narrower use cases.
## List of examples
Each example prints to standard output, so either edit the print connector, or redirect the output to your printer to see it in action. They are designed for developers: open them in a text editor before you run them!
- `bit-image.php` - Prints a images to the printer using the older "bit image" commands.
- `demo.php` - Demonstrates output using a large subset of availale features.
- `qr-code.php` - Prints QR codes, if your printer supports it.
- `character-encodings.php` - Shows available character encodings. Change from the DefaultCapabilityProfile to get more useful output for your specific printer.
- `graphics.php` - The same output as `bit-image.php`, printed with the newer graphics commands (not supported on many non-Epson printers)
- `receipt-with-logo.php` - A simple receipt containing a logo and basic formating.
- `character-encodings-with-images.php` - The same as `character-encodings.php`, but also prints each string using an `ImagePrintBuffer`, showing compatibility gaps.
- `print-from-html.php` - Runs `wkhtmltoimage` to convert HTML to an image, and then prints the image. (This is very slow)
- `character-tables.php` - Prints a compact character code table for each available character set. Used to debug incorrect output from `character-encodings.php`.
- `print-from-pdf.php` - Loads a PDF and prints each page in a few different ways (very slow as well)

181
htdocs/includes/mike42/escpos-php/example/barcode.php
View File

@@ -1,181 +0,0 @@
<?php
require_once (dirname ( __FILE__ ) . "/../Escpos.php");
$printer = new Escpos ();
$printer->setBarcodeHeight ( 40 );
/* Text position */
$printer->selectPrintMode ( Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_DOUBLE_WIDTH );
$printer->text ( "Text position\n" );
$printer->selectPrintMode ();
$hri = array (
Escpos::BARCODE_TEXT_NONE => "No text",
Escpos::BARCODE_TEXT_ABOVE => "Above",
Escpos::BARCODE_TEXT_BELOW => "Below",
Escpos::BARCODE_TEXT_ABOVE | Escpos::BARCODE_TEXT_BELOW => "Both"
);
foreach ( $hri as $position => $caption ) {
$printer->text ( $caption . "\n" );
$printer->setBarcodeTextPosition ( $position );
$printer->barcode ( "012345678901", Escpos::BARCODE_JAN13 );
$printer->feed ();
}
/* Barcode types */
$standards = array (
Escpos::BARCODE_UPCA => array (
"title" => "UPC-A",
"caption" => "Fixed-length numeric product barcodes.",
"example" => array (
array (
"caption" => "12 char numeric including (wrong) check digit.",
"content" => "012345678901"
),
array (
"caption" => "Send 11 chars to add check digit automatically.",
"content" => "01234567890"
)
)
),
Escpos::BARCODE_UPCE => array (
"title" => "UPC-E",
"caption" => "Fixed-length numeric compact product barcodes.",
"example" => array (
array (
"caption" => "6 char numeric - auto check digit & NSC",
"content" => "123456"
),
array (
"caption" => "7 char numeric - auto check digit",
"content" => "0123456"
),
array (
"caption" => "8 char numeric",
"content" => "01234567"
),
array (
"caption" => "11 char numeric - auto check digit",
"content" => "01234567890"
),
array (
"caption" => "12 char numeric including (wrong) check digit",
"content" => "012345678901"
)
)
),
Escpos::BARCODE_JAN13 => array (
"title" => "JAN13/EAN13",
"caption" => "Fixed-length numeric barcodes.",
"example" => array (
array (
"caption" => "12 char numeric - auto check digit",
"content" => "012345678901"
),
array (
"caption" => "13 char numeric including (wrong) check digit",
"content" => "0123456789012"
)
)
),
Escpos::BARCODE_JAN8 => array (
"title" => "JAN8/EAN8",
"caption" => "Fixed-length numeric barcodes.",
"example" => array (
array (
"caption" => "7 char numeric - auto check digit",
"content" => "0123456"
),
array (
"caption" => "8 char numeric including (wrong) check digit",
"content" => "01234567"
)
)
),
Escpos::BARCODE_CODE39 => array (
"title" => "Code39",
"caption" => "Variable length alphanumeric w/ some special chars.",
"example" => array (
array (
"caption" => "Text, numbers, spaces",
"content" => "ABC 012"
),
array (
"caption" => "Special characters",
"content" => "$%+-./"
),
array (
"caption" => "Extra char (*) Used as start/stop",
"content" => "*TEXT*"
)
)
),
Escpos::BARCODE_ITF => array (
"title" => "ITF",
"caption" => "Variable length numeric w/even number of digits,\nas they are encoded in pairs.",
"example" => array (
array (
"caption" => "Numeric- even number of digits",
"content" => "0123456789"
)
)
),
Escpos::BARCODE_CODABAR => array (
"title" => "Codabar",
"caption" => "Varaible length numeric with some allowable\nextra characters. ABCD/abcd must be used as\nstart/stop characters (one at the start, one\nat the end) to distinguish between barcode\napplications.",
"example" => array (
array (
"caption" => "Numeric w/ A A start/stop. ",
"content" => "A012345A"
),
array (
"caption" => "Extra allowable characters",
"content" => "A012$+-./:A"
)
)
),
Escpos::BARCODE_CODE93 => array (
"title" => "Code93",
"caption" => "Variable length- any ASCII is available",
"example" => array (
array (
"caption" => "Text",
"content" => "012abcd"
)
)
),
Escpos::BARCODE_CODE128 => array (
"title" => "Code128",
"caption" => "Variable length- any ASCII is available",
"example" => array (
array (
"caption" => "Code set A uppercase & symbols",
"content" => "{A" . "012ABCD"
),
array (
"caption" => "Code set B general text",
"content" => "{B" . "012ABCDabcd"
),
array (
"caption" => "Code set C compact numbers\n Sending chr(21) chr(32) chr(43)",
"content" => "{C" . chr ( 21 ) . chr ( 32 ) . chr ( 43 )
)
)
)
);
$printer->setBarcodeTextPosition ( Escpos::BARCODE_TEXT_BELOW );
foreach ( $standards as $type => $standard ) {
$printer->selectPrintMode ( Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_DOUBLE_WIDTH );
$printer->text ( $standard ["title"] . "\n" );
$printer->selectPrintMode ();
$printer->text ( $standard ["caption"] . "\n\n" );
foreach ( $standard ["example"] as $id => $barcode ) {
$printer->setEmphasis ( true );
$printer->text ( $barcode ["caption"] . "\n" );
$printer->setEmphasis ( false );
$printer->text ( "Content: " . $barcode ["content"] . "\n" );
$printer->barcode ( $barcode ["content"], $type );
$printer->feed ();
}
}
$printer->cut ();
$printer->close ();

32
htdocs/includes/mike42/escpos-php/example/bit-image.php
View File

@@ -1,32 +0,0 @@
<?php
/* Example print-outs using the older bit image print command */
require_once(dirname(__FILE__) . "/../Escpos.php");
$printer = new Escpos();
try {
$tux = new EscposImage("resources/tux.png");
$printer -> text("These example images are printed with the older\nbit image print command. You should only use\n\$p -> bitImage() if \$p -> graphics() does not\nwork on your printer.\n\n");
$printer -> bitImage($tux);
$printer -> text("Regular Tux (bit image).\n");
$printer -> feed();
$printer -> bitImage($tux, Escpos::IMG_DOUBLE_WIDTH);
$printer -> text("Wide Tux (bit image).\n");
$printer -> feed();
$printer -> bitImage($tux, Escpos::IMG_DOUBLE_HEIGHT);
$printer -> text("Tall Tux (bit image).\n");
$printer -> feed();
$printer -> bitImage($tux, Escpos::IMG_DOUBLE_WIDTH | Escpos::IMG_DOUBLE_HEIGHT);
$printer -> text("Large Tux in correct proportion (bit image).\n");
} catch(Exception $e) {
/* Images not supported on your PHP, or image file not found */
$printer -> text($e -> getMessage() . "\n");
}
$printer -> cut();
$printer -> close();
?>

59
htdocs/includes/mike42/escpos-php/example/character-encodings-with-images.php
View File

@@ -1,59 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../Escpos.php");
/**
* This example builds on character-encodings.php, also providing an image-based rendering.
* This is quite slow, since a) the buffers are changed dozens of
* times in the example, and b) It involves sending very wide images, which printers don't like!
*
* There are currently no test cases around the image printing, since it is an experimental feature.
*
* It does, however, illustrate the way that more encodings are available when image output is used.
*/
include(dirname(__FILE__) . '/resources/character-encoding-test-strings.inc');
try {
// Enter connector and capability profile
$connector = new FilePrintConnector("php://stdout");
$profile = DefaultCapabilityProfile::getInstance();
$buffers = array(new EscposPrintBuffer(), new ImagePrintBuffer());
/* Print a series of receipts containing i18n example strings */
$printer = new Escpos($connector, $profile);
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_EMPHASIZED | Escpos::MODE_DOUBLE_WIDTH);
$printer -> text("Implemented languages\n");
$printer -> selectPrintMode();
foreach($inputsOk as $label => $str) {
$printer -> setEmphasis(true);
$printer -> text($label . ":\n");
$printer -> setEmphasis(false);
foreach($buffers as $buffer) {
$printer -> setPrintBuffer($buffer);
$printer -> text($str);
}
$printer -> setPrintBuffer($buffers[0]);
}
$printer -> feed();
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_EMPHASIZED | Escpos::MODE_DOUBLE_WIDTH);
$printer -> text("Works in progress\n");
$printer -> selectPrintMode();
foreach($inputsNotOk as $label => $str) {
$printer -> setEmphasis(true);
$printer -> text($label . ":\n");
$printer -> setEmphasis(false);
foreach($buffers as $buffer) {
$printer -> setPrintBuffer($buffer);
$printer -> text($str);
}
$printer -> setPrintBuffer($buffers[0]);
}
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

58
htdocs/includes/mike42/escpos-php/example/character-encodings.php
View File

@@ -1,58 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../Escpos.php");
/**
* This demonstrates available character encodings. Escpos-php accepts UTF-8,
* and converts this to lower-level data to the printer. This is a complex area, so be
* prepared to code a model-specific hack ('CapabilityProfile') for your printer.
*
* If you run into trouble, please file an issue on GitHub, including at a minimum:
* - A UTF-8 test string in the language you're working in, and
* - A test print or link to a technical document which lists the available
* code pages ('character code tables') for your printer.
*
* The DefaultCapabilityProfile works for Espson-branded printers. For other models, you
* must use/create a PrinterCapabilityProfile for your printer containing a list of code
* page numbers for your printer- otherwise you will get mojibake.
*
* If you do not intend to use non-English characters, then use SimpleCapabilityProfile,
* which has only the default encoding, effectively disabling code page changes.
*/
include(dirname(__FILE__) . '/resources/character-encoding-test-strings.inc');
try {
// Enter connector and capability profile (to match your printer)
$connector = new FilePrintConnector("php://stdout");
$profile = DefaultCapabilityProfile::getInstance();
/* Print a series of receipts containing i18n example strings */
$printer = new Escpos($connector, $profile);
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_EMPHASIZED | Escpos::MODE_DOUBLE_WIDTH);
$printer -> text("Implemented languages\n");
$printer -> selectPrintMode();
foreach($inputsOk as $label => $str) {
$printer -> setEmphasis(true);
$printer -> text($label . ":\n");
$printer -> setEmphasis(false);
$printer -> text($str);
}
$printer -> feed();
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_EMPHASIZED | Escpos::MODE_DOUBLE_WIDTH);
$printer -> text("Works in progress\n");
$printer -> selectPrintMode();
foreach($inputsNotOk as $label => $str) {
$printer -> setEmphasis(true);
$printer -> text($label . ":\n");
$printer -> setEmphasis(false);
$printer -> text($str);
}
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

71
htdocs/includes/mike42/escpos-php/example/character-tables.php
View File

@@ -1,71 +0,0 @@
<?php
/**
* This demo prints out supported code pages on your printer. This is intended
* for debugging character-encoding issues: If your printer does not work with
* a built-in capability profile, you need to check its documentation for
* supported code pages.
*
* These are then loaded into a capability profile, which maps code page
* numbers to iconv encoding names on your particular printer. This script
* will print all configured code pages, so that you can check that the chosen
* iconv encoding name matches the actual code page contents.
*
* If this is correctly set up for your printer, then the driver will try its
* best to map UTF-8 text into these code pages for you, allowing you to accept
* arbitrary input from a database, without worrying about encoding it for the printer.
*/
require_once(dirname(__FILE__) . "/../Escpos.php");
// Enter connector and capability profile (to match your printer)
$connector = new FilePrintConnector("php://stdout");
$profile = DefaultCapabilityProfile::getInstance();
$verbose = false; // Skip tables which iconv wont convert to (ie, only print characters available with UTF-8 input)
/* Print a series of receipts containing i18n example strings - Code below shouldn't need changing */
$printer = new Escpos($connector, $profile);
$codePages = $profile -> getSupportedCodePages();
$first = true; // Print larger table for first code-page.
foreach($codePages as $table => $name) {
/* Change printer code page */
$printer -> selectCharacterTable(255);
$printer -> selectCharacterTable($table);
/* Select & print a label for it */
$label = $name;
if($name === false) {
$label= " (not matched to iconv table)";
}
$printer -> setEmphasis(true);
$printer -> textRaw("Table $table: $label\n");
$printer -> setEmphasis(false);
if($name === false && !$verbose) {
continue; // Skip non-recognised
}
/* Print a table of available characters (first table is larger than subsequent ones */
if($first) {
$first = false;
compactCharTable($printer, 1, true);
} else {
compactCharTable($printer);
}
}
$printer -> cut();
$printer -> close();
function compactCharTable($printer, $start = 4, $header = false) {
/* Output a compact character table for the current encoding */
$chars = str_repeat(' ', 256);
for($i = 0; $i < 255; $i++) {
$chars[$i] = ($i > 32 && $i != 127) ? chr($i) : ' ';
}
if($header) {
$printer -> setEmphasis(true);
$printer -> textRaw(" 0123456789ABCDEF0123456789ABCDEF\n");
$printer -> setEmphasis(false);
}
for($y = $start; $y < 8; $y++) {
$printer -> setEmphasis(true);
$printer -> textRaw(strtoupper(dechex($y * 2)) . " ");
$printer -> setEmphasis(false);
$printer -> textRaw(substr($chars, $y * 32, 32) . "\n");
}
}

167
htdocs/includes/mike42/escpos-php/example/demo.php
View File

@@ -1,167 +0,0 @@
<?php
/**
* This is a demo script for the functions of the PHP ESC/POS print driver,
* Escpos.php.
*
* Most printers implement only a subset of the functionality of the driver, so
* will not render this output correctly in all cases.
*
* @author Michael Billington <michael.billington@gmail.com>
*/
require_once(dirname(__FILE__) . "/../Escpos.php");
$printer = new Escpos();
/* Initialize */
$printer -> initialize();
/* Text */
$printer -> text("Hello world\n");
$printer -> cut();
/* Line feeds */
$printer -> text("ABC");
$printer -> feed(7);
$printer -> text("DEF");
$printer -> feedReverse(3);
$printer -> text("GHI");
$printer -> feed();
$printer -> cut();
/* Font modes */
$modes = array(
Escpos::MODE_FONT_B,
Escpos::MODE_EMPHASIZED,
Escpos::MODE_DOUBLE_HEIGHT,
Escpos::MODE_DOUBLE_WIDTH,
Escpos::MODE_UNDERLINE);
for($i = 0; $i < pow(2, count($modes)); $i++) {
$bits = str_pad(decbin($i), count($modes), "0", STR_PAD_LEFT);
$mode = 0;
for($j = 0; $j < strlen($bits); $j++) {
if(substr($bits, $j, 1) == "1") {
$mode |= $modes[$j];
}
}
$printer -> selectPrintMode($mode);
$printer -> text("ABCDEFGHIJabcdefghijk\n");
}
$printer -> selectPrintMode(); // Reset
$printer -> cut();
/* Underline */
for($i = 0; $i < 3; $i++) {
$printer -> setUnderline($i);
$printer -> text("The quick brown fox jumps over the lazy dog\n");
}
$printer -> setUnderline(0); // Reset
$printer -> cut();
/* Cuts */
$printer -> text("Partial cut\n(not available on all printers)\n");
$printer -> cut(Escpos::CUT_PARTIAL);
$printer -> text("Full cut\n");
$printer -> cut(Escpos::CUT_FULL);
/* Emphasis */
for($i = 0; $i < 2; $i++) {
$printer -> setEmphasis($i == 1);
$printer -> text("The quick brown fox jumps over the lazy dog\n");
}
$printer -> setEmphasis(false); // Reset
$printer -> cut();
/* Double-strike (looks basically the same as emphasis) */
for($i = 0; $i < 2; $i++) {
$printer -> setDoubleStrike($i == 1);
$printer -> text("The quick brown fox jumps over the lazy dog\n");
}
$printer -> setDoubleStrike(false);
$printer -> cut();
/* Fonts (many printers do not have a 'Font C') */
$fonts = array(
Escpos::FONT_A,
Escpos::FONT_B,
Escpos::FONT_C);
for($i = 0; $i < count($fonts); $i++) {
$printer -> setFont($fonts[$i]);
$printer -> text("The quick brown fox jumps over the lazy dog\n");
}
$printer -> setFont(); // Reset
$printer -> cut();
/* Justification */
$justification = array(
Escpos::JUSTIFY_LEFT,
Escpos::JUSTIFY_CENTER,
Escpos::JUSTIFY_RIGHT);
for($i = 0; $i < count($justification); $i++) {
$printer -> setJustification($justification[$i]);
$printer -> text("A man a plan a canal panama\n");
}
$printer -> setJustification(); // Reset
$printer -> cut();
/* Barcodes - see barcode.php for more detail */
$printer -> setBarcodeHeight(80);
$printer->setBarcodeTextPosition ( Escpos::BARCODE_TEXT_BELOW );
$printer -> barcode("9876");
$printer -> feed();
$printer -> cut();
/* Graphics - this demo will not work on some non-Epson printers */
try {
$logo = new EscposImage("resources/escpos-php.png");
$imgModes = array(
Escpos::IMG_DEFAULT,
Escpos::IMG_DOUBLE_WIDTH,
Escpos::IMG_DOUBLE_HEIGHT,
Escpos::IMG_DOUBLE_WIDTH | Escpos::IMG_DOUBLE_HEIGHT
);
foreach($imgModes as $mode) {
$printer -> graphics($logo, $mode);
}
} catch(Exception $e) {
/* Images not supported on your PHP, or image file not found */
$printer -> text($e -> getMessage() . "\n");
}
$printer -> cut();
/* Bit image */
try {
$logo = new EscposImage("resources/escpos-php.png");
$imgModes = array(
Escpos::IMG_DEFAULT,
Escpos::IMG_DOUBLE_WIDTH,
Escpos::IMG_DOUBLE_HEIGHT,
Escpos::IMG_DOUBLE_WIDTH | Escpos::IMG_DOUBLE_HEIGHT
);
foreach($imgModes as $mode) {
$printer -> bitImage($logo, $mode);
}
} catch(Exception $e) {
/* Images not supported on your PHP, or image file not found */
$printer -> text($e -> getMessage() . "\n");
}
$printer -> cut();
/* QR Code - see also the more in-depth demo at qr-code.php */
$testStr = "Testing 123";
$models = array(
Escpos::QR_MODEL_1 => "QR Model 1",
Escpos::QR_MODEL_2 => "QR Model 2 (default)",
Escpos::QR_MICRO => "Micro QR code\n(not supported on all printers)");
foreach($models as $model => $name) {
$printer -> qrCode($testStr, Escpos::QR_ECLEVEL_L, 3, $model);
$printer -> text("$name\n");
$printer -> feed();
}
$printer -> cut();
/* Pulse */
$printer -> pulse();
/* Always close the printer! On some PrintConnectors, no actual
* data is sent until the printer is closed. */
$printer -> close();
?>

32
htdocs/includes/mike42/escpos-php/example/graphics.php
View File

@@ -1,32 +0,0 @@
<?php
/* Print-outs using the newer graphics print command */
require_once(dirname(__FILE__) . "/../Escpos.php");
$printer = new Escpos();
try {
$tux = new EscposImage("resources/tux.png");
$printer -> graphics($tux);
$printer -> text("Regular Tux.\n");
$printer -> feed();
$printer -> graphics($tux, Escpos::IMG_DOUBLE_WIDTH);
$printer -> text("Wide Tux.\n");
$printer -> feed();
$printer -> graphics($tux, Escpos::IMG_DOUBLE_HEIGHT);
$printer -> text("Tall Tux.\n");
$printer -> feed();
$printer -> graphics($tux, Escpos::IMG_DOUBLE_WIDTH | Escpos::IMG_DOUBLE_HEIGHT);
$printer -> text("Large Tux in correct proportion.\n");
$printer -> cut();
} catch(Exception $e) {
/* Images not supported on your PHP, or image file not found */
$printer -> text($e -> getMessage() . "\n");
}
$printer -> close();
?>

8
htdocs/includes/mike42/escpos-php/example/interface/README.md
View File

@@ -1,8 +0,0 @@
Interfaces
----------
This directory contains boilerpalte code to show you how to open a print connector
to printers which are connected in different ways.
To get a list of supported interfaces and operating systems, see the main README.md file for the project.
If you have a printer interface with no example, and you want to help put one together, then please lodge a request on the bug tracker: https://github.com/mike42/escpos-php/issues

22
htdocs/includes/mike42/escpos-php/example/interface/ethernet.php
View File

@@ -1,22 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../../Escpos.php");
/* Most printers are open on port 9100, so you just need to know the IP
* address of your receipt printer, and then fsockopen() it on that port.
*/
try {
$connector = null;
//$connector = new NetworkPrintConnector("10.x.x.x", 9100);
/* Print a "Hello world" receipt" */
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

33
htdocs/includes/mike42/escpos-php/example/interface/linux-usb.php
View File

@@ -1,33 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../../Escpos.php");
/**
* On Linux, use the usblp module to make your printer available as a device
* file. This is generally the default behaviour if you don't install any
* vendor drivers.
*
* Once this is done, use a FilePrintConnector to open the device.
*
* Troubleshooting: On Debian, you must be in the lp group to access this file.
* dmesg to see what happens when you plug in your printer to make sure no
* other drivers are unloading the module.
*/
try {
// Enter the device file for your USB printer here
$connector = null;
//$connector = new FilePrintConnector("/dev/usb/lp0");
//$connector = new FilePrintConnector("/dev/usb/lp1");
//$connector = new FilePrintConnector("/dev/usb/lp2");
/* Print a "Hello world" receipt" */
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

51
htdocs/includes/mike42/escpos-php/example/interface/smb.php
View File

@@ -1,51 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../../Escpos.php");
/**
* Install the printer using USB printing support, and the "Generic / Text Only" driver,
* then share it.
*
* Use a WindowsPrintConnector with the share name to print. This works on either
* Windows or Linux.
*
* Troubleshooting: Fire up a command prompt/terminal, and ensure that (if your printer is
* shared as "Receipt Printer"), the following commands work.
*
* Windows: (use an appropriate "net use" command if you need authentication)
* echo "Hello World" > testfile
* ## If you need authentication, use "net use" to hook up the printer:
* # net use "\\computername\Receipt Printer" /user:Guest
* # net use "\\computername\Receipt Printer" /user:Bob secret
* # net use "\\computername\Receipt Printer" /user:workgroup\Bob secret
* copy testfile "\\computername\Receipt Printer"
* del testfile
*
* GNU/Linux:
* # No authentication
* echo "Hello World" | smbclient "//computername/Receipt Printer" -c "print -" -N
* # Guest login
* echo "Hello World" | smbclient "//computername/Receipt Printer" -U Guest -c "print -" -N
* # Basic username/password
* echo "Hello World" | smbclient "//computername/Receipt Printer" secret -U "Bob" -c "print -"
* # Including domain name
* echo "Hello World" | smbclient "//computername/Receipt Printer" secret -U "workgroup\\Bob" -c "print -"
*/
try {
// Enter the share name for your printer here, as a smb:// url format
$connector = null;
//$connector = new WindowsPrintConnector("smb://computername/Receipt Printer");
//$connector = new WindowsPrintConnector("smb://Guest@computername/Receipt Printer");
//$connector = new WindowsPrintConnector("smb://FooUser:secret@computername/workgroup/Receipt Printer");
//$connector = new WindowsPrintConnector("smb://User:secret@computername/Receipt Printer");
/* Print a "Hello world" receipt" */
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

30
htdocs/includes/mike42/escpos-php/example/interface/windows-lpt.php
View File

@@ -1,30 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../../Escpos.php");
/**
* Assuming your printer is available at LPT1,
* simpy instantiate a WindowsPrintConnector to it.
*
* When troubleshooting, make sure you can send it
* data from the command-line first:
* echo "Hello World" > LPT1
*/
try {
$connector = null;
//$connector = new WindowsPrintConnector("LPT1");
// A FilePrintConnector will also work, but on non-Windows systems, writes
// to an actual file called 'LPT1' rather than giving a useful error.
// $connector = new FilePrintConnector("LPT1");
/* Print a "Hello world" receipt" */
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

32
htdocs/includes/mike42/escpos-php/example/interface/windows-usb.php
View File

@@ -1,32 +0,0 @@
<?php
/* Change to the correct path if you copy this example! */
require_once(dirname(__FILE__) . "/../../Escpos.php");
/**
* Install the printer using USB printing support, and the "Generic / Text Only" driver,
* then share it (you can use a firewall so that it can only be seen locally).
*
* Use a WindowsPrintConnector with the share name to print.
*
* Troubleshooting: Fire up a command prompt, and ensure that (if your printer is shared as
* "Receipt Printer), the following commands work:
*
* echo "Hello World" > testfile
* copy testfile "\\%COMPUTERNAME%\Receipt Printer"
* del testfile
*/
try {
// Enter the share name for your USB printer here
$connector = null;
//$connector = new WindowsPrintConnector("Receipt Printer");
/* Print a "Hello world" receipt" */
$printer = new Escpos($connector);
$printer -> text("Hello World!\n");
$printer -> cut();
/* Close printer */
$printer -> close();
} catch(Exception $e) {
echo "Couldn't print to this printer: " . $e -> getMessage() . "\n";
}

53
htdocs/includes/mike42/escpos-php/example/print-from-html.php
View File

@@ -1,53 +0,0 @@
<?php
require_once(dirname(__FILE__)."/../Escpos.php");
/*
* Due to its complxity, escpos-php does not support HTML input. To print HTML,
* either convert it to calls on the Escpos() object, or rasterise the page with
* wkhtmltopdf, an external package which is designed to handle HTML efficiently.
*
* This example is provided to get you started.
*
* Note: Depending on the height of your pages, it is suggested that you chop it
* into smaller sections, as printers simply don't have the buffer capacity for
* very large images.
*
* As always, you can trade off quality for capacity by halving the width
* (550 -> 225 below) and printing w/ Escpos::IMG_DOUBLE_WIDTH | Escpos::IMG_DOUBLE_HEIGHT
*/
try {
/* Set up command */
$source = "http://en.m.wikipedia.org/wiki/ESC/P";
$width = 550;
$dest = tempnam(sys_get_temp_dir(), 'escpos') . ".png";
$cmd = sprintf("wkhtmltoimage -n -q --width %s %s %s",
escapeshellarg($width),
escapeshellarg($source),
escapeshellarg($dest));
/* Run wkhtmltoimage */
ob_start();
system($cmd); // Can also use popen() for better control of process
$outp = ob_get_contents();
ob_end_clean();
if(!file_exists($dest)) {
throw new Exception("Command $cmd failed: $outp");
}
/* Load up the image */
try {
$img = new EscposImage($dest);
} catch(Exception $e) {
unlink($dest);
throw $e;
}
unlink($dest);
/* Print it */
$printer = new Escpos(); // Add connector for your printer here.
$printer -> bitImage($img); // bitImage() seems to allow larger images than graphics() on the TM-T20.
$printer -> cut();
$printer -> close();
} catch(Exception $e) {
echo $e -> getMessage();
}

71
htdocs/includes/mike42/escpos-php/example/print-from-pdf.php
View File

@@ -1,71 +0,0 @@
<?php
require_once(dirname(__FILE__) . '/../Escpos.php');
/*
* This is three examples in one:
* 1: Print an entire PDF, normal quality.
* 2: Print at a lower quality for speed increase (CPU & transfer)
* 3: Cache rendered documents for a speed increase (removes CPU image processing completely on subsequent prints)
*/
/* 1: Print an entire PDF, start-to-finish (shorter form of the example) */
$pdf = 'resources/document.pdf';
try {
$pages = EscposImage::loadPdf($pdf);
$printer = new Escpos();
foreach($pages as $page) {
$printer -> graphics($page);
}
$printer -> cut();
$printer -> close();
} catch(Exception $e) {
/*
* loadPdf() throws exceptions if files or not found, or you don't have the
* imagick extension to read PDF's
*/
echo $e -> getMessage() . "\n";
exit(0);
}
/*
* 2: Speed up printing by roughly halving the resolution, and printing double-size.
* This gives a 75% speed increase at the expense of some quality.
*
* Reduce the page width further if necessary: if it extends past the printing area, your prints will be very slow.
*/
$printer = new Escpos();
$pdf = 'resources/document.pdf';
$pages = EscposImage::loadPdf($pdf, 260);
foreach($pages as $page) {
$printer -> graphics($page, Escpos::IMG_DOUBLE_HEIGHT | Escpos::IMG_DOUBLE_WIDTH);
}
$printer -> cut();
$printer -> close();
/*
* 3: PDF printing still too slow? If you regularly print the same files, serialize & compress your
* EscposImage objects (after printing[1]), instead of throwing them away.
*
* (You can also do this to print logos on computers which don't have an
* image processing library, by preparing a serialized version of your logo on your PC)
*
* [1]After printing, the pixels are loaded and formatted for the print command you used, so even a raspberry pi can print complex PDF's quickly.
*/
$printer = new Escpos();
$pdf = 'resources/document.pdf';
$ser = 'resources/document.z';
if(!file_exists($ser)) {
$pages = EscposImage::loadPdf($pdf);
} else {
$pages = unserialize(gzuncompress(file_get_contents($ser)));
}
foreach($pages as $page) {
$printer -> graphics($page);
}
$printer -> cut();
$printer -> close();
if(!file_exists($ser)) {
file_put_contents($ser, gzcompress(serialize($pages)));
}

81
htdocs/includes/mike42/escpos-php/example/qr-code.php
View File

@@ -1,81 +0,0 @@
<?php
/* Demonstration of available options on the qrCode() command */
require_once(dirname(__FILE__) . "/../Escpos.php");
$printer = new Escpos();
// Most simple example
title($printer, "QR code demo\n");
$testStr = "Testing 123";
$printer -> qrCode($testStr);
$printer -> text("Most simple example\n");
$printer -> feed();
// Demo that alignment is the same as text
$printer -> setJustification(Escpos::JUSTIFY_CENTER);
$printer -> qrCode($testStr);
$printer -> text("Same example, centred\n");
$printer -> setJustification();
$printer -> feed();
// Demo of numeric data being packed more densly
title($printer, "Data encoding\n");
$test = array(
"Numeric" => "0123456789012345678901234567890123456789",
"Alphanumeric" => "abcdefghijklmnopqrstuvwxyzabcdefghijklmn",
"Binary" => str_repeat("\0", 40));
foreach($test as $type => $data) {
$printer -> qrCode($data);
$printer -> text("$type\n");
$printer -> feed();
}
// Demo of error correction
title($printer, "Error correction\n");
$ec = array(
Escpos::QR_ECLEVEL_L => "L",
Escpos::QR_ECLEVEL_M => "M",
Escpos::QR_ECLEVEL_Q => "Q",
Escpos::QR_ECLEVEL_H => "H");
foreach($ec as $level => $name) {
$printer -> qrCode($testStr, $level);
$printer -> text("Error correction $name\n");
$printer -> feed();
}
// Change size
title($printer, "Pixel size\n");
$sizes = array(
1 => "(minimum)",
2 => "",
3 => "(default)",
4 => "",
5 => "",
10 => "",
16 => "(maximum)");
foreach($sizes as $size => $label) {
$printer -> qrCode($testStr, Escpos::QR_ECLEVEL_L, $size);
$printer -> text("Pixel size $size $label\n");
$printer -> feed();
}
// Change model
title($printer, "QR model\n");
$models = array(
Escpos::QR_MODEL_1 => "QR Model 1",
Escpos::QR_MODEL_2 => "QR Model 2 (default)",
Escpos::QR_MICRO => "Micro QR code\n(not supported on all printers)");
foreach($models as $model => $name) {
$printer -> qrCode($testStr, Escpos::QR_ECLEVEL_L, 3, $model);
$printer -> text("$name\n");
$printer -> feed();
}
// Cut & close
$printer -> cut();
$printer -> close();
function title(Escpos $printer, $str) {
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_HEIGHT | Escpos::MODE_DOUBLE_WIDTH);
$printer -> text($str);
$printer -> selectPrintMode();
}

96
htdocs/includes/mike42/escpos-php/example/receipt-with-logo.php
View File

@@ -1,96 +0,0 @@
<?php
require_once(dirname(__FILE__) . "/../Escpos.php");
/* Information for the receipt */
$items = array(
new item("Example item #1", "4.00"),
new item("Another thing", "3.50"),
new item("Something else", "1.00"),
new item("A final item", "4.45"),
);
$subtotal = new item('Subtotal', '12.95');
$tax = new item('A local tax', '1.30');
$total = new item('Total', '14.25', true);
/* Date is kept the same for testing */
// $date = date('l jS \of F Y h:i:s A');
$date = "Monday 6th of April 2015 02:56:25 PM";
/* Start the printer */
$logo = new EscposImage("resources/escpos-php.png");
$printer = new Escpos();
/* Print top logo */
$printer -> setJustification(Escpos::JUSTIFY_CENTER);
$printer -> graphics($logo);
/* Name of shop */
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_WIDTH);
$printer -> text("ExampleMart Ltd.\n");
$printer -> selectPrintMode();
$printer -> text("Shop No. 42.\n");
$printer -> feed();
/* Title of receipt */
$printer -> setEmphasis(true);
$printer -> text("SALES INVOICE\n");
$printer -> setEmphasis(false);
/* Items */
$printer -> setJustification(Escpos::JUSTIFY_LEFT);
$printer -> setEmphasis(true);
$printer -> text(new item('', '$'));
$printer -> setEmphasis(false);
foreach($items as $item) {
$printer -> text($item);
}
$printer -> setEmphasis(true);
$printer -> text($subtotal);
$printer -> setEmphasis(false);
$printer -> feed();
/* Tax and total */
$printer -> text($tax);
$printer -> selectPrintMode(Escpos::MODE_DOUBLE_WIDTH);
$printer -> text($total);
$printer -> selectPrintMode();
/* Footer */
$printer -> feed(2);
$printer -> setJustification(Escpos::JUSTIFY_CENTER);
$printer -> text("Thank you for shopping at ExampleMart\n");
$printer -> text("For trading hours, please visit example.com\n");
$printer -> feed(2);
$printer -> text($date . "\n");
/* Cut the receipt and open the cash drawer */
$printer -> cut();
$printer -> pulse();
$printer -> close();
/* A wrapper to do organise item names & prices into columns */
class item {
private $name;
private $price;
private $dollarSign;
public function __construct($name = '', $price = '', $dollarSign = false) {
$this -> name = $name;
$this -> price = $price;
$this -> dollarSign = $dollarSign;
}
public function __toString() {
$rightCols = 10;
$leftCols = 38;
if($this -> dollarSign) {
$leftCols = $leftCols / 2 - $rightCols / 2;
}
$left = str_pad($this -> name, $leftCols) ;
$sign = ($this -> dollarSign ? '$ ' : '');
$right = str_pad($sign . $this -> price, $rightCols, ' ', STR_PAD_LEFT);
return "$left$right\n";
}
}
?>

35
htdocs/includes/mike42/escpos-php/example/resources/character-encoding-test-strings.inc
View File

@@ -1,35 +0,0 @@
<?php
/* All strings from EscposPrintBufferTest are included below- These are fully supported
* on the default profile, so you can use them to test modified profiles (using the wrong
* profile for a printer produces mojibake) */
$inputsOk = array(
"Danish" => "Quizdeltagerne spiste jordbær med fløde, mens cirkusklovnen Wolther spillede på xylofon.\n",
"German" => "Falsches Üben von Xylophonmusik quält jeden größeren Zwerg.\n",
"Greek" => "Ξεσκεπάζω την ψυχοφθόρα βδελυγμία\n",
"English" => "The quick brown fox jumps over the lazy dog.\n",
"Spanish" => "El pingüino Wenceslao hizo kilómetros bajo exhaustiva lluvia y frío, añoraba a su querido cachorro.\n",
"French" => "Le cœur déçu mais l'âme plutôt naïve, Louÿs rêva de crapaüter en canoë au delà des îles, près du mälström où brûlent les novæ.\n",
"Irish Gaelic" => "D'fhuascail Íosa, Úrmhac na hÓighe Beannaithe, pór Éava agus Ádhaimh.\n",
"Hungarian" => "Árvíztűrő tükörfúrógép.\n",
"Icelandic" => "Kæmi ný öxi hér ykist þjófum nú bæði víl og ádrepa.\n",
"Latvian" => "Glāžšķūņa rūķīši dzērumā čiepj Baha koncertflīģeļu vākus.\n",
"Polish" => "Pchnąć w tę łódź jeża lub ośm skrzyń fig.\n",
"Russian" => "В чащах юга жил бы цитрус? Да, но фальшивый экземпляр!\n",
"Turkish" => "Pijamalı hasta, yağız şoföre çabucak güvendi.\n",
"Japanese (Katakana half-width)" => implode("\n", array("ｲﾛﾊﾆﾎﾍﾄ ﾁﾘﾇﾙｦ ﾜｶﾖﾀﾚｿ ﾂﾈﾅﾗﾑ", "ｳｲﾉｵｸﾔﾏ ｹﾌｺｴﾃ ｱｻｷﾕﾒﾐｼ ｴﾋﾓｾｽﾝ")) . "\n"
);
/*
* These strings are not expected to print correctly, if at all, even on an Epson printer. This is due to a mix of
* escpos driver, printer, and PHP language support issues.
*
* They are included here as a collection of things not yet implemented.
*/
$inputsNotOk = array(
"Thai (No character encoder available)" => "นายสังฆภัณฑ์ เฮงพิทักษ์ฝั่ง ผู้เฒ่าซึ่งมีอาชีพเป็นฅนขายฃวด ถูกตำรวจปฏิบัติการจับฟ้องศาล ฐานลักนาฬิกาคุณหญิงฉัตรชฎา ฌานสมาธิ\n",
"Japanese (Hiragana)" => implode("\n", array("いろはにほへとちりぬるを", " わかよたれそつねならむ", "うゐのおくやまけふこえて", "あさきゆめみしゑひもせす")) . "\n",
"Japanese (Katakana full-width)" => implode("\n", array("イロハニホヘト チリヌルヲ ワカヨタレソ ツネナラム", "ウヰノオクヤマ ケフコエテ アサキユメミシ ヱヒモセスン")) . "\n",
"Arabic (RTL not supported, encoding issues)" => "صِف خَلقَ خَودِ كَمِثلِ الشَمسِ إِذ بَزَغَت — يَحظى الضَجيعُ بِها نَجلاءَ مِعطارِ" . "\n",
"Hebrew (RTL not supported, line break issues)" => "דג סקרן שט בים מאוכזב ולפתע מצא לו חברה איך הקליטה" . "\n"
);

BIN
htdocs/includes/mike42/escpos-php/example/resources/document.odt
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/example/resources/document.pdf
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/example/resources/document.z
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/example/resources/escpos-php-small.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.9 KiB

BIN
htdocs/includes/mike42/escpos-php/example/resources/escpos-php.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 7.7 KiB

BIN
htdocs/includes/mike42/escpos-php/example/resources/tux.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.1 KiB

21
htdocs/includes/mike42/escpos-php/example/specific/29-latvian-star-tup592.php
View File

@@ -1,21 +0,0 @@
<?php
require_once(dirname(__FILE__) . "/../../Escpos.php");
/* This example shows the printing of Latvian text on the Star TUP 592 printer */
$profile = StarCapabilityProfile::getInstance();
/* Option 1: Native character encoding */
$connector = new FilePrintConnector("php://stdout");
$printer = new Escpos($connector, $profile);
$printer -> text("Glāžšķūņa rūķīši dzērumā čiepj Baha koncertflīģeļu vākus\n");
$printer -> cut();
$printer -> close();
/* Option 2: Image-based output (formatting not available using this output) */
$buffer = new ImagePrintBuffer();
$connector = new FilePrintConnector("php://stdout");
$printer = new Escpos($connector, $profile);
$printer -> setPrintBuffer($buffer);
$printer -> text("Glāžšķūņa rūķīši dzērumā čiepj Baha koncertflīģeļu vākus\n");
$printer -> cut();
$printer -> close();
?>

36
htdocs/includes/mike42/escpos-php/example/specific/32-german-tm-t20-ii-custom-command.php
View File

@@ -1,36 +0,0 @@
<?php
require_once(dirname(__FILE__) . "/../../Escpos.php");
/*
* This example shows how tok send a custom command to the printer-
* The use case here is an Epson TM-T20II and German text.
*
* Background: Not all ESC/POS features are available in the driver, so sometimes
* you might want to send a custom commnad. This is useful for testing
* new features.
*
* The Escpos::text() function removes non-printable characters as a precaution,
* so that commands cannot be injected into user input. To send raw data to
* the printer, you need to write bytes to the underlying PrintConnector.
*
* If you get a new command working, please file an issue on GitHub with a code
* snippet so that it can be incorporated into escpos-php.
*/
/* Set up profile & connector */
$connector = new FilePrintConnector("php://output");
$profile = DefaultCapabilityProfile::getInstance(); // Works for Epson printers
$printer = new Escpos($connector, $profile);
$cmd = Escpos::ESC . "V" . chr(1); // Try out 90-degree rotation.
$printer -> getPrintConnector() -> write($cmd);
$printer -> text("Beispieltext in Deutsch\n");
$printer -> cut();
$printer -> close();
/*
* Hex-dump of output confirms that ESC V 1 being sent:
*
* 0000000 033 @ 033 V 001 B e i s p i e l t e x
* 0000010 t i n D e u t s c h \n 035 V A
* 0000020 003
*/

16
htdocs/includes/mike42/escpos-php/example/specific/33-spanish-seypos-prp-300.php
View File

@@ -1,16 +0,0 @@
<?php
/*
* Example of printing Spanish text on SEYPOS PRP-300 thermal line printer.
* The characters in Spanish are available in code page 437, so no special
* code pages are needed in this case (SimpleCapabilityProfile).
*
* Use the hardware switch to activate "Two-byte Character Code"
*/
require_once(dirname(__FILE__) . "/../../Escpos.php");
$connector = new FilePrintConnector("php://output");
$profile = SimpleCapabilityProfile::getInstance();
$printer = new Escpos($connector);
$printer -> text("El pingüino Wenceslao hizo kilómetros bajo exhaustiva lluvia y frío, añoraba a su querido cachorro.\n");
$printer -> cut();
$printer -> close();

69
htdocs/includes/mike42/escpos-php/example/specific/39-currency-symbols.php
View File

@@ -1,69 +0,0 @@
<?php
require_once(dirname(__FILE__) . "/../../Escpos.php");
$profile = DefaultCapabilityProfile::getInstance();
// This is a quick demo of currency symbol issues in #39.
/* Option 1: Native ESC/POS characters, depends on printer and is buggy. */
$connector = new FilePrintConnector("php://stdout");
$printer = new Escpos($connector, $profile);
$printer -> text("€ 9,95\n");
$printer -> text("£ 9.95\n");
$printer -> text("$ 9.95\n");
$printer -> text("¥ 9.95\n");
$printer -> cut();
$printer -> close();
/* Option 2: Image-based output (formatting not available using this output). */
$buffer = new ImagePrintBuffer();
$connector = new FilePrintConnector("php://stdout");
$printer = new Escpos($connector, $profile);
$printer -> setPrintBuffer($buffer);
$printer -> text("€ 9,95\n");
$printer -> text("£ 9.95\n");
$printer -> text("$ 9.95\n");
$printer -> text("¥ 9.95\n");
$printer -> cut();
$printer -> close();
/*
Option 3: If the printer is configured to print in a specific code
page, you can set up a CapabilityProfile which either references its
iconv encoding name, or includes all of the available characters.
Here, we make use of CP858 for its inclusion of currency symbols which
are not available in CP437. CP858 has good printer support, but is not
included in all iconv builds.
*/
class CustomCapabilityProfile extends SimpleCapabilityProfile {
function getCustomCodePages() {
/*
* Example to print in a specific, user-defined character set
* on a printer which has been configured to use i
*/
return array(
'CP858' => "ÇüéâäàåçêëèïîìÄÅ" .
"ÉæÆôöòûùÿÖÜø£Ø׃" .
"áíóúñѪº¿®¬½¼¡«»" .
"░▒▓│┤ÁÂÀ©╣║╗╝¢¥┐" .
"└┴┬├─┼ãÃ╚╔╩╦╠═╬¤" .
"ðÐÊËÈ€ÍÎÏ┘┌█▄¦Ì▀" .
"ÓßÔÒõÕµþÞÚÛÙýݯ´" .
" ±‗¾¶§÷¸°¨·¹³²■ ");
}
function getSupportedCodePages() {
return array(
0 => 'custom:CP858');
}
}
$connector = new FilePrintConnector("php://stdout");
$profile = CustomCapabilityProfile::getInstance();
$printer = new Escpos($connector, $profile);
$printer -> text("€ 9,95\n");
$printer -> text("£ 9.95\n");
$printer -> text("$ 9.95\n");
$printer -> text("¥ 9.95\n");
$printer -> cut();
$printer -> close();

31
htdocs/includes/mike42/escpos-php/example/specific/44-pound-symbol-star-tsp650.php
View File

@@ -1,31 +0,0 @@
<?php
/* Example of printing the GBP pound symbol on a STAR TSP650
*
* In this example, it's shown how to check that your PHP files are actually being
* saved in unicode. Sections B) and C) are identical in UTF-8, but different
* if you are saving to a retro format like Windows-1252.
*/
// Adjust these to your environment
require_once(dirname(__FILE__) . "/../../Escpos.php");
$connector = new FilePrintConnector("php://stdout");
// Start printer
$profile = SimpleCapabilityProfile::getInstance();
$printer = new Escpos($connector, $profile);
// A) Raw pound symbol
// This is the most likely thing to work, and bypasses all the fancy stuff.
$printer -> textRaw("\x9C"); // based on position in CP437
$printer -> text(" 1.95\n");
// B) Manually encoded UTF8 pound symbol. Tests that the driver correctly
// encodes this as CP437.
$printer -> text(base64_decode("wqM=") . " 2.95\n");
// C) Pasted in file. Tests that your files are being saved as UTF-8, which
// escpos-php is able to convert automatically to a mix of code pages.
$printer -> text("£ 3.95\n");
$printer -> cut();
$printer -> close();

16
htdocs/includes/mike42/escpos-php/example/specific/50-P-822D-greek.php
View File

@@ -1,16 +0,0 @@
<?php
/* Example of Greek text on the P-822D */
require_once(dirname(__FILE__) . "/../../Escpos.php");
// Setup the printer
$connector = new FilePrintConnector("php://stdout");
$profile = P822DCapabilityProfile::getInstance();
$printer = new Escpos($connector, $profile);
// Print a Greek pangram
$text = "Ξεσκεπάζω την ψυχοφθόρα βδελυγμία";
$printer -> text($text . "\n");
$printer -> cut();
// Close the connection
$printer -> close();

58
htdocs/includes/mike42/escpos-php/example/specific/54-gfx-sidebyside.php
View File

@@ -1,58 +0,0 @@
<?php
/*
* Example of calling ImageMagick 'convert' to manipulate an image prior to printing.
*
* Written as an example to remind you to do four things-
* - escape your command-line arguments with escapeshellarg
* - close the printer
* - delete any temp files
* - detect and handle external command failure
*
* Note that image operations are slow. You can and should serialise an EscposImage
* object into some sort of cache if you will re-use the output.
*/
require_once (dirname ( __FILE__ ) . "/../../Escpos.php");
// Paths to images to combine
$img1_path = dirname ( __FILE__ ) . "/../resources/tux.png";
$img2_path = dirname ( __FILE__ ) . "/../resources/escpos-php.png";
// Set up temp file with .png extension
$tmpf_path = tempnam ( sys_get_temp_dir (), 'escpos-php' );
$imgCombined_path = $tmpf_path . ".png";
try {
// Convert, load image, remove temp files
$cmd = sprintf ("convert %s %s +append %s",
escapeshellarg ( $img1_path ),
escapeshellarg ( $img2_path ),
escapeshellarg ( $imgCombined_path ));
exec($cmd, $outp, $retval);
if($retval != 0) {
// Detect and handle command failure
throw new Exception("Command \"$cmd\" returned $retval." . implode("\n", $outp));
}
$img = new EscposImage ( $imgCombined_path );
// Setup the printer
$connector = new FilePrintConnector ( "php://stdout" );
$profile = DefaultCapabilityProfile::getInstance ();
// Run the actual print
$printer = new Escpos ( $connector, $profile );
try {
$printer -> setJustification(Escpos::JUSTIFY_CENTER);
$printer -> graphics($img);
$printer -> cut();
} finally {
// Always close the connection
$printer -> close();
}
} catch (Exception $e) {
// Print out any errors: Eg. printer connection, image loading & external image manipulation.
echo $e -> getMessage() . "\n";
echo $e -> getTraceAsString();
} finally {
unlink ( $imgCombined_path );
unlink ( $tmpf_path );
}

47
htdocs/includes/mike42/escpos-php/example/specific/6-arabic-epos-tep-220m.php
View File

@@ -1,47 +0,0 @@
<?php
/*
* This example shows Arabic image-based output on the EPOS TEP 220m.
*
* Because escpos-php is not yet able to render Arabic correctly
* on thermal line printers, small images are generated and sent
* instead. This is a bit slower, and only limited formatting
* is currently available in this mode.
*
* Requirements are:
* - imagick extension (For the ImagePrintBuffer, which does not
* support gd at the time of writing)
* - Ar-PHP library, available from sourceforge, for the first
* part of this example. Drop it in the folder listed below:
*/
require_once(dirname(__FILE__) . "/../../Escpos.php");
require_once(dirname(__FILE__) . "/../../vendor/I18N/Arabic.php");
/*
* First, convert the text into LTR byte order with joined letters,
* Using the Ar-PHP library.
*
* The Ar-PHP library uses the default internal encoding, and can print
* a lot of errors depending on the input, so be prepared to debug
* the next four lines.
*
* Note that this output shows that numerals are converted to placeholder
* characters, indicating that western numerals (123) have to be used instead.
*/
mb_internal_encoding("UTF-8");
$Arabic = new I18N_Arabic('Glyphs');
$text = "صِف خَلقَ خَودِ كَمِثلِ الشَمسِ إِذ بَزَغَت — يَحظى الضَجيعُ بِها نَجلاءَ مِعطارِ";
$text = $Arabic -> utf8Glyphs($text);
/*
* Set up and use the printer
*/
$buffer = new ImagePrintBuffer();
$profile = EposTepCapabilityProfile::getInstance();
$connector = new FilePrintConnector("php://output");
// = WindowsPrintConnector("LPT2");
// Windows LPT2 was used in the bug tracker
$printer = new Escpos($connector, $profile);
$printer -> setPrintBuffer($buffer);
$printer -> text($text . "\n");
$printer -> close();

7
htdocs/includes/mike42/escpos-php/example/specific/README.md
View File

@@ -1,7 +0,0 @@
Specific examples
-----------------
These examples are designed for specific combinations of language,
printer and interface.
They are documented here because the general examples all set up the printer in a similar way.

62
htdocs/includes/mike42/escpos-php/example/text-size.php
View File

@@ -1,62 +0,0 @@
<?php
/**
* This print-out shows how large the available font sizes are. It is included
* separately due to the amount of text it prints.
*
* @author Michael Billington <michael.billington@gmail.com>
*/
require_once(dirname(__FILE__) . "/../Escpos.php");
$printer = new Escpos();
/* Initialize */
$printer -> initialize();
/* Text of various (in-proportion) sizes */
title($printer, "Change height & width\n");
for($i = 1; $i <= 8; $i++) {
$printer -> setTextSize($i, $i);
$printer -> text($i);
}
$printer -> text("\n");
/* Width changing only */
title($printer, "Change width only (height=4):\n");
for($i = 1; $i <= 8; $i++) {
$printer -> setTextSize($i, 4);
$printer -> text($i);
}
$printer -> text("\n");
/* Height changing only */
title($printer, "Change height only (width=4):\n");
for($i = 1; $i <= 8; $i++) {
$printer -> setTextSize(4, $i);
$printer -> text($i);
}
$printer -> text("\n");
/* Very narrow text */
title($printer, "Very narrow text:\n");
$printer -> setTextSize(1, 8);
$printer -> text("The quick brown fox jumps over the lazy dog.\n");
/* Very flat text */
title($printer, "Very wide text:\n");
$printer -> setTextSize(4, 1);
$printer -> text("Hello world!\n");
/* Very large text */
title($printer, "Largest possible text:\n");
$printer -> setTextSize(8,8);
$printer -> text("Hello\nworld!\n");
$printer -> cut();
$printer -> close();
function title(Escpos $printer, $text) {
$printer -> selectPrintMode(Escpos::MODE_EMPHASIZED);
$printer -> text("\n" . $text);
$printer -> selectPrintMode(); // Reset
}
?>

21
htdocs/includes/mike42/escpos-php/phpunit.xml Normal file
View File

@@ -0,0 +1,21 @@
<phpunit bootstrap="test/bootstrap.php"
timeoutForSmallTests="1"
timeoutForMediumTests="10"
timeoutForLargeTests="60"
verbose="true"
>
<testsuites>
<testsuite name="unit">
<directory>test/unit</directory>
</testsuite>
<testsuite name="integration">
<directory>test/integration</directory>
</testsuite>
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">src</directory>
</whitelist>
</filter>
</phpunit>

61
htdocs/includes/mike42/escpos-php/src/AbstractCapabilityProfile.php
View File

@@ -1,61 +0,0 @@
<?php
/**
* Not all printers support the same subset of available Esc/POS commands. Profiles allow you to specify
* which features are available on your printer, so that Escpos is less likely to send unsupported commands.
*/
abstract class AbstractCapabilityProfile {
/**
* Sub-classes must be retrieved via getInstance(), so that validation
* can be attached to guarantee that dud profiles are not used on an Escpos object.
*/
protected final function __construct() {
// This space intentionally left blank.
}
/**
* If getSupportedCodePages contains custom code pages, their character maps must be provided here.
*/
abstract function getCustomCodePages();
/**
* Return a map of code page numbers to names for this printer. Names
* should match iconv code page names where possible (non-matching names will not be used).
*/
abstract function getSupportedCodePages();
/**
* True to support barcode "function b", false to use only function A.
*/
abstract function getSupportsBarcodeB();
/**
* True for bitImage support, false for no bitImage support.
*/
abstract function getSupportsBitImage();
/**
* True for graphics support, false for no graphics support.
*/
abstract function getSupportsGraphics();
/**
* True for 'STAR original' commands, false for standard ESC/POS only.
*/
abstract function getSupportsStarCommands();
/**
* True if the printer renders its own QR codes, false to send an image.
*/
abstract function getSupportsQrCode();
/**
* @return AbstractCapabilityProfile Instance of sub-class.
*/
public static final function getInstance() {
static $profile = null;
if ($profile === null) {
$profile = new static();
}
return $profile;
}
}

181
htdocs/includes/mike42/escpos-php/src/CodePage.php
View File

@@ -1,181 +0,0 @@
<?php
abstract class CodePage {
/** Code page constants, exported from iconv -l. Can be cut down*/
const CP037 = "CP037";
const CP038 = "CP038";
const CP273 = "CP273";
const CP274 = "CP274";
const CP275 = "CP275";
const CP278 = "CP278";
const CP280 = "CP280";
const CP281 = "CP281";
const CP282 = "CP282";
const CP284 = "CP284";
const CP285 = "CP285";
const CP290 = "CP290";
const CP297 = "CP297";
const CP367 = "CP367";
const CP420 = "CP420";
const CP423 = "CP423";
const CP424 = "CP424";
const CP437 = "CP437";
const CP500 = "CP500";
const CP737 = "CP737";
const CP770 = "CP770";
const CP771 = "CP771";
const CP772 = "CP772";
const CP773 = "CP773";
const CP774 = "CP774";
const CP775 = "CP775";
const CP803 = "CP803";
const CP813 = "CP813";
const CP819 = "CP819";
const CP850 = "CP850";
const CP851 = "CP851";
const CP852 = "CP852";
const CP855 = "CP855";
const CP856 = "CP856";
const CP857 = "CP857";
const CP860 = "CP860";
const CP861 = "CP861";
const CP862 = "CP862";
const CP863 = "CP863";
const CP864 = "CP864";
const CP865 = "CP865";
const CP866 = "CP866";
const CP866NAV = "CP866NAV";
const CP868 = "CP868";
const CP869 = "CP869";
const CP870 = "CP870";
const CP871 = "CP871";
const CP874 = "CP874";
const CP875 = "CP875";
const CP880 = "CP880";
const CP891 = "CP891";
const CP901 = "CP901";
const CP902 = "CP902";
const CP903 = "CP903";
const CP904 = "CP904";
const CP905 = "CP905";
const CP912 = "CP912";
const CP915 = "CP915";
const CP916 = "CP916";
const CP918 = "CP918";
const CP920 = "CP920";
const CP921 = "CP921";
const CP922 = "CP922";
const CP930 = "CP930";
const CP932 = "CP932";//
const CP933 = "CP933";
const CP935 = "CP935";
const CP936 = "CP936";
const CP937 = "CP937";
const CP939 = "CP939";
const CP949 = "CP949";
const CP950 = "CP950";
const CP1004 = "CP1004";
const CP1008 = "CP1008";
const CP1025 = "CP1025";
const CP1026 = "CP1026";
const CP1046 = "CP1046";
const CP1047 = "CP1047";
const CP1070 = "CP1070";
const CP1079 = "CP1079";
const CP1081 = "CP1081";
const CP1084 = "CP1084";
const CP1089 = "CP1089";
const CP1097 = "CP1097";
const CP1112 = "CP1112";
const CP1122 = "CP1122";
const CP1123 = "CP1123";
const CP1124 = "CP1124";
const CP1125 = "CP1125";
const CP1129 = "CP1129";
const CP1130 = "CP1130";
const CP1132 = "CP1132";
const CP1133 = "CP1133";
const CP1137 = "CP1137";
const CP1140 = "CP1140";
const CP1141 = "CP1141";
const CP1142 = "CP1142";
const CP1143 = "CP1143";
const CP1144 = "CP1144";
const CP1145 = "CP1145";
const CP1146 = "CP1146";
const CP1147 = "CP1147";
const CP1148 = "CP1148";
const CP1149 = "CP1149";
const CP1153 = "CP1153";
const CP1154 = "CP1154";
const CP1155 = "CP1155";
const CP1156 = "CP1156";
const CP1157 = "CP1157";
const CP1158 = "CP1158";
const CP1160 = "CP1160";
const CP1161 = "CP1161";
const CP1162 = "CP1162";
const CP1163 = "CP1163";
const CP1164 = "CP1164";
const CP1166 = "CP1166";
const CP1167 = "CP1167";
const CP1250 = "CP1250";
const CP1251 = "CP1251";
const CP1252 = "CP1252";
const CP1253 = "CP1253";
const CP1254 = "CP1254";
const CP1255 = "CP1255";
const CP1256 = "CP1256";
const CP1257 = "CP1257";
const CP1258 = "CP1258";
const CP1282 = "CP1282";
const CP1361 = "CP1361";
const CP1364 = "CP1364";
const CP1371 = "CP1371";
const CP1388 = "CP1388";
const CP1390 = "CP1390";
const CP1399 = "CP1399";
const CP4517 = "CP4517";
const CP4899 = "CP4899";
const CP4909 = "CP4909";
const CP4971 = "CP4971";
const CP5347 = "CP5347";
const CP9030 = "CP9030";
const CP9066 = "CP9066";
const CP9448 = "CP9448";
const CP10007 = "CP10007";
const CP12712 = "CP12712";
const CP16804 = "CP16804";
const ISO8859_7 = "ISO_8859-7";
const ISO8859_2 = "ISO_8859-2";
const ISO8859_15 = "ISO_8859-15";
const RK1048 = "RK1048";
// Code pages which are not built in
// to default iconv on Debian.
const CP720 = false;
const CP853 = false;
const CP858 = false;
const CP928 = false;
const CP1098 = false;
const CP747 = false;
/*
* Below code pages appear to be vendor-specific (Star), so iconv wont use them
* They are being merged gradually into the StarCapabilityProfile.
*/
const CP3840 = false;
const CP3841 = false;
const CP3843 = false;
const CP3844 = false;
const CP3845 = false;
const CP3847 = false;
const CP3846 = false;
const CP3848 = false;
const CP1001 = false;
const CP2001 = false;
const CP3001 = false;
const CP3002 = false;
const CP3011 = false;
const CP3012 = false;
const CP3021 = false;
const CP3041 = false;
}

103
htdocs/includes/mike42/escpos-php/src/DefaultCapabilityProfile.php
View File

@@ -1,103 +0,0 @@
<?php
/**
* This capability profile matches many recent Epson-branded thermal receipt printers.
*
* For non-Epson printers, try the SimpleCapabilityProfile.
*/
class DefaultCapabilityProfile extends AbstractCapabilityProfile {
function getCustomCodePages() {
return array();
}
function getSupportedCodePages() {
/* Character code tables which the printer understands, mapping to known encoding standards we may be able to encode to.
*
* See CodePage.php for the mapping of these standards to encoding names for use in the backing library.
*
* Any entry with 'false' means I haven't compared the print-out of the code page to a table.
*/
return array(
0 => CodePage::CP437,
1 => CodePage::CP932,
2 => CodePage::CP850,
3 => CodePage::CP860,
4 => CodePage::CP863,
5 => CodePage::CP865,
6 => false, // Hiragana
7 => false, // One-pass printing Kanji characters
8 => false, // Page 8 [One-pass printing Kanji characters]
11 => CodePage::CP851,
12 => CodePage::CP853,
13 => CodePage::CP857,
14 => CodePage::CP737,
15 => CodePage::ISO8859_7,
16 => CodePage::CP1252,
17 => CodePage::CP866,
18 => CodePage::CP852,
19 => CodePage::CP858,
20 => false, // Thai Character Code 42
21 => CodePage::CP874, // Thai Character Code 11
22 => false, // Thai Character Code 13
23 => false, // Thai Character Code 14
24 => false, // Thai Character Code 16
25 => false, // Thai Character Code 17
26 => false, // Thai Character Code 18
30 => false, // TCVN-3: Vietnamese
31 => false, // TCVN-3: Vietnamese
32 => CodePage::CP720,
33 => CodePage::CP775,
34 => CodePage::CP855,
35 => CodePage::CP861,
36 => CodePage::CP862,
37 => CodePage::CP864,
38 => CodePage::CP869,
39 => CodePage::ISO8859_2,
40 => CodePage::ISO8859_15,
41 => CodePage::CP1098, // PC1098: Farsi
42 => CodePage::CP774,
43 => CodePage::CP772,
44 => CodePage::CP1125,
45 => CodePage::CP1250,
46 => CodePage::CP1251,
47 => CodePage::CP1253,
48 => CodePage::CP1254,
49 => CodePage::CP1255,
50 => CodePage::CP1256,
51 => CodePage::CP1257,
52 => CodePage::CP1258,
53 => CodePage::RK1048,
66 => false, // Devanagari
67 => false, // Bengali
68 => false, // Tamil
69 => false, // Telugu
70 => false, // Assamese
71 => false, // Oriya
72 => false, // Kannada
73 => false, // Malayalam
74 => false, // Gujarati
75 => false, // Punjabi
82 => false, // Marathi
254 => false,
255 => false);
}
function getSupportsBarcodeB() {
return true;
}
function getSupportsBitImage() {
return true;
}
function getSupportsGraphics() {
return true;
}
function getSupportsStarCommands() {
return false;
}
function getSupportsQrCode() {
return true;
}
}

78
htdocs/includes/mike42/escpos-php/src/DummyPrintConnector.php
View File

@@ -1,78 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Print connector that writes to nowhere, but allows the user to retrieve the
* buffered data. Used for testing.
*/
final class DummyPrintConnector implements PrintConnector {
/**
* @var array Buffer of accumilated data.
*/
private $buffer;
/**
* @var string data which the printer will provide on next read
*/
private $readData;
/**
* Create new print connector
*/
public function __construct() {
$this -> buffer = array();
}
public function __destruct() {
if($this -> buffer !== null) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
public function finalize() {
$this -> buffer = null;
}
/**
* @return string Get the accumulated data that has been sent to this buffer.
*/
public function getData() {
return implode($this -> buffer);
}
/* (non-PHPdoc)
* @see PrintConnector::read()
*/
public function read($len) {
return $len >= strlen($this -> readData) ? $this -> readData : substr($this -> readData, 0, $len);
}
public function write($data) {
$this -> buffer[] = $data;
}
}

4
htdocs/includes/mike42/escpos-php/src/EposTepCapabilityProfile.php
View File

@@ -1,4 +0,0 @@
<?php
class EposTepCapabilityProfile extends DefaultCapabilityProfile {
// TODO override list of code pages
}

405
htdocs/includes/mike42/escpos-php/src/EscposImage.php
View File

@@ -1,405 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This class deals with images in raster formats, and converts them into formats
* which are suitable for use on thermal receipt printers. Currently, only PNG
* images (in) and ESC/POS raster format (out) are implemeted.
*
* Input formats:
* - Currently, only PNG is supported.
* - Other easily read raster formats (jpg, gif) will be added at a later date, as this is not complex.
* - The BMP format can be directly read by some commands, but this has not yet been implemented.
*
* Output formats:
* - Currently, only ESC/POS raster format is supported
* - ESC/POS 'column format' support is partially implemented, but is not yet used by Escpos.php library.
* - Output as multiple rows of column format image is not yet in the works.
*
* Libraries:
* - Currently, php-gd is used to read the input. Support for imagemagick where gd is not installed is
* also not complex to add, and is a likely future feature.
* - Support for native use of the BMP format is a goal, for maximum compatibility with target environments.
*/
class EscposImage {
/**
* @var string The image's bitmap data (if it is a Windows BMP).
*/
protected $imgBmpData;
/**
* @var string image data in rows: 1 for black, 0 for white.
*/
protected $imgData;
/**
* @var string cached raster format data to avoid re-computation
*/
protected $imgRasterData;
/**
* @var int height of the image
*/
protected $imgHeight;
/**
* @var int width of the image
*/
protected $imgWidth;
/**
* Load up an image from a filename
*
* @param string $imgPath The path to the image to load, or null to skip
* loading the image (some other functions are available for
* populating the data). Supported graphics types depend on your PHP configuration.
*/
public function __construct($imgPath = null) {
/* Can't use bitmaps yet */
$this -> imgBmpData = null;
$this -> imgRasterData = null;
if($imgPath === null) {
// Blank image
$this -> imgHeight = 0;
$this -> imgWidth = 0;
$this -> imgData = "";
return;
}
/* Load up using GD */
if(!file_exists($imgPath)) {
throw new Exception("File '$imgPath' does not exist.");
}
$ext = pathinfo($imgPath, PATHINFO_EXTENSION);
if($ext == "bmp") {
// The plan is to implement BMP handling directly in
// PHP, as some printers understand this format themselves.
// TODO implement PHP bitmap handling
throw new Exception("Native bitmaps not yet supported. Please convert the file to a supported raster format.");
}
if($this -> isGdSupported()) {
// Prefer to use gd. It is installed by default, so
// most systems will have it, giving a consistent UX.
switch($ext) {
case "png":
$im = @imagecreatefrompng($imgPath);
$this -> readImageFromGdResource($im);
return;
case "jpg":
$im = @imagecreatefromjpeg($imgPath);
$this -> readImageFromGdResource($im);
return;
case "gif":
$im = @imagecreatefromgif($imgPath);
$this -> readImageFromGdResource($im);
return;
}
}
if($this -> isImagickSupported()) {
$im = new Imagick();
try {
// Throws an ImagickException if the format is not supported or file is not found
$im -> readImage($imgPath);
} catch(ImagickException $e) {
// Wrap in normal exception, so that classes which call this do not themselves require imagick as a dependency.
throw new Exception($e);
}
/* Flatten by doing a composite over white, in case of transparency */
$flat = new Imagick();
$flat -> newImage($im -> getimagewidth(), $im -> getimageheight(), "white");
$flat -> compositeimage($im, Imagick::COMPOSITE_OVER, 0, 0);
$this -> readImageFromImagick($flat);
return;
}
throw new Exception("Images are not supported on your PHP. Please install either the gd or imagick extension.");
}
/**
* @return int height of the image in pixels
*/
public function getHeight() {
return $this -> imgHeight;
}
/**
* @return int Number of bytes to represent a row of this image
*/
public function getHeightBytes() {
return (int)(($this -> imgHeight + 7) / 8);
}
/**
* @return int Width of the image
*/
public function getWidth() {
return $this -> imgWidth;
}
/**
* @return int Number of bytes to represent a row of this image
*/
public function getWidthBytes() {
return (int)(($this -> imgWidth + 7) / 8);
}
/**
* @return string binary data of the original file, for function which accept bitmaps.
*/
public function getWindowsBMPData() {
return $this -> imgBmpData;
}
/**
* @return boolean True if the image was a windows bitmap, false otherwise
*/
public function isWindowsBMP() {
return $this -> imgBmpData != null;
}
/**
* Load actual image pixels from GD resource.
*
* @param resouce $im GD resource to use
* @throws Exception Where the image can't be read.
*/
public function readImageFromGdResource($im) {
if(!is_resource($im)) {
throw new Exception("Failed to load image.");
} else if(!$this -> isGdSupported()) {
throw new Exception(__FUNCTION__ . " requires 'gd' extension.");
}
/* Make a string of 1's and 0's */
$this -> imgHeight = imagesy($im);
$this -> imgWidth = imagesx($im);
$this -> imgData = str_repeat("\0", $this -> imgHeight * $this -> imgWidth);
for($y = 0; $y < $this -> imgHeight; $y++) {
for($x = 0; $x < $this -> imgWidth; $x++) {
/* Faster to average channels, blend alpha and negate the image here than via filters (tested!) */
$cols = imagecolorsforindex($im, imagecolorat($im, $x, $y));
$greyness = (int)(($cols['red'] + $cols['green'] + $cols['blue']) / 3) >> 7; // 1 for white, 0 for black
$black = (1 - $greyness) >> ($cols['alpha'] >> 6); // 1 for black, 0 for white, taking into account transparency
$this -> imgData[$y * $this -> imgWidth + $x] = $black;
}
}
}
/**
* Load actual image pixels from Imagick object
*
* @param Imagick $im Image to load from
*/
public function readImageFromImagick(Imagick $im) {
/* Threshold */
$im -> setImageType(Imagick::IMGTYPE_TRUECOLOR); // Remove transparency (good for PDF's)
$max = $im->getQuantumRange();
$max = $max["quantumRangeLong"];
$im -> thresholdImage(0.5 * $max);
/* Make a string of 1's and 0's */
$geometry = $im -> getimagegeometry();
$this -> imgHeight = $im -> getimageheight();
$this -> imgWidth = $im -> getimagewidth();
$this -> imgData = str_repeat("\0", $this -> imgHeight * $this -> imgWidth);
for($y = 0; $y < $this -> imgHeight; $y++) {
for($x = 0; $x < $this -> imgWidth; $x++) {
/* Faster to average channels, blend alpha and negate the image here than via filters (tested!) */
$cols = $im -> getImagePixelColor($x, $y);
$cols = $cols -> getcolor();
$greyness = (int)(($cols['r'] + $cols['g'] + $cols['b']) / 3) >> 7; // 1 for white, 0 for black
$this -> imgData[$y * $this -> imgWidth + $x] = (1 - $greyness); // 1 for black, 0 for white
}
}
}
/**
* Output the image in raster (row) format. This can result in padding on the right of the image, if its width is not divisible by 8.
*
* @throws Exception Where the generated data is unsuitable for the printer (indicates a bug or oversized image).
* @return string The image in raster format.
*/
public function toRasterFormat() {
if($this -> imgRasterData != null) {
/* Use previous calculation */
return $this -> imgRasterData;
}
/* Loop through and convert format */
$widthPixels = $this -> getWidth();
$heightPixels = $this -> getHeight();
$widthBytes = $this -> getWidthBytes();
$heightBytes = $this -> getHeightBytes();
$x = $y = $bit = $byte = $byteVal = 0;
$data = str_repeat("\0", $widthBytes * $heightPixels);
if(strlen($data) == 0) {
return $data;
}
do {
$byteVal |= (int)$this -> imgData[$y * $widthPixels + $x] << (7 - $bit);
$x++;
$bit++;
if($x >= $widthPixels) {
$x = 0;
$y++;
$bit = 8;
if($y >= $heightPixels) {
$data[$byte] = chr($byteVal);
break;
}
}
if($bit >= 8) {
$data[$byte] = chr($byteVal);
$byteVal = 0;
$bit = 0;
$byte++;
}
} while(true);
if(strlen($data) != ($this -> getWidthBytes() * $this -> getHeight())) {
throw new Exception("Bug in " . __FUNCTION__ . ", wrong number of bytes.");
}
$this -> imgRasterData = $data;
return $this -> imgRasterData;
}
/**
* Output image in column format. This format results in padding at the base and right of the image, if its height and width are not divisible by 8.
*/
private function toColumnFormat() {
/* Note: This function is marked private, as it is not yet used/tested and may be buggy. */
$widthPixels = $this -> getWidth();
$heightPixels = $this -> getHeight();
$widthBytes = $this -> getWidthBytes();
$heightBytes = $this -> getHeightBytes();
$x = $y = $bit = $byte = $byteVal = 0;
$data = str_repeat("\0", $widthBytes * $heightBytes * 8);
do {
$byteVal |= (int)$this -> imgData[$y * $widthPixels + $x] << (8 - $bit);
$y++;
$bit++;
if($y >= $heightPixels) {
$y = 0;
$x++;
$bit = 8;
if($x >= $widthPixels) {
$data[$byte] = chr($byteVal);
break;
}
}
if($bit >= 8) {
$data[$byte] = chr($byteVal);
$byteVal = 0;
$bit = 0;
$byte++;
}
} while(true);
if(strlen($data) != ($widthBytes * $heightBytes * 8)) {
throw new Exception("Bug in " . __FUNCTION__ . ", wrong number of bytes. Should be " . ($widthBytes * $heightBytes * 8) . " but was " . strlen($data));
}
return $data;
}
/**
* @return boolean True if GD is supported, false otherwise (a wrapper for the static version, for mocking in tests)
*/
protected function isGdSupported() {
return self::isGdLoaded();
}
/**
* @return boolean True if Imagick is supported, false otherwise (a wrapper for the static version, for mocking in tests)
*/
protected function isImagickSupported() {
return self::isImagickLoaded();
}
/**
* @return boolean True if GD is loaded, false otherwise
*/
public static function isGdLoaded() {
return extension_loaded('gd');
}
/**
* @return boolean True if Imagick is loaded, false otherwise
*/
public static function isImagickLoaded() {
return extension_loaded('imagick');
}
/**
* Load a PDF for use on the printer
*
* @param string $pdfFile The file to load
* @param string $pageWidth The width, in pixels, of the printer's output. The first page of the PDF will be scaled to approximately fit in this area.
* @param array $range array indicating the first and last page (starting from 0) to load. If not set, the entire document is loaded.
* @throws Exception Where Imagick is not loaded, or where a missing file or invalid page number is requested.
* @return multitype:EscposImage Array of images, retrieved from the PDF file.
*/
public static function loadPdf($pdfFile, $pageWidth = 550, array $range = null) {
if(!extension_loaded('imagick')) {
throw new Exception(__FUNCTION__ . " requires imagick extension.");
}
/*
* Load first page at very low density (resolution), to figure out what
* density to use to achieve $pageWidth
*/
try {
$image = new Imagick();
$testRes = 2; // Test resolution
$image -> setresolution($testRes, $testRes);
$image -> readimage($pdfFile."[0]");
$geo = $image -> getimagegeometry();
$image -> destroy();
$width = $geo['width'];
$newRes = $pageWidth / $width * $testRes;
/* Load actual document (can be very slow!) */
$rangeStr = ""; // Set to [0] [0-1] page range if $range is set
if($range != null) {
if(count($range) != 2 || !isset($range[0]) || !is_integer($range[0]) || !isset($range[1]) || !is_integer($range[1]) || $range[0] > $range[1]) {
throw new Exception("Invalid range. Must be two numbers in the array: The start and finish page indexes, starting from 0.");
}
$rangeStr = "[" . ($range[0] == $range[1] ? $range[0] : implode($range, "-")) . "]";
}
$image -> setresolution($newRes, $newRes);
$image -> readImage($pdfFile."$rangeStr");
$pages = $image -> getNumberImages();
/* Convert images to Escpos objects */
$ret = array();
for($i = 0;$i < $pages; $i++) {
$image -> setIteratorIndex($i);
$ep = new EscposImage();
$ep -> readImageFromImagick($image);
$ret[] = $ep;
}
return $ret;
} catch(ImagickException $e) {
// Wrap in normal exception, so that classes which call this do not themselves require imagick as a dependency.
throw new Exception($e);
}
}
}

304
htdocs/includes/mike42/escpos-php/src/EscposPrintBuffer.php
View File

@@ -1,304 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This class manages newlines and character encoding for the target printer, and
* can be interchanged for an image-bassed buffer (ImagePrintBuffer) if you can't
* get it operating properly on your machine.
*/
class EscposPrintBuffer implements PrintBuffer {
/**
* @var boolean True to cache output as .gz, false to leave un-compressed (useful for debugging)
*/
const COMPRESS_CACHE = true;
/**
* @var string The input encoding of the buffer.
*/
const INPUT_ENCODING = "UTF-8";
/**
* @var string Un-recorgnised characters will be replaced with this.
*/
const REPLACEMENT_CHAR = "?";
/**
* This array Maps ESC/POS character tables to names iconv encodings
*/
private $available = null;
/**
* @var array Maps of UTF-8 to code-pages
*/
private $encode = null;
/**
* @var Escpos Printer for output
*/
private $printer;
/**
* Empty print buffer.
*/
function __construct() {
$this -> printer = null;
}
public function flush() {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
// TODO Not yet implemented for this buffer: This indicates that the printer needs the current line to be ended.
}
public function getPrinter() {
return $this -> printer;
}
public function setPrinter(Escpos $printer = null) {
$this -> printer = $printer;
if($printer != null) {
$this -> loadAvailableCharacters();
}
}
public function writeText($text) {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if($text == null) {
return;
}
if(!mb_detect_encoding($text, self::INPUT_ENCODING, true)) {
// Assume that the user has already put non-UTF8 into the target encoding.
return $this -> writeTextRaw($text);
}
$i = 0;
$j = 0;
$len = mb_strlen($text, self::INPUT_ENCODING);
while($i < $len) {
$matching = true;
if(($encoding = $this -> identifyText(mb_substr($text, $i, 1, self::INPUT_ENCODING))) === false) {
// Un-encodeable text
$encoding = $this -> getPrinter() -> getCharacterTable();
}
$i++;
$j = 1;
do {
$char = mb_substr($text, $i, 1, self::INPUT_ENCODING);
$matching = !isset($this -> available[$char]) || isset($this -> available[$char][$encoding]);
if($matching) {
$i++;
$j++;
}
} while($matching && $i < $len);
$this -> writeTextUsingEncoding(mb_substr($text, $i - $j, $j, self::INPUT_ENCODING), $encoding);
}
}
public function writeTextRaw($text) {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if(strlen($text) == 0) {
return;
}
// Pass only printable characters
for($i = 0; $i < strlen($text); $i++) {
$c = substr($text, $i, 1);
if(!self::asciiCheck($c, true)) {
$text[$i] = self::REPLACEMENT_CHAR;
}
}
$this -> write($text);
}
/**
* Return an encoding which we can start to use for outputting this text. Later parts of the text need not be included in the returned code page.
*
* @param string $text Input text to check.
* @return boolean|integer Code page number, or FALSE if the text is not printable on any supported encoding.
*/
private function identifyText($text) {
// TODO Replace this with an algorithm to choose the encoding which will encode the farthest into the string, to minimise code page changes.
$char = mb_substr($text, 0, 1, self::INPUT_ENCODING);
if(!isset($this -> available[$char])) {
/* Character not available anywhere */
return false;
}
foreach($this -> available[$char] as $encodingNo => $true) {
/* Return first code-page where it is available */
return $encodingNo;
}
return false;
}
/**
* Based on the printer's connector, compute (or load a cached copy of) maps of UTF character to unicode characters for later use.
*/
private function loadAvailableCharacters() {
$supportedCodePages = $this -> printer -> getPrinterCapabilityProfile() -> getSupportedCodePages();
$capabilityClassName = get_class($this -> printer -> getPrinterCapabilityProfile());
$cacheFile = dirname(__FILE__) . "/cache/Characters-" . $capabilityClassName . ".ser" . (self::COMPRESS_CACHE ? ".gz" : "");
$cacheKey = md5(serialize($supportedCodePages));
/* Check for pre-generated file */
if(file_exists($cacheFile)) {
$cacheData = file_get_contents($cacheFile);
if(self::COMPRESS_CACHE) {
$cacheData = gzdecode($cacheData);
}
if($cacheData) {
$dataArray = unserialize($cacheData);
if(isset($dataArray["key"]) && isset($dataArray["available"]) && isset($dataArray["encode"]) && $dataArray["key"] == $cacheKey) {
$this -> available = $dataArray["available"];
$this -> encode = $dataArray["encode"];
return;
}
}
}
/* Generate conversion tables */
$encode = array();
$available = array();
$custom = $this -> printer -> getPrinterCapabilityProfile() -> getCustomCodePages();
foreach($supportedCodePages as $num => $characterMap) {
$encode[$num] = array();
if($characterMap === false) {
continue;
} else if(strpos($characterMap, ":") !== false) {
/* Load a pre-defined custom map (vendor-specific code pages) */
$i = strpos($characterMap, ":");
if(substr($characterMap, 0, $i) !== "custom") {
continue;
}
$i++;
$mapName = substr($characterMap, $i, strlen($characterMap) - $i);
if(!isset($custom[$mapName]) || mb_strlen($custom[$mapName], self::INPUT_ENCODING) != 128) {
throw new Exception("Capability profile referenced invalid custom map '$mapName'.");
}
$map = $custom[$mapName];
for($char = 128; $char <= 255; $char++) {
$utf8 = mb_substr($map, $char - 128, 1, self::INPUT_ENCODING);
if($utf8 == " ") { // Skip placeholders
continue;
}
if(!isset($available[$utf8])) {
$available[$utf8] = array();
}
$available[$utf8][$num] = true;
$encode[$num][$utf8] = chr($char);
}
} else {
/* Generate map using iconv */
for($char = 128; $char <= 255; $char++) {
$utf8 = @iconv($characterMap, self::INPUT_ENCODING, chr($char));
if($utf8 == '') {
continue;
}
if(iconv(self::INPUT_ENCODING, $characterMap, $utf8) != chr($char)) {
// Avoid non-canonical conversions
continue;
}
if(!isset($available[$utf8])) {
$available[$utf8] = array();
}
$available[$utf8][$num] = true;
$encode[$num][$utf8] = chr($char);
}
}
}
/* Use generated data */
$dataArray = array("available" => $available, "encode" => $encode, "key" => $cacheKey);
$this -> available = $dataArray["available"];
$this -> encode = $dataArray["encode"];
$cacheData = serialize($dataArray);
if(self::COMPRESS_CACHE) {
$cacheData = gzencode($cacheData);
}
/* Attempt to cache, but don't worry if we can't */
@file_put_contents($cacheFile, $cacheData);
}
/**
* Encode a block of text using the specified map, and write it to the printer.
*
* @param string $text Text to print, UTF-8 format.
* @param integer $encodingNo Encoding number to use- assumed to exist.
*/
private function writeTextUsingEncoding($text, $encodingNo) {
$encodeMap = $this -> encode[$encodingNo];
$len = mb_strlen($text, self::INPUT_ENCODING);
$rawText = str_repeat(self::REPLACEMENT_CHAR, $len);
for($i = 0; $i < $len; $i++) {
$char = mb_substr($text, $i, 1, self::INPUT_ENCODING);
if(isset($encodeMap[$char])) {
$rawText[$i] = $encodeMap[$char];
} else if(self::asciiCheck($char)) {
$rawText[$i] = $char;
}
}
if($this -> printer -> getCharacterTable() != $encodingNo) {
$this -> printer -> selectCharacterTable($encodingNo);
}
$this -> writeTextRaw($rawText);
}
/**
* Write data to the underlying printer.
*
* @param string $data
*/
private function write($data) {
$this -> printer -> getPrintConnector() -> write($data);
}
/**
* Return true if a character is an ASCII printable character.
*
* @param string $char Character to check
* @param boolean $extended True to allow 128-256 values also (excluded by default)
* @return boolean True if the character is printable, false if it is not.
*/
private static function asciiCheck($char, $extended = false) {
if(strlen($char) != 1) {
// Multi-byte string
return false;
}
$num = ord($char);
if($num > 31 && $num < 127) { // Printable
return true;
}
if($num == 10) { // New-line (printer will take these)
return true;
}
if($extended && $num > 127) {
return true;
}
return false;
}
}

80
htdocs/includes/mike42/escpos-php/src/FilePrintConnector.php
View File

@@ -1,80 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* PrintConnector for passing print data to a file.
*/
class FilePrintConnector implements PrintConnector {
/**
* @var resource The file pointer to send data to.
*/
protected $fp;
/**
* Construct new connector, given a filename
*
* @param string $filename
*/
public function __construct($filename) {
$this -> fp = fopen($filename, "wb+");
if($this -> fp === false) {
throw new Exception("Cannot initialise FilePrintConnector.");
}
}
public function __destruct() {
if($this -> fp !== false) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
/**
* Close file pointer
*/
public function finalize() {
fclose($this -> fp);
$this -> fp = false;
}
/* (non-PHPdoc)
* @see PrintConnector::read()
*/
public function read($len) {
rewind($this -> fp);
return fgets($this -> fp, $len + 1);
}
/**
* Write data to the file
*
* @param string $data
*/
public function write($data) {
fwrite($this -> fp, $data);
}
}

99
htdocs/includes/mike42/escpos-php/src/ImagePrintBuffer.php
View File

@@ -1,99 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This class renders text to small images on-the-fly. It attempts to mimic the
* behaviour of text output, whilst supporting any fonts & character encodings
* which your system can handle. This class currently requires Imagick.
*/
class ImagePrintBuffer implements PrintBuffer {
private $printer;
function __construct() {
if(!EscposImage::isImagickLoaded()) {
throw new Exception("ImagePrintBuffer requires the imagick extension");
}
}
function flush() {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
}
function getPrinter() {
return $this -> printer;
}
function setPrinter(Escpos $printer = null) {
$this -> printer = $printer;
}
function writeText($text) {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if($text == null) {
return;
}
$text = trim($text, "\n");
/* Create Imagick objects */
$image = new Imagick();
$draw = new ImagickDraw();
$color = new ImagickPixel('#000000');
$background = new ImagickPixel('white');
/* Create annotation */
//$draw -> setFont('Arial');// (not necessary?)
$draw -> setFontSize(24); // Size 21 looks good for FONT B
$draw -> setFillColor($color);
$draw -> setStrokeAntialias(true);
$draw -> setTextAntialias(true);
$metrics = $image -> queryFontMetrics($draw, $text);
$draw -> annotation(0, $metrics['ascender'], $text);
/* Create image & draw annotation on it */
$image -> newImage($metrics['textWidth'], $metrics['textHeight'], $background);
$image -> setImageFormat('png');
$image -> drawImage($draw);
//$image -> writeImage("test.png");
/* Save image */
$escposImage = new EscposImage();
$escposImage -> readImageFromImagick($image);
$size = Escpos::IMG_DEFAULT;
$this -> printer -> bitImage($escposImage, $size);
}
function writeTextRaw($text) {
if($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
$this -> printer -> getPrintConnector() -> write($data);
}
}

348
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfile.php Normal file
View File

@@ -0,0 +1,348 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use \InvalidArgumentException;
/**
* Store compatibility information about one printer.
*/
class CapabilityProfile
{
/**
*
* @var string $codePageCacheKey
* Hash of the code page data structure, to identify it for caching.
*/
protected $codePageCacheKey;
/**
*
* @var array $codePages
* Associtive array of CodePage objects, indicating which encodings the printer supports.
*/
protected $codePages;
/**
*
* @var array $colors
* Not used.
*/
protected $colors;
/**
*
* @var array $features
* Feature values.
*/
protected $features;
/**
*
* @var array $fonts
* Not used
*/
protected $fonts;
/**
*
* @var array $media
* Not used
*/
protected $media;
/**
*
* @var string $name
* Name of the profile, including model number.
*/
protected $name;
/**
*
* @var string $notes
* Notes on the profile, null if not set.
*/
protected $notes;
/**
*
* @var string $profileId
* ID of the profile.
*/
protected $profileId;
/**
* @var string $vendor
* Name of manufacturer.
*/
protected $vendor;
/**
*
* @var array $encodings
* Data structure containing encodings loaded from disk, null if not loaded yet.
*/
protected static $encodings = null;
/**
*
* @var array $profiles
* Data structure containing profiles loaded from disk, null if not loaded yet.
*/
protected static $profiles = null;
/**
* Construct new CapabilityProfile.
* The encoding data must be loaded from disk before calling.
*
* @param string $profileId
* ID of the profile
* @param array $profileData
* Profile data from disk.
*/
protected function __construct($profileId, array $profileData)
{
// Basic primitive fields
$this->profileId = $profileId;
$this->name = $profileData['name'];
$this->notes = $profileData['notes'];
$this->vendor = $profileData['vendor'];
// More complex fields that are not currently loaded into custom objects
$this->features = $profileData['features'];
$this->colors = $profileData['colors'];
$this->fonts = $profileData['fonts'];
$this->media = $profileData['media'];
// More complex fields that are loaded into custom objects
$this->codePages = [];
$this->codePageCacheKey = md5(json_encode($profileData['codePages']));
foreach ($profileData['codePages'] as $k => $v) {
$this->codePages[$k] = new CodePage($v, self::$encodings[$v]);
}
}
/**
*
* @return string Hash of the code page data structure, to identify it for caching.
*/
public function getCodePageCacheKey()
{
return $this->codePageCacheKey;
}
/**
*
* @return array Associtive array of CodePage objects, indicating which encodings the printer supports.
*/
public function getCodePages()
{
return $this->codePages;
}
/**
*
* @param string $featureName
* Name of the feature to retrieve.
* @throws \InvalidArgumentException Where the feature does not exist.
* The exception will contain suggestions for the closest-named features.
* @return mixed feature value.
*/
public function getFeature($featureName)
{
if (isset($this->features[$featureName])) {
return $this->features[$featureName];
}
$suggestionsArr = $this->suggestFeatureName($featureName);
$suggestionsStr = implode(", ", $suggestionsArr);
$str = "The feature '$featureName' does not exist. Try one that does exist, such as $suggestionsStr";
throw new \InvalidArgumentException($str);
}
/**
*
* @return string ID of the profile.
*/
public function getId()
{
return $this->profileId;
}
/**
*
* @return string Name of the printer.
*/
public function getName()
{
return $this->name;
}
/**
*
* @return boolean True if Barcode B command is supported, false otherwise
*/
public function getSupportsBarcodeB()
{
return $this->getFeature('barcodeB') === true;
}
/**
*
* @return boolean True if Bit Image Raster command is supported, false otherwise
*/
public function getSupportsBitImageRaster()
{
return $this->getFeature('bitImageRaster') === true;
}
/**
*
* @return boolean True if Graphics command is supported, false otherwise
*/
public function getSupportsGraphics()
{
return $this->getFeature('graphics') === true;
}
/**
*
* @return boolean True if PDF417 code command is supported, false otherwise
*/
public function getSupportsPdf417Code()
{
// TODO submit 'pdf417Code' as a new feature to be tracked in upstream profiles
return $this->getFeature('qrCode') === true;
}
/**
*
* @return boolean True if QR code command is supported, false otherwise
*/
public function getSupportsQrCode()
{
return $this->getFeature('qrCode') === true;
}
/**
*
* @return boolean True if Star mode commands are supported, false otherwise
*/
public function getSupportsStarCommands()
{
return $this->getFeature('starCommands') === true;
}
/**
*
* @return string Vendor of this printer.
*/
public function getVendor()
{
return $this->vendor;
}
/**
*
* @param string $featureName
* Feature that does not exist
* @return array Three most similar feature names that do exist.
*/
protected function suggestFeatureName($featureName)
{
return self::suggestNearest($featureName, array_keys($this->features), 3);
}
/**
*
* @return array Names of all profiles that exist.
*/
public static function getProfileNames()
{
self::loadCapabilitiesDataFile();
return array_keys(self::$profiles);
}
/**
* Retrieve the CapabilityProfile with the given ID.
*
* @param string $profileName
* The ID of the profile to load.
* @throws InvalidArgumentException Where the ID does not exist. Some similarly-named profiles will be suggested in the Exception text.
* @return CapabilityProfile The CapabilityProfile that was requested.
*/
public static function load($profileName)
{
self::loadCapabilitiesDataFile();
if (! isset(self::$profiles[$profileName])) {
$suggestionsArray = self::suggestProfileName($profileName);
$suggestionsStr = implode(", ", $suggestionsArray);
throw new InvalidArgumentException("The CapabilityProfile '$profileName' does not exist. Try one that does exist, such as $suggestionsStr.");
}
return new CapabilityProfile($profileName, self::$profiles[$profileName]);
}
/**
* Ensure that the capabilities.json data file has been loaded.
*/
protected static function loadCapabilitiesDataFile()
{
if (self::$profiles === null) {
$filename = dirname(__FILE__) . "/resources/capabilities.json";
$capabilitiesData = json_decode(file_get_contents($filename), true);
self::$profiles = $capabilitiesData['profiles'];
self::$encodings = $capabilitiesData['encodings'];
}
}
/**
* Return choices with smallest edit distance to an invalid input.
*
* @param string $input
* Input that is not a valid choice
* @param array $choices
* Array of valid choices.
* @param int $num
* Number of suggestions to return
*/
public static function suggestNearest($input, array $choices, $num)
{
$distances = array_fill_keys($choices, PHP_INT_MAX);
foreach ($distances as $word => $_) {
$distances[$word] = levenshtein($input, $word);
}
asort($distances);
return array_slice(array_keys($distances), 0, min($num, count($choices)));
}
/**
*
* @param string $profileName
* profile name that does not exist
* @return array Three similar profile names that do exist, plus 'simple' and 'default' for good measure.
*/
protected static function suggestProfileName($profileName)
{
$suggestions = self::suggestNearest($profileName, array_keys(self::$profiles), 3);
$alwaysSuggest = [
'simple',
'default'
];
foreach ($alwaysSuggest as $item) {
if (array_search($item, $suggestions) === false) {
array_push($suggestions, $item);
}
}
return $suggestions;
}
}

22
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfiles/DefaultCapabilityProfile.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\CapabilityProfiles;
use Mike42\Escpos\CapabilityProfile;
class DefaultCapabilityProfile
{
public static function getInstance()
{
return CapabilityProfile::load('default');
}
}

22
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfiles/EposTepCapabilityProfile.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\CapabilityProfiles;
use Mike42\Escpos\CapabilityProfile;
class EposTepCapabilityProfile
{
public static function getInstance()
{
return CapabilityProfile::load('TEP-200M');
}
}

22
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfiles/P822DCapabilityProfile.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\CapabilityProfiles;
use Mike42\Escpos\CapabilityProfile;
class P822DCapabilityProfile
{
public static function getInstance()
{
return CapabilityProfile::load('P822D');
}
}

22
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfiles/SimpleCapabilityProfile.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\CapabilityProfiles;
use Mike42\Escpos\CapabilityProfile;
class SimpleCapabilityProfile
{
public static function getInstance()
{
return CapabilityProfile::load('simple');
}
}

22
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CapabilityProfiles/StarCapabilityProfile.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\CapabilityProfiles;
use Mike42\Escpos\CapabilityProfile;
class StarCapabilityProfile
{
public static function getInstance()
{
return CapabilityProfile::load('SP2000');
}
}

181
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/CodePage.php Normal file
View File

@@ -0,0 +1,181 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use \InvalidArgumentException;
/**
* Class to handle data about a particular CodePage, as loaded from the receipt print
* database.
*
* Also computes map between UTF-8 and this encoding if necessary, using the iconv library.
*/
class CodePage
{
/**
* The input encoding for generating character maps with iconv.
*/
const INPUT_ENCODING = "UTF-8";
/**
* @var string $data
* Data string, null if not known (can be computed with iconv)
*/
protected $data;
/**
* @var string $iconv
* Iconv encoding name, null if not known
*/
protected $iconv;
/**
* @var string $id
* Internal ID of the CodePage
*/
protected $id;
/**
* @var string $name
* Name of the code page. Substituted with the ID if not set.
*/
protected $name;
/**
* @var string $notes
* Notes on this code page, or null if not set.
*/
protected $notes;
/**
*
* @param string $id
* Unique internal identifier for the CodePage.
* @param array $codePageData
* Associative array of CodePage data, as
* specified by the upstream receipt-print-hq/escpos-printer-db database.
* May contain 'name', 'data', 'iconv', and 'notes' fields.
*/
public function __construct($id, array $codePageData)
{
$this->id = $id;
$this->name = isset($codePageData['name']) ? $codePageData['name'] : $id;
$this->data = isset($codePageData['data']) ? implode("", $codePageData['data']) : null;
$this->iconv = isset($codePageData['iconv']) ? $codePageData['iconv'] : null;
$this->notes = isset($codePageData['notes']) ? $codePageData['notes'] : null;
}
/**
* Get a 128-character data string representing this encoding.
* It will be
* calculated and cached if it was not previously known.
*
* @throws InvalidArgumentException Where the data is now known or computable.
* @return string Data for this encoding.
*/
public function getData()
{
if ($this->data !== null) {
// Return data if known
return $this->data;
}
if ($this->iconv !== null) {
// Calculate with iconv if we know the encoding name
$this->data = self::generateEncodingMap($this->iconv);
return $this->data;
}
// Can't encode..
throw new InvalidArgumentException("Cannot encode this code page");
}
/**
*
* @return string Iconv encoding name, or blank if not set.
*/
public function getIconv()
{
return $this->iconv;
}
/**
*
* @return string Unique identifier of the code page.
*/
public function getId()
{
return $this->id;
}
/**
* Name of the code page.
*/
public function getName()
{
return $this->name;
}
/**
* The notes may explain quirks about a code-page, such as a source if it's non-standard or un-encodeable.
*
* @return string Notes on the code page, or null if not set.
*/
public function getNotes()
{
return $this->notes;
}
/**
*
* @return boolean True if we can encode with this code page (ie, we know what data it holds).
*
* Many printers contain vendor-specific code pages, which are named but have not been identified or
* typed out. For our purposes, this is an "un-encodeable" code page.
*/
public function isEncodable()
{
return $this->iconv !== null || $this->data !== null;
}
/**
* Given an iconv encoding name, generate a 128-character UTF-8 string, containing code points 128-255.
*
* This string is used to map UTF-8 characters to their location in this code page.
*
* @param string $iconvName
* Name of the encoding
* @return string 128-character string in UTF-8.
*/
protected static function generateEncodingMap($iconvName)
{
// Start with array of blanks (" " indicates unknown character).
$charMap = array_fill(0, 128, " ");
// Loop through 128 code points
for ($char = 128; $char <= 255; $char ++) {
// Try to identify the UTF-8 character that would go here
$utf8 = @iconv($iconvName, self::INPUT_ENCODING, chr($char));
if ($utf8 == '') {
continue;
}
if (iconv(self::INPUT_ENCODING, $iconvName, $utf8) != chr($char)) {
// Avoid non-canonical conversions (no known examples)
continue;
}
// Replace the ' ' with the correct character if we found it
$charMap[$char - 128] = $utf8;
}
// Join into a 128-character string and return.
$charMapStr = implode("", $charMap);
assert(mb_strlen($charMapStr, self::INPUT_ENCODING) == 128);
return $charMapStr;
}
}

150
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/Devices/AuresCustomerDisplay.php Normal file
View File

@@ -0,0 +1,150 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\Devices;
use Mike42\Escpos\Printer;
/**
* A class for sending ESC/POS-like code to an Aures customer display.
* The display has some features that printers do not, such as an ability to "clear" the screen.
*/
class AuresCustomerDisplay extends Printer
{
/**
* Indicates that the text should wrap and type over
* existing text on the screen, rather than scroll.
*/
const TEXT_OVERWRITE = 1;
/**
* Indicates that overflowing text should cause the
* display to scroll vertically, like a computer terminal.
*/
const TEXT_VERTICAL_SCROLL = 2;
/**
* Indicates that overflowing text should cause the
* display to scroll horizontally, like a news ticker.
*/
const TEXT_HORIZONTAL_SCROLL = 3;
/**
*
* {@inheritdoc}
*
* @see \Mike42\Escpos\Printer::initialize()
*/
public function initialize()
{
// Select ESC/POS mode first
$this->selectEscposMode();
parent::initialize();
// ESC @ does not reset character table on this printer
$this->selectCharacterTable(0);
// Default to horizontal scroll mode. Behaves most like a printer.
$this->selectTextScrollMode(AuresCustomerDisplay::TEXT_VERTICAL_SCROLL);
}
/**
* Selects ESC/POS mode.
*
* This device supports other modes, which are not used.
*/
protected function selectEscposMode()
{
$this->connector->write("\x02\x05\x43\x31\x03");
}
/**
*
* @param int $mode
* The text scroll mode to use. One of
* AuresCustomerDisplay::TEXT_OVERWRITE,
* AuresCustomerDisplay::TEXT_VERTICAL_SCROLL or
* AuresCustomerDisplay::TEXT_HORIZONTAL_SCROLL
*/
public function selectTextScrollMode($mode = AuresCustomerDisplay::TEXT_VERTICAL_SCROLL)
{
self::validateInteger($mode, 1, 3, __FUNCTION__);
$this->connector->write("\x1F" . chr($mode));
}
/**
* Clear the display.
*/
public function clear()
{
$this->connector->write("\x0c");
}
/**
* Instruct the display to show the firmware version.
*/
public function showFirmwareVersion()
{
$this->connector->write("\x02\x05\x56\x01\x03");
}
/**
* Instruct the display to begin a self-test/demo sequence.
*/
public function selfTest()
{
$this->connector->write("\x02\x05\x44\x08\x03");
}
/**
* Instruct the display to show a pre-loaded logo.
*
* Note that this driver is not capable of uploading a
* logo, but that the vendor supplies software
* which has this function.
*/
public function showLogo()
{
$this->connector->write("\x02\xFC\x55\xAA\x55\xAA");
}
/**
*
* {@inheritdoc}
*
* @see \Mike42\Escpos\Printer::text()
*/
public function text($str = "")
{
self::validateString($str, __FUNCTION__);
// Need to intercept line-feeds, since "\n" is insufficient on this device.
foreach (explode("\n", $str) as $id => $line) {
if ($id > 0) {
$this->feed();
}
parent::text($line);
}
}
/**
*
* {@inheritdoc}
*
* @see \Mike42\Escpos\Printer::feed()
*/
public function feed($lines = 1)
{
self::validateInteger($lines, 1, 255, __FUNCTION__);
for ($i = 0; $i < $lines; $i ++) {
$this->connector->write("\r\n");
}
}
}

460
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/EscposImage.php Normal file
View File

@@ -0,0 +1,460 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use Exception;
use InvalidArgumentException;
/**
* This class deals with images in raster formats, and converts them into formats
* which are suitable for use on thermal receipt printers. Currently, only PNG
* images (in) and ESC/POS raster format (out) are implemeted.
*
* Input formats:
* - Currently, only PNG is supported.
* - Other easily read raster formats (jpg, gif) will be added at a later date, as this is not complex.
* - The BMP format can be directly read by some commands, but this has not yet been implemented.
*
* Output formats:
* - Currently, only ESC/POS raster format is supported
* - ESC/POS 'column format' support is partially implemented, but is not yet used by Escpos.php library.
* - Output as multiple rows of column format image is not yet in the works.
*
* Libraries:
* - Currently, php-gd is used to read the input. Support for imagemagick where gd is not installed is
* also not complex to add, and is a likely future feature.
* - Support for native use of the BMP format is a goal, for maximum compatibility with target environments.
*/
abstract class EscposImage
{
/**
* @var int $imgHeight
* height of the image.
*/
protected $imgHeight = 0;
/**
* @var int $imgWidth
* width of the image
*/
protected $imgWidth = 0;
/**
* @var string $imgData
* Image data in rows: 1 for black, 0 for white.
*/
private $imgData = null;
/**
* @var array:string $imgColumnData
* Cached column-format data to avoid re-computation
*/
private $imgColumnData = [];
/**
* @var string $imgRasterData
* Cached raster format data to avoid re-computation
*/
private $imgRasterData = null;
/**
* @var string $filename
* Filename of image on disk - null if not loaded from disk.
*/
private $filename = null;
/**
* @var boolean $allowOptimisations
* True to allow faster library-specific rendering shortcuts, false to always just use
* image libraries to read pixels (more reproducible between systems).
*/
private $allowOptimisations = true;
/**
* Construct a new EscposImage.
*
* @param string $filename Path to image filename, or null to create an empty image.
* @param boolean $allowOptimisations True (default) to use any library-specific tricks
* to speed up rendering, false to force the image to be read in pixel-by-pixel,
* which is easier to unit test and more reproducible between systems, but slower.
*/
public function __construct($filename = null, $allowOptimisations = true)
{
$this -> filename = $filename;
$this -> allowOptimisations = $allowOptimisations;
}
/**
* @return int height of the image in pixels
*/
public function getHeight()
{
return $this -> imgHeight;
}
/**
* @return int Number of bytes to represent a row of this image
*/
public function getHeightBytes()
{
return (int)(($this -> imgHeight + 7) / 8);
}
/**
* @return int Width of the image
*/
public function getWidth()
{
return $this -> imgWidth;
}
/**
* @return int Number of bytes to represent a row of this image
*/
public function getWidthBytes()
{
return (int)(($this -> imgWidth + 7) / 8);
}
/**
* Output the image in raster (row) format. This can result in padding on the
* right of the image, if its width is not divisible by 8.
*
* @throws Exception Where the generated data is unsuitable for the printer
* (indicates a bug or oversized image).
* @return string The image in raster format.
*/
public function toRasterFormat()
{
// Just wraps implementations for caching & lazy loading
if ($this -> imgRasterData !== null) {
/* Return cached value */
return $this -> imgRasterData;
}
if ($this -> allowOptimisations) {
/* Use optimised code if allowed */
$this -> imgRasterData = $this -> getRasterFormatFromFile($this -> filename);
}
if ($this -> imgRasterData === null) {
/* Load in full image and render the slow way if no faster implementation
is available, or if we've been asked not to use it */
if ($this -> imgData === null) {
$this -> loadImageData($this -> filename);
}
$this -> imgRasterData = $this -> getRasterFormat();
}
return $this -> imgRasterData;
}
/**
* Output the image in column format.
*
* @param boolean $doubleDensity True for double density (24px) lines, false for single-density (8px) lines.
* @return string[] an array, one item per line of output. All lines will be of equal size.
*/
public function toColumnFormat($doubleDensity = false)
{
$densityIdx = $doubleDensity ? 1 : 0;
// Just wraps implementations for caching and lazy loading
if (isset($this -> imgColumnData[$densityIdx])) {
/* Return cached value */
return $this -> imgColumnData[$densityIdx];
}
$this -> imgColumnData[$densityIdx] = null;
if ($this -> allowOptimisations) {
/* Use optimised code if allowed */
$data = $this -> getColumnFormatFromFile($this -> filename, $doubleDensity);
$this -> imgColumnData[$densityIdx] = $data;
}
if ($this -> imgColumnData[$densityIdx] === null) {
/* Load in full image and render the slow way if no faster implementation
is available, or if we've been asked not to use it */
if ($this -> imgData === null) {
$this -> loadImageData($this -> filename);
}
$this -> imgColumnData[$densityIdx] = $this -> getColumnFormat($doubleDensity);
}
return $this -> imgColumnData[$densityIdx];
}
/**
* Load an image from disk. This default implementation always gives a zero-sized image.
*
* @param string|null $filename Filename to load from.
*/
protected function loadImageData($filename = null)
{
// Load image in to string of 1's and 0's, also set width & height
$this -> setImgWidth(0);
$this -> setImgHeight(0);
$this -> setImgData("");
}
/**
* Set image data.
*
* @param string $data Image data to use, string of 1's (black) and 0's (white) in row-major order.
*/
protected function setImgData($data)
{
$this -> imgData = $data;
}
/**
* Set image width.
*
* @param int $width width of the image
*/
protected function setImgWidth($width)
{
$this -> imgWidth = $width;
}
/**
* Set image height.
*
* @param int $height height of the image.
*/
protected function setImgHeight($height)
{
$this -> imgHeight = $height;
}
/**
* @param string $filename
* Filename to load from
* @return string|NULL
* Raster format data, or NULL if no optimised renderer is available in
* this implementation.
*/
protected function getRasterFormatFromFile($filename = null)
{
// No optimised implementation to provide
return null;
}
/**
* @param string $filename
* Filename to load from
* @param boolean $highDensityVertical
* True for high density output (24px lines), false for regular density (8px)
* @return string[]|NULL
* Column format data as array, or NULL if optimised renderer isn't
* available in this implementation.
*/
protected function getColumnFormatFromFile($filename = null, $highDensityVertical = true)
{
// No optimised implementation to provide
return null;
}
/**
* Get column fromat from loaded image pixels, line by line.
*
* @throws Exception
* Where wrong number of bytes has been generated.
* @return string
* Raster format data
*/
private function getRasterFormat()
{
/* Loop through and convert format */
$widthPixels = $this -> getWidth();
$heightPixels = $this -> getHeight();
$widthBytes = $this -> getWidthBytes();
$heightBytes = $this -> getHeightBytes();
$x = $y = $bit = $byte = $byteVal = 0;
$data = str_repeat("\0", $widthBytes * $heightPixels);
if (strlen($data) == 0) {
return $data;
}
do {
$byteVal |= (int)$this -> imgData[$y * $widthPixels + $x] << (7 - $bit);
$x++;
$bit++;
if ($x >= $widthPixels) {
$x = 0;
$y++;
$bit = 8;
if ($y >= $heightPixels) {
$data[$byte] = chr($byteVal);
break;
}
}
if ($bit >= 8) {
$data[$byte] = chr($byteVal);
$byteVal = 0;
$bit = 0;
$byte++;
}
} while (true);
if (strlen($data) != ($this -> getWidthBytes() * $this -> getHeight())) {
throw new Exception("Bug in " . __FUNCTION__ . ", wrong number of bytes.");
}
return $data;
}
/**
* Get column fromat from loaded image pixels, line by line.
*
* @param boolean $highDensity
* True for high density output (24px lines), false for regular density (8px)
* @return string[]
* Array of column format data, one item per row.
*/
private function getColumnFormat($highDensity)
{
$out = [];
$i = 0;
while (($line = $this -> getColumnFormatLine($i, $highDensity)) !== null) {
$out[] = $line;
$i++;
}
return $out;
}
/**
* Output image in column format. Must be called once for each line of output.
*
* @param int $lineNo
* Line number to retrieve
* @param bool $highDensity
* True for high density output (24px lines), false for regular density (8px)
* @throws Exception
* Where wrong number of bytes has been generated.
* @return NULL|string
* Column format data, or null if there is no more data (when iterating)
*/
private function getColumnFormatLine($lineNo, $highDensity)
{
// Currently double density in both directions, very experimental
$widthPixels = $this -> getWidth();
$heightPixels = $this -> getHeight();
$widthBytes = $this -> getWidthBytes();
$heightBytes = $this -> getHeightBytes();
$lineHeight = $highDensity ? 3 : 1; // Vertical density. 1 or 3 (for 8 and 24 pixel lines)
// Initialise to zero
$x = $y = $bit = $byte = $byteVal = 0;
$data = str_repeat("\x00", $widthPixels * $lineHeight);
$yStart = $lineHeight * 8 * $lineNo;
if ($yStart >= $heightPixels) {
return null;
}
if (strlen($data) == 0) {
return $data;
}
do {
$yReal = $y + $yStart;
if ($yReal < $heightPixels) {
$byteVal |= (int)$this -> imgData[$yReal * $widthPixels + $x] << (7 - $bit);
}
$y++;
$bit++;
if ($y >= $lineHeight * 8) {
$y = 0;
$x++;
$bit = 8;
if ($x >= $widthPixels) {
$data[$byte] = chr($byteVal);
break;
}
}
if ($bit >= 8) {
$data[$byte] = chr($byteVal);
$byteVal = 0;
$bit = 0;
$byte++;
}
} while (true);
if (strlen($data) != $widthPixels * $lineHeight) {
throw new Exception("Bug in " . __FUNCTION__ . ", wrong number of bytes.");
}
return $data;
}
/**
* @return boolean True if GD is loaded, false otherwise
*/
public static function isGdLoaded()
{
return extension_loaded('gd');
}
/**
* @return boolean True if Imagick is loaded, false otherwise
*/
public static function isImagickLoaded()
{
return extension_loaded('imagick');
}
/**
* This is a convinience method to load an image from file, auto-selecting
* an EscposImage implementation which uses an available library.
*
* The sub-classes can be constructed directly if you know that you will
* have Imagick or GD on the print server.
*
* @param string $filename
* File to load from
* @param bool $allowOptimisations
* True to allow the fastest rendering shortcuts, false to force the library
* to read the image into an internal raster format and use PHP to render
* the image (slower but less fragile).
* @param array $preferred
* Order to try to load libraries in- escpos-php supports pluggable image
* libraries. Items can be 'imagick', 'gd', 'native'.
* @throws Exception
* Where no suitable library could be found for the type of file being loaded.
* @return EscposImage
*
*/
public static function load(
$filename,
$allowOptimisations = true,
array $preferred = ['imagick', 'gd', 'native']
) {
/* Fail early if file is not readble */
if (!file_exists($filename) || !is_readable($filename)) {
throw new Exception("File '$filename' does not exist, or is not readable.");
}
$ext = pathinfo($filename, PATHINFO_EXTENSION);
/* Choose the first implementation which can handle this format */
foreach ($preferred as $implemetnation) {
if ($implemetnation === 'imagick') {
if (!self::isImagickLoaded()) {
// Skip option if Imagick is not loaded
continue;
}
return new \Mike42\Escpos\ImagickEscposImage($filename, $allowOptimisations);
} elseif ($implemetnation === 'gd') {
if (!self::isGdLoaded()) {
// Skip option if GD not loaded
continue;
}
return new \Mike42\Escpos\GdEscposImage($filename, $allowOptimisations);
} elseif ($implemetnation === 'native') {
if (!in_array($ext, ['wbmp', 'pbm', 'bmp'])) {
// Pure PHP is fastest way to generate raster output from wbmp and pbm formats.
continue;
}
return new \Mike42\Escpos\NativeEscposImage($filename, $allowOptimisations);
} else {
// Something else on the 'preferred' list.
throw new InvalidArgumentException("'$implemetnation' is not a known EscposImage implementation");
}
}
throw new InvalidArgumentException("No suitable EscposImage implementation found for '$filename'.");
}
}

86
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/GdEscposImage.php Normal file
View File

@@ -0,0 +1,86 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use Mike42\Escpos\EscposImage;
use Exception;
/**
* Implementation of EscposImage using the GD PHP plugin.
*/
class GdEscposImage extends EscposImage
{
/**
* Load an image from disk, into memory, using GD.
*
* @param string|null $filename The filename to load from
* @throws Exception if the image format is not supported,
* or the file cannot be opened.
*/
protected function loadImageData($filename = null)
{
if ($filename === null) {
/* Set to blank image */
return parent::loadImageData($filename);
}
$ext = pathinfo($filename, PATHINFO_EXTENSION);
switch ($ext) {
case "png":
$im = @imagecreatefrompng($filename);
break;
case "jpg":
$im = @imagecreatefromjpeg($filename);
break;
case "gif":
$im = @imagecreatefromgif($filename);
break;
default:
throw new Exception("Image format not supported in GD");
}
$this -> readImageFromGdResource($im);
}
/**
* Load actual image pixels from GD resource.
*
* @param resource $im GD resource to use
* @throws Exception Where the image can't be read.
*/
public function readImageFromGdResource($im)
{
if (!is_resource($im)) {
throw new Exception("Failed to load image.");
} elseif (!EscposImage::isGdLoaded()) {
throw new Exception(__FUNCTION__ . " requires 'gd' extension.");
}
/* Make a string of 1's and 0's */
$imgHeight = imagesy($im);
$imgWidth = imagesx($im);
$imgData = str_repeat("\0", $imgHeight * $imgWidth);
for ($y = 0; $y < $imgHeight; $y++) {
for ($x = 0; $x < $imgWidth; $x++) {
/* Faster to average channels, blend alpha and negate the image here than via filters (tested!) */
$cols = imagecolorsforindex($im, imagecolorat($im, $x, $y));
// 1 for white, 0 for black, ignoring transparency
$greyness = (int)(($cols['red'] + $cols['green'] + $cols['blue']) / 3) >> 7;
// 1 for black, 0 for white, taking into account transparency
$black = (1 - $greyness) >> ($cols['alpha'] >> 6);
$imgData[$y * $imgWidth + $x] = $black;
}
}
$this -> setImgWidth($imgWidth);
$this -> setImgHeight($imgHeight);
$this -> setImgData($imgData);
}
}

273
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/ImagickEscposImage.php Normal file
View File

@@ -0,0 +1,273 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use Exception;
use Imagick;
use Mike42\Escpos\EscposImage;
/**
* Implementation of EscposImage using the Imagick PHP plugin.
*/
class ImagickEscposImage extends EscposImage
{
/**
* Load actual image pixels from Imagick object
*
* @param Imagick $im Image to load from
*/
public function readImageFromImagick(\Imagick $im)
{
/* Strip transparency */
$im = self::alphaRemove($im);
/* Threshold */
$im -> setImageType(\Imagick::IMGTYPE_TRUECOLOR); // Remove transparency (good for PDF's)
$max = $im->getQuantumRange();
$max = $max["quantumRangeLong"];
$im -> thresholdImage(0.5 * $max);
/* Make a string of 1's and 0's */
$imgHeight = $im -> getimageheight();
$imgWidth = $im -> getimagewidth();
$imgData = str_repeat("\0", $imgHeight * $imgWidth);
for ($y = 0; $y < $imgHeight; $y++) {
for ($x = 0; $x < $imgWidth; $x++) {
/* Faster to average channels, blend alpha and negate the image here than via filters (tested!) */
$cols = $im -> getImagePixelColor($x, $y);
$cols = $cols -> getcolor();
$greyness = (int)(($cols['r'] + $cols['g'] + $cols['b']) / 3) >> 7; // 1 for white, 0 for black
$imgData[$y * $imgWidth + $x] = (1 - $greyness); // 1 for black, 0 for white
}
}
$this -> setImgWidth($imgWidth);
$this -> setImgHeight($imgHeight);
$this -> setImgData($imgData);
}
/**
* @param string $filename
* Filename to load from
* @param boolean $highDensityVertical
* True for high density output (24px lines), false for regular density (8px)
* @return string[]|NULL
* Column format data as array, or NULL if optimised renderer isn't
* available in this implementation.
*/
protected function getColumnFormatFromFile($filename = null, $highDensityVertical = true)
{
if ($filename === null) {
return null;
}
$im = $this -> getImageFromFile($filename);
$this -> setImgWidth($im -> getimagewidth());
$this -> setImgHeight($im -> getimageheight());
/* Strip transparency */
$im = self::alphaRemove($im);
$im -> setformat('pbm');
$im -> getimageblob(); // Forces 1-bit rendering now, so that subsequent operations are faster
$im -> rotateImage('#fff', 90.0);
$im -> flopImage();
$lineHeight = $highDensityVertical ? 3 : 1;
$blobs = $this -> getColumnFormatFromImage($im, $lineHeight * 8);
return $blobs;
}
/**
* Load an image from disk, into memory, using Imagick.
*
* @param string|null $filename The filename to load from
* @throws Exception if the image format is not supported,
* or the file cannot be opened.
*/
protected function loadImageData($filename = null)
{
if ($filename === null) {
/* Set to blank image */
return parent::loadImageData($filename);
}
$im = $this -> getImageFromFile($filename);
$this -> readImageFromImagick($im);
}
/**
* Return data in column format as array of slices.
* Operates recursively to save cloning larger image many times.
*
* @param Imagick $im
* @param int $lineHeight
* Height of printed line in dots. 8 or 24.
* @return string[]
*/
private function getColumnFormatFromImage(Imagick $im, $lineHeight)
{
$imgWidth = $im->getimagewidth();
if ($imgWidth == $lineHeight) {
// Return glob of this panel
return [$this -> getRasterBlobFromImage($im)];
} elseif ($imgWidth > $lineHeight) {
// Calculations
$slicesLeft = ceil($imgWidth / $lineHeight / 2);
$widthLeft = $slicesLeft * $lineHeight;
$widthRight = $imgWidth - $widthLeft;
// Slice up (left)
$left = clone $im;
$left -> extentimage($widthLeft, $left -> getimageheight(), 0, 0);
// Slice up (right - ensure width is divisible by lineHeight also)
$right = clone $im;
$widthRightRounded = $widthRight < $lineHeight ? $lineHeight : $widthRight;
$right -> extentimage($widthRightRounded, $right -> getimageheight(), $widthLeft, 0);
// Recurse
$leftBlobs = $this -> getColumnFormatFromImage($left, $lineHeight);
$rightBlobs = $this -> getColumnFormatFromImage($right, $lineHeight);
return array_merge($leftBlobs, $rightBlobs);
} else {
/* Image is smaller than full width */
$im -> extentimage($lineHeight, $im -> getimageheight(), 0, 0);
return [$this -> getRasterBlobFromImage($im)];
}
}
/**
* Load Imagick file from image
*
* @param string $filename Filename to load
* @throws Exception Wrapped Imagick error if image can't be loaded
* @return Imagick Loaded image
*/
private function getImageFromFile($filename)
{
$im = new Imagick();
try {
$im->setResourceLimit(6, 1); // Prevent libgomp1 segfaults, grumble grumble.
$im -> readimage($filename);
} catch (\ImagickException $e) {
/* Re-throw as normal exception */
throw new Exception($e);
}
return $im;
}
/**
* Pull blob (from PBM-formatted image only!), and spit out a blob or raster data.
* Will crash out on anything which is not a valid 'P4' file.
*
* @param Imagick $im Image which has format PBM.
* @return string raster data from the image
*/
private function getRasterBlobFromImage(Imagick $im)
{
$blob = $im -> getimageblob();
/* Find where header ends */
$i = strpos($blob, "P4\n") + 2;
while ($blob[$i + 1] == '#') {
$i = strpos($blob, "\n", $i + 1);
}
$i = strpos($blob, "\n", $i + 1);
/* Return raster data only */
$subBlob = substr($blob, $i + 1);
return $subBlob;
}
/**
* @param string $filename
* Filename to load from
* @return string|NULL
* Raster format data, or NULL if no optimised renderer is available in
* this implementation.
*/
protected function getRasterFormatFromFile($filename = null)
{
if ($filename === null) {
return null;
}
$im = $this -> getImageFromFile($filename);
$this -> setImgWidth($im -> getimagewidth());
$this -> setImgHeight($im -> getimageheight());
/* Convert to PBM and extract raster portion */
$im = self::alphaRemove($im);
$im -> setFormat('pbm');
return $this -> getRasterBlobFromImage($im);
}
/**
* Load a PDF for use on the printer
*
* @param string $pdfFile
* The file to load
* @param int $pageWidth
* The width, in pixels, of the printer's output. The first page of the
* PDF will be scaled to approximately fit in this area.
* @throws Exception Where Imagick is not loaded, or where a missing file
* or invalid page number is requested.
* @return array Array of images, retrieved from the PDF file.
*/
public static function loadPdf($pdfFile, $pageWidth = 550)
{
if (!EscposImage::isImagickLoaded()) {
throw new Exception(__FUNCTION__ . " requires imagick extension.");
}
/*
* Load first page at very low density (resolution), to figure out what
* density to use to achieve $pageWidth
*/
try {
$image = new \Imagick();
$testRes = 2; // Test resolution
$image -> setresolution($testRes, $testRes);
/* Load document just to measure geometry */
$image -> readimage($pdfFile);
$geo = $image -> getimagegeometry();
$image -> destroy();
$width = $geo['width'];
$newRes = $pageWidth / $width * $testRes;
/* Load entire document in */
$image -> setresolution($newRes, $newRes);
$image -> readImage($pdfFile);
$pages = $image -> getNumberImages();
/* Convert images to Escpos objects */
$ret = [];
for ($i = 0; $i < $pages; $i++) {
$image -> setIteratorIndex($i);
$ep = new ImagickEscposImage();
$ep -> readImageFromImagick($image);
$ret[] = $ep;
}
return $ret;
} catch (\ImagickException $e) {
/* Wrap in normal exception, so that classes which call this do not
* themselves require imagick as a dependency. */
throw new Exception($e);
}
}
/**
* Paste image over white canvas to stip transparency reliably on different
* versions of ImageMagick.
*
* There are other methods for this:
* - flattenImages() is deprecated
* - setImageAlphaChannel(Imagick::ALPHACHANNEL_REMOVE) is not available on
* ImageMagick < 6.8.
*
* @param Imagick $im Image to flatten
* @return Imagick Flattened image
*/
private static function alphaRemove(Imagick $im)
{
$flat = new \Imagick();
$flat -> newImage($im -> getimagewidth(), $im -> getimageheight(), "white", $im -> getimageformat());
$flat -> compositeimage($im, \Imagick::COMPOSITE_OVER, 0, 0);
return $flat;
}
}

24
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/NativeEscposImage.php Normal file
View File

@@ -0,0 +1,24 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos;
use Mike42\Escpos\EscposImage;
/**
* Implementation of EscposImage using only native PHP.
* TODO: wbmp, pbm, bmp files.
*/
class NativeEscposImage extends EscposImage
{
}

300
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/EscposPrintBuffer.php Normal file
View File

@@ -0,0 +1,300 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintBuffers;
use LogicException;
use Mike42\Escpos\Printer;
/**
* This class manages newlines and character encoding for the target printer, and
* can be interchanged for an image-bassed buffer (ImagePrintBuffer) if you can't
* get it operating properly on your machine.
*/
class EscposPrintBuffer implements PrintBuffer
{
/**
* True to cache output as .z, false to leave un-compressed (useful for debugging)
*/
const COMPRESS_CACHE = true;
/**
* The input encoding of the buffer.
*/
const INPUT_ENCODING = "UTF-8";
/**
* Un-recognised characters will be replaced with this.
*/
const REPLACEMENT_CHAR = "?";
/**
* @var array $available
* This array Maps ESC/POS character tables to names iconv encodings
*/
private $available = null;
/**
* @var array $encode
* Maps of UTF-8 to code-pages
*/
private $encode = null;
/**
* @var Printer|null $printer
* Printer for output
*/
private $printer;
/**
* Empty print buffer.
*/
public function __construct()
{
$this -> printer = null;
}
public function flush()
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
// TODO Not yet implemented for this buffer: This indicates that the printer needs the current line to be ended.
}
public function getPrinter()
{
return $this -> printer;
}
public function setPrinter(Printer $printer = null)
{
$this -> printer = $printer;
if ($printer != null) {
$this -> loadAvailableCharacters();
}
}
public function writeText($text)
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if ($text == null) {
return;
}
if (!mb_detect_encoding($text, self::INPUT_ENCODING, true)) {
// Assume that the user has already put non-UTF8 into the target encoding.
return $this -> writeTextRaw($text);
}
$i = 0;
$j = 0;
$len = mb_strlen($text, self::INPUT_ENCODING);
while ($i < $len) {
$matching = true;
if (($encoding = $this -> identifyText(mb_substr($text, $i, 1, self::INPUT_ENCODING))) === false) {
// Un-encodeable text
$encoding = $this -> getPrinter() -> getCharacterTable();
}
$i++;
$j = 1;
do {
$char = mb_substr($text, $i, 1, self::INPUT_ENCODING);
$matching = !isset($this -> available[$char]) || isset($this -> available[$char][$encoding]);
if ($matching) {
$i++;
$j++;
}
} while ($matching && $i < $len);
$this -> writeTextUsingEncoding(mb_substr($text, $i - $j, $j, self::INPUT_ENCODING), $encoding);
}
}
public function writeTextRaw($text)
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if (strlen($text) == 0) {
return;
}
// Pass only printable characters
$j = 0;
$l = strlen($text);
$outp = str_repeat(self::REPLACEMENT_CHAR, $l);
for ($i = 0; $i < $l; $i++) {
$c = substr($text, $i, 1);
if ($c == "\r") {
/* Skip past Windows line endings (raw usage). */
continue;
} else if (self::asciiCheck($c, true)) {
$outp[$j] = $c;
}
$j++;
}
$this -> write(substr($outp, 0, $j));
}
/**
* Return an encoding which we can start to use for outputting this text.
* Later parts of the text need not be included in the returned code page.
*
* @param string $text Input text to check.
* @return boolean|integer Code page number, or FALSE if the text is not
* printable on any supported encoding.
*/
private function identifyText($text)
{
// TODO Replace this with an algorithm to choose the encoding which will
// encode the farthest into the string, to minimise code page changes.
$char = mb_substr($text, 0, 1, self::INPUT_ENCODING);
if (!isset($this -> available[$char])) {
/* Character not available anywhere */
return false;
}
foreach ($this -> available[$char] as $encodingNo => $true) {
/* Return first code-page where it is available */
return $encodingNo;
}
return false;
}
/**
* Based on the printer's connector, compute (or load a cached copy of) maps
* of UTF character to unicode characters for later use.
*/
private function loadAvailableCharacters()
{
$profile = $this -> printer -> getPrinterCapabilityProfile();
$supportedCodePages = $profile -> getCodePages();
$profileName = $profile -> getId();
$cacheFile = dirname(__FILE__) . "/cache/Characters-" . $profileName . ".ser" .
(self::COMPRESS_CACHE ? ".z" : "");
$cacheKey = $profile -> getCodePageCacheKey();
/* Check for pre-generated file */
if (file_exists($cacheFile)) {
$cacheData = file_get_contents($cacheFile);
if (self::COMPRESS_CACHE) {
$cacheData = gzuncompress($cacheData);
}
if ($cacheData) {
$dataArray = unserialize($cacheData);
if (isset($dataArray["key"]) && isset($dataArray["available"]) &&
isset($dataArray["encode"]) && $dataArray["key"] == $cacheKey) {
$this -> available = $dataArray["available"];
$this -> encode = $dataArray["encode"];
return;
}
}
}
/* Generate conversion tables */
$encode = [];
$available = [];
foreach ($supportedCodePages as $num => $codePage) {
$encode[$num] = [];
if (!$codePage -> isEncodable()) {
continue;
}
$map = $codePage -> getData();
for ($char = 128; $char <= 255; $char++) {
$utf8 = mb_substr($map, $char - 128, 1, self::INPUT_ENCODING);
if ($utf8 == " ") { // Skip placeholders
continue;
}
if (!isset($available[$utf8])) {
$available[$utf8] = [];
}
$available[$utf8][$num] = true;
$encode[$num][$utf8] = chr($char);
}
}
/* Use generated data */
$dataArray = ["available" => $available, "encode" => $encode, "key" => $cacheKey];
$this -> available = $dataArray["available"];
$this -> encode = $dataArray["encode"];
$cacheData = serialize($dataArray);
if (self::COMPRESS_CACHE) {
$cacheData = gzcompress($cacheData);
}
/* Attempt to cache, but don't worry if we can't */
@file_put_contents($cacheFile, $cacheData);
}
/**
* Encode a block of text using the specified map, and write it to the printer.
*
* @param string $text Text to print, UTF-8 format.
* @param integer $encodingNo Encoding number to use- assumed to exist.
*/
private function writeTextUsingEncoding($text, $encodingNo)
{
$encodeMap = $this -> encode[$encodingNo];
$len = mb_strlen($text, self::INPUT_ENCODING);
$rawText = str_repeat(self::REPLACEMENT_CHAR, $len);
$j = 0;
for ($i = 0; $i < $len; $i++) {
$char = mb_substr($text, $i, 1, self::INPUT_ENCODING);
if (isset($encodeMap[$char])) {
$rawText[$j] = $encodeMap[$char];
} elseif (self::asciiCheck($char)) {
$rawText[$j] = $char;
} elseif ($char === "\r") {
/* Skip past Windows line endings (UTF-8 usage) */
continue;
}
$j++;
}
if ($this -> printer -> getCharacterTable() != $encodingNo) {
$this -> printer -> selectCharacterTable($encodingNo);
}
$this -> writeTextRaw(substr($rawText, 0, $j));
}
/**
* Write data to the underlying printer.
*
* @param string $data
*/
private function write($data)
{
$this -> printer -> getPrintConnector() -> write($data);
}
/**
* Return true if a character is an ASCII printable character.
*
* @param string $char Character to check
* @param boolean $extended True to allow 128-256 values also (excluded by default)
* @return boolean True if the character is printable, false if it is not.
*/
private static function asciiCheck($char, $extended = false)
{
if (strlen($char) != 1) {
// Multi-byte string
return false;
}
$num = ord($char);
if ($num > 31 && $num < 127) { // Printable
return true;
}
if ($num == 10) { // New-line (printer will take these)
return true;
}
if ($extended && $num > 127) {
return true;
}
return false;
}
}

135
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/ImagePrintBuffer.php Normal file
View File

@@ -0,0 +1,135 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintBuffers;
use Exception;
use LogicException;
use Mike42\Escpos\Printer;
use Mike42\Escpos\EscposImage;
use Mike42\Escpos\ImagickEscposImage;
/**
* This class renders text to small images on-the-fly. It attempts to mimic the
* behaviour of text output, whilst supporting any fonts & character encodings
* which your system can handle. This class currently requires Imagick.
*/
class ImagePrintBuffer implements PrintBuffer
{
private $printer;
/**
* @var string|null font to use
*/
private $font;
private $fontSize;
public function __construct()
{
if (!EscposImage::isImagickLoaded()) {
throw new Exception("ImagePrintBuffer requires the imagick extension");
}
$this -> font = null;
$this -> fontSize = 24;
}
public function flush()
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
}
public function getPrinter()
{
return $this -> printer;
}
public function setPrinter(Printer $printer = null)
{
$this -> printer = $printer;
}
public function writeText($text)
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
if ($text == null) {
return;
}
$text = trim($text, "\n");
/* Create Imagick objects */
$image = new \Imagick();
$draw = new \ImagickDraw();
$color = new \ImagickPixel('#000000');
$background = new \ImagickPixel('white');
/* Create annotation */
if ($this->font !== null) {
// Allow fallback on defaults as necessary
$draw->setFont($this->font);
}
/* In Arial, size 21 looks good as a substitute for FONT_B, 24 for FONT_A */
$draw -> setFontSize($this -> fontSize);
$draw -> setFillColor($color);
$draw -> setStrokeAntialias(true);
$draw -> setTextAntialias(true);
$metrics = $image -> queryFontMetrics($draw, $text);
$draw -> annotation(0, $metrics['ascender'], $text);
/* Create image & draw annotation on it */
$image -> newImage($metrics['textWidth'], $metrics['textHeight'], $background);
$image -> setImageFormat('png');
$image -> drawImage($draw);
// debugging if you want to view the images yourself
//$image -> writeImage("test.png");
/* Save image */
$escposImage = new ImagickEscposImage();
$escposImage -> readImageFromImagick($image);
$size = Printer::IMG_DEFAULT;
$this -> printer -> bitImage($escposImage, $size);
}
public function writeTextRaw($text)
{
if ($this -> printer == null) {
throw new LogicException("Not attached to a printer.");
}
$this -> printer -> getPrintConnector() -> write($text);
}
/**
* Set path on disk to TTF font that will be used to render text to image,
* or 'null' to use a default.
*
* ImageMagick will also accept a font name, but this will not port as well
* between systems.
*
* @param string $font
* Font name or a filename
*/
public function setFont($font)
{
$this->font = $font;
}
/**
* Numeric font size for rendering text to image
*/
public function setFontSize($fontSize)
{
$this->fontSize = $fontSize;
}
}

63
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/PrintBuffer.php Normal file
View File

@@ -0,0 +1,63 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-16 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintBuffers;
use Mike42\Escpos\Printer;
/**
* Print buffers manage newlines and character encoding for the target printer.
* They are used as a swappable component: text or image-based output.
*
* - Text output (EscposPrintBuffer) is the fast default, and is recommended for
* most people, as the text output can be more directly manipulated by ESC/POS
* commands.
* - Image output (ImagePrintBuffer) is designed to accept more encodings than the
* physical printer supports, by rendering the text to small images on-the-fly.
* This takes a lot more CPU than sending text, but is necessary for some users.
* - If your use case fits outside these, then a further speed/flexibility trade-off
* can be made by printing directly from generated HTML or PDF.
*/
interface PrintBuffer
{
/**
* Cause the buffer to send any partial input and wait on a newline.
* If the printer is already on a new line, this does nothing.
*/
public function flush();
/**
* Used by Escpos to check if a printer is set.
*/
public function getPrinter();
/**
* Used by Escpos to hook up one-to-one link between buffers and printers.
*
* @param Printer|null $printer New printer
*/
public function setPrinter(Printer $printer = null);
/**
* Accept UTF-8 text for printing.
*
* @param string $text Text to print
*/
public function writeText($text);
/**
* Accept 8-bit text in the current encoding and add it to the buffer.
*
* @param string $text Text to print, already the target encoding.
*/
public function writeTextRaw($text);
}

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-OCD-300.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-P822D.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-POS-5890.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-SP2000.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-TEP-200M.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-default.ser.z vendored Normal file
View File

Binary file not shown.

BIN
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintBuffers/cache/Characters-simple.ser.z vendored Normal file
View File

Binary file not shown.

102
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/ApiPrintConnector.php Normal file
View File

@@ -0,0 +1,102 @@
<?php
namespace Mike42\Escpos\PrintConnectors;
use Guzzle\Http\Client;
use Guzzle\Http\Message\Request;
use Guzzle\Http\Message\Response;
use Exception;
class ApiPrintConnector implements PrintConnector
{
/**
* @var string
*/
protected $stream;
/**
* @var Client
*/
protected $httpClient;
/**
* @var string
*/
protected $printerId;
/**
* @var string
*/
protected $apiToken;
/**
* Construct new connector
*
* @param string $host
* @param string $printerId
* @param string $apiToken
*/
public function __construct($host, $printerId, $apiToken)
{
$this->httpClient = new Client(['base_uri' => $host]);
$this->printerId = $printerId;
$this->apiToken = $apiToken;
$this->stream = '';
}
/**
* Print connectors should cause a NOTICE if they are deconstructed
* when they have not been finalized.
*/
public function __destruct()
{
if (! empty($this->stream)) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
/**
* Finish using this print connector (close file, socket, send
* accumulated output, etc).
*/
public function finalize()
{
/** @var Request $request */
$request = $this->httpClient->post(
'printers/'.$this->printerId.'/print?api_token='.$this->apiToken,
null,
$this->stream
);
/** @var Response $response */
$response = $request->send();
if (! $response->isSuccessful()) {
throw new Exception(
sprintf('Failed to print. API returned "%s: %s"', $response->getStatusCode(), $response->getReasonPhrase())
);
}
$this->stream = '';
}
/**
* Read data from the printer.
*
* @param string $len Length of data to read.
* @return string Data read from the printer.
*/
public function read($len)
{
return $this->stream;
}
/**
* Write data to the print connector.
*
* @param string $data The data to write
*/
public function write($data)
{
$this->stream .= $data;
}
}

182
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/CupsPrintConnector.php Normal file
View File

@@ -0,0 +1,182 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
use Exception;
use BadMethodCallException;
/**
* Print connector that passes print data to CUPS print commands.
* Your printer mut be installed on the local CUPS instance to use this connector.
*/
class CupsPrintConnector implements PrintConnector
{
/**
* @var array $buffer
* Buffer of accumilated data.
*/
private $buffer;
/**
*
* @var string $printerName
* The name of the target printer.
*/
private $printerName;
/**
* Construct new CUPS print connector.
*
* @param string $dest
* The CUPS printer name to print to. This must be loaded using a raw driver.
* @throws BadMethodCallException
*/
public function __construct($dest)
{
$valid = $this->getLocalPrinters();
if (count($valid) == 0) {
throw new BadMethodCallException("You do not have any printers installed on " .
"this system via CUPS. Check 'lpr -a'.");
}
if (array_search($dest, $valid, true) === false) {
throw new BadMethodCallException("'$dest' is not a printer on this system. " .
"Printers are: [" . implode(", ", $valid) . "]");
}
$this->buffer = array ();
$this->printerName = $dest;
}
/**
* Cause a NOTICE if deconstructed before the job was printed.
*/
public function __destruct()
{
if ($this->buffer !== null) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
/**
* Send job to printer.
*/
public function finalize()
{
$data = implode($this->buffer);
$this->buffer = null;
// Build command to work on data
$tmpfname = tempnam(sys_get_temp_dir(), 'print-');
file_put_contents($tmpfname, $data);
$cmd = sprintf(
"lp -d %s %s",
escapeshellarg($this->printerName),
escapeshellarg($tmpfname)
);
try {
$this->getCmdOutput($cmd);
} catch (Exception $e) {
unlink($tmpfname);
throw $e;
}
unlink($tmpfname);
}
/**
* Run a command and throw an exception if it fails, or return the output if it works.
* (Basically exec() with good error handling)
*
* @param string $cmd
* Command to run
*/
protected function getCmdOutput($cmd)
{
$descriptors = array (
1 => array (
"pipe",
"w"
),
2 => array (
"pipe",
"w"
)
);
$process = proc_open($cmd, $descriptors, $fd);
if (! is_resource($process)) {
throw new Exception("Command '$cmd' failed to start.");
}
/* Read stdout */
$outputStr = stream_get_contents($fd [1]);
fclose($fd [1]);
/* Read stderr */
$errorStr = stream_get_contents($fd [2]);
fclose($fd [2]);
/* Finish up */
$retval = proc_close($process);
if ($retval != 0) {
throw new Exception("Command $cmd failed: $errorStr");
}
return $outputStr;
}
/**
* Read data from the printer.
*
* @param string $len Length of data to read.
* @return Data read from the printer, or false where reading is not possible.
*/
public function read($len)
{
return false;
}
/**
* @param string $data
*/
public function write($data)
{
$this->buffer [] = $data;
}
/**
* Load a list of CUPS printers.
*
* @return array A list of printer names installed on this system. Any item
* on this list is valid for constructing a printer.
*/
protected function getLocalPrinters()
{
$outpStr = $this->getCmdOutput("lpstat -a");
$outpLines = explode("\n", trim($outpStr));
foreach ($outpLines as $line) {
$ret [] = $this->chopLpstatLine($line);
}
return $ret;
}
/**
* Get the item before the first space in a string
*
* @param string $line
* @return string the string, up to the first space, or the whole string if it contains no spaces.
*/
private function chopLpstatLine($line)
{
if (($pos = strpos($line, " ")) === false) {
return $line;
} else {
return substr($line, 0, $pos);
}
}
}

78
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/DummyPrintConnector.php Normal file
View File

@@ -0,0 +1,78 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
/**
* Print connector that writes to nowhere, but allows the user to retrieve the
* buffered data. Used for testing.
*/
final class DummyPrintConnector implements PrintConnector
{
/**
* @var array $buffer
* Buffer of accumilated data.
*/
private $buffer;
/**
* @var string data which the printer will provide on next read
*/
private $readData;
/**
* Create new print connector
*/
public function __construct()
{
$this -> buffer = [];
}
public function clear()
{
$this -> buffer = [];
}
public function __destruct()
{
if ($this -> buffer !== null) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
public function finalize()
{
$this -> buffer = null;
}
/**
* @return string Get the accumulated data that has been sent to this buffer.
*/
public function getData()
{
return implode($this -> buffer);
}
/**
* {@inheritDoc}
* @see PrintConnector::read()
*/
public function read($len)
{
return $len >= strlen($this -> readData) ? $this -> readData : substr($this -> readData, 0, $len);
}
public function write($data)
{
$this -> buffer[] = $data;
}
}

82
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/FilePrintConnector.php Normal file
View File

@@ -0,0 +1,82 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
use Exception;
/**
* PrintConnector for passing print data to a file.
*/
class FilePrintConnector implements PrintConnector
{
/**
* @var resource $fp
* The file pointer to send data to.
*/
protected $fp;
/**
* Construct new connector, given a filename
*
* @param string $filename
*/
public function __construct($filename)
{
$this -> fp = fopen($filename, "wb+");
if ($this -> fp === false) {
throw new Exception("Cannot initialise FilePrintConnector.");
}
}
public function __destruct()
{
if ($this -> fp !== false) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
/**
* Close file pointer
*/
public function finalize()
{
if ($this -> fp !== false) {
fclose($this -> fp);
$this -> fp = false;
}
}
/* (non-PHPdoc)
* @see PrintConnector::read()
*/
public function read($len)
{
if ($this -> fp === false) {
throw new Exception("PrintConnector has been closed, cannot read input.");
}
return fread($this -> fp, $len);
}
/**
* Write data to the file
*
* @param string $data
*/
public function write($data)
{
if ($this -> fp === false) {
throw new Exception("PrintConnector has been closed, cannot send output.");
}
fwrite($this -> fp, $data);
}
}

41
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/NetworkPrintConnector.php Normal file
View File

@@ -0,0 +1,41 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
use Exception;
/**
* PrintConnector for directly opening a network socket to a printer to send it commands.
*/
class NetworkPrintConnector extends FilePrintConnector
{
/**
* Construct a new NetworkPrintConnector
*
* @param string $ip IP address or hostname to use.
* @param string $port The port number to connect on.
* @param string $timeout The connection timeout, in seconds.
* @throws Exception Where the socket cannot be opened.
*/
public function __construct($ip, $port = "9100", $timeout = false)
{
// Default to 60 if default_socket_timeout isn't defined in the ini
$defaultSocketTimeout = ini_get("default_socket_timeout") ?: 60;
$timeout = $timeout ?: $defaultSocketTimeout;
$this -> fp = @fsockopen($ip, $port, $errno, $errstr, $timeout);
if ($this -> fp === false) {
throw new Exception("Cannot initialise NetworkPrintConnector: " . $errstr);
}
}
}

47
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/PrintConnector.php Normal file
View File

@@ -0,0 +1,47 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
/**
* Interface passed to Escpos class for receiving print data. Print connectors
* are responsible for transporting this to the actual printer.
*/
interface PrintConnector
{
/**
* Print connectors should cause a NOTICE if they are deconstructed
* when they have not been finalized.
*/
public function __destruct();
/**
* Finish using this print connector (close file, socket, send
* accumulated output, etc).
*/
public function finalize();
/**
* Read data from the printer.
*
* @param string $len Length of data to read.
* @return Data read from the printer, or false where reading is not possible.
*/
public function read($len);
/**
* Write data to the print connector.
*
* @param string $data The data to write
*/
public function write($data);
}

81
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/RawbtPrintConnector.php Normal file
View File

@@ -0,0 +1,81 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
/**
* Print connector for android RawBT application
* https://play.google.com/store/apps/details?id=ru.a402d.rawbtprinter
*/
final class RawbtPrintConnector implements PrintConnector
{
/**
* @var array $buffer
* Buffer of accumilated data.
*/
private $buffer;
/**
* @var string data which the printer will provide on next read
*/
private $readData;
/**
* Create new print connector
*/
public function __construct()
{
ob_start();
$this->buffer = [];
}
public function clear()
{
$this->buffer = [];
}
public function __destruct()
{
if ($this->buffer !== null) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
public function finalize()
{
ob_end_clean();
echo "intent:base64," . base64_encode($this->getData()) . "#Intent;scheme=rawbt;package=ru.a402d.rawbtprinter;end;";
$this->buffer = null;
}
/**
* @return string Get the accumulated data that has been sent to this buffer.
*/
public function getData()
{
return implode($this->buffer);
}
/**
* {@inheritDoc}
* @see PrintConnector::read()
*/
public function read($len)
{
return $len >= strlen($this->readData) ? $this->readData : substr($this->readData, 0, $len);
}
public function write($data)
{
$this->buffer[] = $data;
}
}

44
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/UriPrintConnector.php Normal file
View File

@@ -0,0 +1,44 @@
<?php
namespace Mike42\Escpos\PrintConnectors;
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
class UriPrintConnector
{
const URI_ASSEMBLER_PATTERN = "~^(.+):/{2}(.+?)(?::(\d{1,4}))?$~";
public static function get($uri)
{
// Parse URI
$is_uri = preg_match(self::URI_ASSEMBLER_PATTERN, $uri, $uri_parts);
if ($is_uri !== 1) {
throw new \InvalidArgumentException("Malformed connector URI: {$uri}");
}
// Extract parts
$protocol = $uri_parts[1];
$printer = $uri_parts[2];
$port = isset($uri_parts[3]) ? $uri_parts[3] : 9100;
// Initialise the most applicable print connector
switch ($protocol) {
case "file":
return new FilePrintConnector($printer);
case "tcp":
return new NetworkPrintConnector($printer, $port);
case "smb":
return new WindowsPrintConnector($uri);
}
// Fallthrough
throw new \InvalidArgumentException("URI sheme is not supported: {$protocol}://");
}
}

391
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/PrintConnectors/WindowsPrintConnector.php Normal file
View File

@@ -0,0 +1,391 @@
<?php
/**
* This file is part of escpos-php: PHP receipt printer library for use with
* ESC/POS-compatible thermal and impact printers.
*
* Copyright (c) 2014-18 Michael Billington < michael.billington@gmail.com >,
* incorporating modifications by others. See CONTRIBUTORS.md for a full list.
*
* This software is distributed under the terms of the MIT license. See LICENSE.md
* for details.
*/
namespace Mike42\Escpos\PrintConnectors;
use Exception;
use BadMethodCallException;
/**
* Connector for sending print jobs to
* - local ports on windows (COM1, LPT1, etc)
* - shared (SMB) printers from any platform (smb://server/foo)
* For USB printers or other ports, the trick is to share the printer with a
* generic text driver, then connect to the shared printer locally.
*/
class WindowsPrintConnector implements PrintConnector
{
/**
* @var array $buffer
* Accumulated lines of output for later use.
*/
private $buffer;
/**
* @var string $hostname
* The hostname of the target machine, or null if this is a local connection.
*/
private $hostname;
/**
* @var boolean $isLocal
* True if a port is being used directly (must be Windows), false if network shares will be used.
*/
private $isLocal;
/**
* @var int $platform
* Platform we're running on, for selecting different commands. See PLATFORM_* constants.
*/
private $platform;
/**
* @var string $printerName
* The name of the target printer (eg "Foo Printer") or port ("COM1", "LPT1").
*/
private $printerName;
/**
* @var string $userName
* Login name for network printer, or null if not using authentication.
*/
private $userName;
/**
* @var string $userPassword
* Password for network printer, or null if no password is required.
*/
private $userPassword;
/**
* @var string $workgroup
* Workgroup that the printer is located on
*/
private $workgroup;
/**
* Represents Linux
*/
const PLATFORM_LINUX = 0;
/**
* Represents Mac
*/
const PLATFORM_MAC = 1;
/**
* Represents Windows
*/
const PLATFORM_WIN = 2;
/**
* Valid local ports.
*/
const REGEX_LOCAL = "/^(LPT\d|COM\d)$/";
/**
* Valid printer name.
*/
const REGEX_PRINTERNAME = "/^[\d\w-]+(\s[\d\w-]+)*$/";
/**
* Valid smb:// URI containing hostname & printer with optional user & optional password only.
*/
const REGEX_SMB = "/^smb:\/\/([\s\d\w-]+(:[\s\d\w+-]+)?@)?([\d\w-]+\.)*[\d\w-]+\/([\d\w-]+\/)?[\d\w-]+(\s[\d\w-]+)*$/";
/**
* @param string $dest
* @throws BadMethodCallException
*/
public function __construct($dest)
{
$this -> platform = $this -> getCurrentPlatform();
$this -> isLocal = false;
$this -> buffer = null;
$this -> userName = null;
$this -> userPassword = null;
$this -> workgroup = null;
if (preg_match(self::REGEX_LOCAL, $dest) == 1) {
// Straight to LPT1, COM1 or other local port. Allowed only if we are actually on windows.
if ($this -> platform !== self::PLATFORM_WIN) {
throw new BadMethodCallException("WindowsPrintConnector can only be " .
"used to print to a local printer ('".$dest."') on a Windows computer.");
}
$this -> isLocal = true;
$this -> hostname = null;
$this -> printerName = $dest;
} elseif (preg_match(self::REGEX_SMB, $dest) == 1) {
// Connect to samba share, eg smb://host/printer
$part = parse_url($dest);
$this -> hostname = $part['host'];
/* Printer name and optional workgroup */
$path = ltrim($part['path'], '/');
if (strpos($path, "/") !== false) {
$pathPart = explode("/", $path);
$this -> workgroup = $pathPart[0];
$this -> printerName = $pathPart[1];
} else {
$this -> printerName = $path;
}
/* Username and password if set */
if (isset($part['user'])) {
$this -> userName = $part['user'];
if (isset($part['pass'])) {
$this -> userPassword = $part['pass'];
}
}
} elseif (preg_match(self::REGEX_PRINTERNAME, $dest) == 1) {
// Just got a printer name. Assume it's on the current computer.
$hostname = gethostname();
if (!$hostname) {
$hostname = "localhost";
}
$this -> hostname = $hostname;
$this -> printerName = $dest;
} else {
throw new BadMethodCallException("Printer '" . $dest . "' is not a valid " .
"printer name. Use local port (LPT1, COM1, etc) or smb://computer/printer notation.");
}
$this -> buffer = [];
}
public function __destruct()
{
if ($this -> buffer !== null) {
trigger_error("Print connector was not finalized. Did you forget to close the printer?", E_USER_NOTICE);
}
}
public function finalize()
{
$data = implode($this -> buffer);
$this -> buffer = null;
if ($this -> platform == self::PLATFORM_WIN) {
$this -> finalizeWin($data);
} elseif ($this -> platform == self::PLATFORM_LINUX) {
$this -> finalizeLinux($data);
} else {
$this -> finalizeMac($data);
}
}
/**
* Send job to printer -- platform-specific Linux code.
*
* @param string $data Print data
* @throws Exception
*/
protected function finalizeLinux($data)
{
/* Non-Windows samba printing */
$device = "//" . $this -> hostname . "/" . $this -> printerName;
if ($this -> userName !== null) {
$user = ($this -> workgroup != null ? ($this -> workgroup . "\\") : "") . $this -> userName;
if ($this -> userPassword == null) {
// No password
$command = sprintf(
"smbclient %s -U %s -c %s -N -m SMB2",
escapeshellarg($device),
escapeshellarg($user),
escapeshellarg("print -")
);
$redactedCommand = $command;
} else {
// With password
$command = sprintf(
"smbclient %s %s -U %s -c %s -m SMB2",
escapeshellarg($device),
escapeshellarg($this -> userPassword),
escapeshellarg($user),
escapeshellarg("print -")
);
$redactedCommand = sprintf(
"smbclient %s %s -U %s -c %s -m SMB2",
escapeshellarg($device),
escapeshellarg("*****"),
escapeshellarg($user),
escapeshellarg("print -")
);
}
} else {
// No authentication information at all
$command = sprintf(
"smbclient %s -c %s -N -m SMB2",
escapeshellarg($device),
escapeshellarg("print -")
);
$redactedCommand = $command;
}
$retval = $this -> runCommand($command, $outputStr, $errorStr, $data);
if ($retval != 0) {
throw new Exception("Failed to print. Command \"$redactedCommand\" " .
"failed with exit code $retval: " . trim($errorStr) . trim($outputStr));
}
}
/**
* Send job to printer -- platform-specific Mac code.
*
* @param string $data Print data
* @throws Exception
*/
protected function finalizeMac($data)
{
throw new Exception("Mac printing not implemented.");
}
/**
* Send data to printer -- platform-specific Windows code.
*
* @param string $data
*/
protected function finalizeWin($data)
{
/* Windows-friendly printing of all sorts */
if (!$this -> isLocal) {
/* Networked printing */
$device = "\\\\" . $this -> hostname . "\\" . $this -> printerName;
if ($this -> userName !== null) {
/* Log in */
$user = "/user:" . ($this -> workgroup != null ? ($this -> workgroup . "\\") : "") . $this -> userName;
if ($this -> userPassword == null) {
$command = sprintf(
"net use %s %s",
escapeshellarg($device),
escapeshellarg($user)
);
$redactedCommand = $command;
} else {
$command = sprintf(
"net use %s %s %s",
escapeshellarg($device),
escapeshellarg($user),
escapeshellarg($this -> userPassword)
);
$redactedCommand = sprintf(
"net use %s %s %s",
escapeshellarg($device),
escapeshellarg($user),
escapeshellarg("*****")
);
}
$retval = $this -> runCommand($command, $outputStr, $errorStr);
if ($retval != 0) {
throw new Exception("Failed to print. Command \"$redactedCommand\" " .
"failed with exit code $retval: " . trim($errorStr));
}
}
/* Final print-out */
$filename = tempnam(sys_get_temp_dir(), "escpos");
file_put_contents($filename, $data);
if (!$this -> runCopy($filename, $device)) {
throw new Exception("Failed to copy file to printer");
}
unlink($filename);
} else {
/* Drop data straight on the printer */
if (!$this -> runWrite($data, $this -> printerName)) {
throw new Exception("Failed to write file to printer at " . $this -> printerName);
}
}
}
/**
* @return string Current platform. Separated out for testing purposes.
*/
protected function getCurrentPlatform()
{
if (PHP_OS == "WINNT") {
return self::PLATFORM_WIN;
}
if (PHP_OS == "Darwin") {
return self::PLATFORM_MAC;
}
return self::PLATFORM_LINUX;
}
/* (non-PHPdoc)
* @see PrintConnector::read()
*/
public function read($len)
{
/* Two-way communication is not supported */
return false;
}
/**
* Run a command, pass it data, and retrieve its return value, standard output, and standard error.
*
* @param string $command the command to run.
* @param string $outputStr variable to fill with standard output.
* @param string $errorStr variable to fill with standard error.
* @param string $inputStr text to pass to the command's standard input (optional).
* @return number
*/
protected function runCommand($command, &$outputStr, &$errorStr, $inputStr = null)
{
$descriptors = [
0 => ["pipe", "r"],
1 => ["pipe", "w"],
2 => ["pipe", "w"],
];
$process = proc_open($command, $descriptors, $fd);
if (is_resource($process)) {
/* Write to input */
if ($inputStr !== null) {
fwrite($fd[0], $inputStr);
}
fclose($fd[0]);
/* Read stdout */
$outputStr = stream_get_contents($fd[1]);
fclose($fd[1]);
/* Read stderr */
$errorStr = stream_get_contents($fd[2]);
fclose($fd[2]);
/* Finish up */
$retval = proc_close($process);
return $retval;
} else {
/* Method calling this should notice a non-zero exit and print an error */
return -1;
}
}
/**
* Copy a file. Separated out so that nothing is actually printed during test runs.
*
* @param string $from Source file
* @param string $to Destination file
* @return boolean True if copy was successful, false otherwise
*/
protected function runCopy($from, $to)
{
return copy($from, $to);
}
/**
* Write data to a file. Separated out so that nothing is actually printed during test runs.
*
* @param string $data Data to print
* @param string $filename Destination file
* @return boolean True if write was successful, false otherwise
*/
protected function runWrite($data, $filename)
{
return file_put_contents($filename, $data) !== false;
}
public function write($data)
{
$this -> buffer[] = $data;
}
}

1217
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/Printer.php Normal file
View File

File diff suppressed because it is too large Load Diff

1760
htdocs/includes/mike42/escpos-php/src/Mike42/Escpos/resources/capabilities.json Normal file
View File

File diff suppressed because it is too large Load Diff

39
htdocs/includes/mike42/escpos-php/src/NetworkPrintConnector.php
View File

@@ -1,39 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* PrintConnector for directly opening a network socket to a printer to send it commands.
*/
class NetworkPrintConnector extends FilePrintConnector {
public function __construct($ip, $port = "9100") {
$this -> fp = @fsockopen($ip, $port, $errno, $errstr);
if($this -> fp === false) {
throw new Exception("Cannot initialise NetworkPrintConnector: " . $errstr);
}
}
}

90
htdocs/includes/mike42/escpos-php/src/P822DCapabilityProfile.php
View File

@@ -1,90 +0,0 @@
<?php
/**
* This capability profile is designed for the P-822D.
*
* See
* https://github.com/mike42/escpos-php/issues/50
*/
class P822DCapabilityProfile extends DefaultCapabilityProfile {
function getSupportedCodePages() {
return array(
0 => CodePage::CP437,
1 => false, // Katakana
2 => CodePage::CP850,
3 => CodePage::CP860,
4 => CodePage::CP863,
5 => CodePage::CP865,
6 => false, // Western Europe
7 => false, // Greek
8 => false, // Hebrew
9 => false, // Eastern europe
10 => false, // Iran
16 => CodePage::CP1252 ,
17 => CodePage::CP866 ,
18 => CodePage::CP852 ,
19 => CodePage::CP858,
20 => false, // Iran II
21 => false, // latvian
22 => false, //Arabic
23 => false, // PT151, 1251
24 => CodePage::CP747,
25 => CodePage::CP1257,
27 => false, // Vietnam,
28 => CodePage::CP864,
29 => CodePage::CP1001,
30 => false, // Uigur
31 => false, // Hebrew
32 => CodePage::CP1255,
33 => CodePage::CP720,
34 => CodePage::CP1256,
35 => CodePage::CP1257,
255 => false, // Thai
50 => CodePage::CP437,
51 => false, // Jatakana,
52 => CodePage::CP437,
53 => CodePage::CP858,
54 => CodePage::CP852,
55 => CodePage::CP860,
56 => CodePage::CP861,
57 => CodePage::CP863,
58 => CodePage::CP865,
59 => CodePage::CP866,
60 => CodePage::CP855,
61 => CodePage::CP857,
62 => CodePage::CP862,
63 => CodePage::CP864,
64 => CodePage::CP737,
65 => CodePage::CP851,
66 => CodePage::CP869,
67 => CodePage::CP928,
68 => CodePage::CP772,
69 => CodePage::CP774,
70 => CodePage::CP874,
71 => CodePage::CP1252,
72 => CodePage::CP1250,
73 => CodePage::CP1251,
74 => CodePage::CP3840,
75 => CodePage::CP3841,
76 => CodePage::CP3843,
77 => CodePage::CP3844,
78 => CodePage::CP3845,
79 => CodePage::CP3846,
80 => CodePage::CP3847,
81 => CodePage::CP3848,
82 => CodePage::CP1001,
83 => CodePage::CP2001,
84 => CodePage::CP3001,
85 => CodePage::CP3002,
86 => CodePage::CP3011,
87 => CodePage::CP3012,
88 => CodePage::CP3021,
89 => CodePage::CP3041
);
}
public function getSupportsGraphics() {
/* Ask the driver to use bitImage wherever possible instead of graphics */
return false;
}
}

75
htdocs/includes/mike42/escpos-php/src/PrintBuffer.php
View File

@@ -1,75 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Print buffers manage newlines and character encoding for the target printer.
* They are used as a swappable component: text or image-based output.
*
* - Text output (EscposPrintBuffer) is the fast default, and is recommended for
* most people, as the text output can be more directly manipulated by ESC/POS
* commands.
* - Image output (ImagePrintBuffer) is designed to accept more encodings than the
* physical printer supports, by rendering the text to small images on-the-fly.
* This takes a lot more CPU than sending text, but is necessary for some users.
* - If your use case fits outside these, then a further speed/flexibility trade-off
* can be made by printing directly from generated HTML or PDF.
*/
interface PrintBuffer {
/**
* Cause the buffer to send any partial input and wait on a newline.
* If the printer is already on a new line, this does nothing.
*/
function flush();
/**
* Used by Escpos to check if a printer is set.
*/
function getPrinter();
/**
* Used by Escpos to hook up one-to-one link between buffers and printers.
*
* @param Escpos $printer New printer
*/
function setPrinter(Escpos $printer = null);
/**
* Accept UTF-8 text for printing.
*
* @param string $text Text to print
*/
function writeText($text);
/**
* Accept 8-bit text in the current encoding and add it to the buffer.
*
* @param string $text Text to print, already the target encoding.
*/
function writeTextRaw($text);
}
?>

56
htdocs/includes/mike42/escpos-php/src/PrintConnector.php
View File

@@ -1,56 +0,0 @@
<?php
/**
* escpos-php, a Thermal receipt printer library, for use with
* ESC/POS compatible printers.
*
* Copyright (c) 2014-2015 Michael Billington <michael.billington@gmail.com>,
* incorporating modifications by:
* - Roni Saha <roni.cse@gmail.com>
* - Gergely Radics <gerifield@ustream.tv>
* - Warren Doyle <w.doyle@fuelled.co>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Interface passed to Escpos class for receiving print data. Print connectors
* are responsible for transporting this to the actual printer.
*/
interface PrintConnector {
/**
* Print connectors should cause a NOTICE if they are deconstructed
* when they have not been finalized.
*/
public function __destruct();
/**
* Finish using this print connector (close file, socket, send
* accumulated output, etc).
*/
public function finalize();
/**
* @param string $data
* @return Data read from the printer, or false where reading is not possible.
*/
public function read($len);
/**
* @param string $data
*/
public function write($data);
}

Some files were not shown because too many files have changed in this diff Show More