php-print.php

<?php
/**
 * Copyright (c) 2014 Michael Billington <michael.billington@gmail.com>,
 *   with additions by Warren Doyle (wdoyle)
 * 
 * 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.
 * 
 * If you wish to expand this library you can use the below link:
 * http://content.epson.de/fileadmin/content/files/RSD/downloads/escpos.pdf
 */
define("DEBUG_MODE", 0);

if(DEBUG_MODE == 1)
{
	error_reporting(E_ALL);
	ini_set("display_errors", 1);
}

class phpprint {
	/* ASCII codes */
	const NUL = "\x00";
	const LF = "\x0a";
	const ESC = "\x1b";
	const GS = "\x1d";

	/* 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;

	/* Fonts */
	const FONT_A = 0;
	const FONT_B = 1;
	const FONT_C = 2;

	/* Justifications */
	const JUSTIFY_LEFT = 0;
	const JUSTIFY_CENTER = 1;
	const JUSTIFY_RIGHT = 2;

	/* Cut types */
	const CUT_FULL = 65;
	const CUT_PARTIAL = 66;

	/* Barcode types */
	const BARCODE_UPCA = 0;
	const BARCODE_UPCE = 1;
	const BARCODE_JAN13 = 2;
	const BARCODE_JAN8 = 3;
	const BARCODE_CODE39 = 4;
	const BARCODE_ITF = 5;
	const BARCODE_CODABAR = 6;
	private $fp;

	function __construct($head = null) {
		//THIS IS THE SERIAL PORT YOU ARE OPENING
		$fp = fopen($head,"w");
		$this -> fp = $fp;
		$this -> initialize();
	}
	/**
	 * Add text to the buffer
	 *
	 * @param string $str Text to print
	 */
	function text($str = "") {
		if(DEBUG_MODE == 1)
			echo $str;

		fwrite($this -> fp, $str);
	}
	/**
	 * Print and feed line / Print and feed n lines
	 *
	 * @param int $lines Number of lines to feed
	 */
	function feed($lines = 1) {
		if($lines <= 1) {
			fwrite($this -> fp, self::LF);
		} else {
			fwrite($this -> fp, self::ESC . "d" . chr($lines));
		}
	}
	/**
	 * Select print mode(s).
	 *
	 * Arguments should be OR'd together MODE_* constants:
	 * MODE_FONT_A
	 * MODE_FONT_B
	 * MODE_EMPHASIZED
	 * MODE_DOUBLE_HEIGHT
	 * MODE_DOUBLE_WIDTH
	 * MODE_UNDERLINE
	 *
	 * @param int $mode
	 */
	function select_print_mode($mode = self::NUL) {
		fwrite($this -> fp, self::ESC . "!" . chr($mode));
	}
	function reverse_mode($rev = 0) {
		fwrite($this -> fp, self::GS . "B" . chr($rev));
	}
	/**
	 * Turn underline mode on/off
	 *
	 * @param int $underline 0 for no underline, 1 for underline, 2 for heavy underline
	 */
	function set_underline($underline = 1) {
		fwrite($this -> fp, self::ESC . "-". chr($underline));
	}
	/**
	 * Initialize printer
	 */
	function initialize() {
		fwrite($this -> fp, self::ESC . "@");
	}
	/**
	 * Turn emphasized mode on/off
	 *
	 *  @param boolean $on true for emphasis, false for no emphasis
	 */
	function set_emphasis($on = false) {
		fwrite($this -> fp, self::ESC . "E". ($on ? chr(1) : chr(0)));
	}
	/**
	 * Turn double-strike mode on/off
	 *
	 * @param boolean $on true for double strike, false for no double strike
	 */
	function set_double_strike($on = false) {
		fwrite($this -> fp, self::ESC . "G". ($on ? chr(1) : chr(0)));
	}
	/**
	 * Select character font.
	 * Font must be FONT_A, FONT_B, or FONT_C.
	 *
	 * @param int $font
	 */
	function set_font($font = self::FONT_A) {
		fwrite($this -> fp, self::ESC . "M" . chr($font));
	}
	/**
	 * Select justification
	 * Justification must be JUSTIFY_LEFT, JUSTIFY_CENTER, or JUSTIFY_RIGHT.
	 */
	function set_justification($justification = self::JUSTIFY_LEFT) {
		fwrite($this -> fp, self::ESC . "a" . chr($justification));
	}
	/**
	 * Print and reverse feed n lines
	 *
	 * @param int $lines number of lines to feed
	 */
	function feed_reverse($lines = 1) {
		fwrite($this -> fp, self::ESC . "e" . chr($lines));
	}
	/**
	 * Cut the paper
	 *
	 * @param int $mode Cut mode, either CUT_FULL or CUT_PARTIAL
	 * @param int $lines Number of lines to feed
	 */
	function cut($mode = self::CUT_FULL, $lines = 3) {
		fwrite($this -> fp, self::GS . "V" . chr($mode) . chr($lines));
	}
	/**
	 * Set barcode height
	 *
	 * @param int $height Height in dots
	 */
	function set_barcode_height($height = 8) {
		fwrite($this -> fp, self::GS . "h" . chr($height));
	}
	/**
	 * Print a barcode
	 *
	 * @param string $content
	 * @param int $type
	 */
	function barcode($content, $type = self::BARCODE_CODE39) {
		fwrite($this -> fp, self::GS . "k" . chr($type) . $content . self::NUL);
	}
	/**
	 * This will generate a Barcode and print it directly to the Printer
	 *
	 * @param string $content
	 * @param int $type
	 * @param int $height
	 *
	 */
	function generateBarcode($content, $type, $height)
	{
		$this->set_barcode_height($height);
		$this->barcode($content, $type);
		$this->feed();
	}
	/*
	 *
	 *  This will increase the font used on the page whilst it is true
	 * 	@param bool $on
	 *
	 */
	function enlargePrint($on = false)
	{
		if($on == true)
			$this->select_print_mode(self::MODE_DOUBLE_HEIGHT);
		else
			$this->select_print_mode();

	}

	/*
	 *  This will print an empty line
	 */
	function newline()
	{
		$this->text("\n");
	}

	/**
	 * 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) {
		fwrite($this -> fp, self::ESC . "p" . chr($m + 48) . chr($t1 / 2) . chr($t2 / 2));
	}
}