PHP Class Mike42\Escpos\Printer

__construct() public méthode

Construct a new print object

public __construct ( Mike42\Escpos\PrintConnectors\PrintConnector $connector, CapabilityProfile $profile = null )
$connector	Mike42\Escpos\PrintConnectors\PrintConnector	The PrintConnector to send data to. If not set, output is sent to standard output.
$profile	CapabilityProfile	Supported features of this printer. If not set, the "default" CapabilityProfile will be used, which is suitable for Epson printers.

barcode() public méthode

Print a barcode.

public barcode ( string $content, integer $type = Printer::BARCODE_CODE39 )
$content	string	The information to encode.
$type	integer	The barcode standard to output. Supported values are `Printer::BARCODE_UPCA`, `Printer::BARCODE_UPCE`, `Printer::BARCODE_JAN13`, `Printer::BARCODE_JAN8`, `Printer::BARCODE_CODE39`, `Printer::BARCODE_ITF`, `Printer::BARCODE_CODABAR`, `Printer::BARCODE_CODE93`, and `Printer::BARCODE_CODE128`. If not specified, `Printer::BARCODE_CODE39` will be used. Note that some barcode formats only support specific lengths or sets of characters, and that available barcode types vary between printers.

bitImage() public méthode

Should only be used if your printer does not support the graphics() command. See also bitImageColumnFormat().

public bitImage ( EscposImage $img, integer $size = Printer::IMG_DEFAULT )
$img	EscposImage	The image to print
$size	integer	Size modifier for the image. Must be either `Printer::IMG_DEFAULT` (default), or any combination of the `Printer::IMG_DOUBLE_HEIGHT` and `Printer::IMG_DOUBLE_WIDTH` flags.

bitImageColumnFormat() public méthode

Should only be used if your printer does not support the graphics() or bitImage() commands.

public bitImageColumnFormat ( EscposImage $img, integer $size = Printer::IMG_DEFAULT )
$img	EscposImage	The image to print
$size	integer	Size modifier for the image. Must be either `Printer::IMG_DEFAULT` (default), or any combination of the `Printer::IMG_DOUBLE_HEIGHT` and `Printer::IMG_DOUBLE_WIDTH` flags.

close() public méthode

Close the underlying buffer. With some connectors, the job will not actually be sent to the printer until this is called.

public close ( )

cut() public méthode

Cut the paper.

public cut ( integer $mode = Printer::CUT_FULL, integer $lines = 3 )
$mode	integer	Cut mode, either Printer::CUT_FULL or Printer::CUT_PARTIAL. If not specified, `Printer::CUT_FULL` will be used.
$lines	integer	Number of lines to feed

feed() public méthode

Print and feed line / Print and feed n lines.

public feed ( integer $lines = 1 )
$lines	integer	Number of lines to feed

feedForm() public méthode

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.

public feedForm ( )

feedReverse() public méthode

Print and reverse feed n lines.

public feedReverse ( integer $lines = 1 )
$lines	integer	number of lines to feed. If not specified, 1 line will be fed.

getCharacterTable() public méthode

public getCharacterTable ( ) : number
Résultat	number

getPrintBuffer() public méthode

public getPrintBuffer ( ) : Mike42\Escpos\PrintBuffers\PrintBuffer
Résultat	Mike42\Escpos\PrintBuffers\PrintBuffer

getPrintConnector() public méthode

public getPrintConnector ( ) : Mike42\Escpos\PrintConnectors\PrintConnector
Résultat	Mike42\Escpos\PrintConnectors\PrintConnector

getPrinterCapabilityProfile() public méthode

public getPrinterCapabilityProfile ( ) : CapabilityProfile
Résultat	CapabilityProfile

graphics() public méthode

Size modifiers are: - Printer::IMG_DEFAULT (leave image at original size) - Printer::IMG_DOUBLE_WIDTH - Printer::IMG_DOUBLE_HEIGHT See the example/ folder for detailed examples. The functions bitImage() and bitImageColumnFormat() take the same parameters, and can be used if your printer doesn't support the newer graphics commands.

public graphics ( EscposImage $img, integer $size = Printer::IMG_DEFAULT )
$img	EscposImage	The image to print.
$size	integer	Size modifier for the image. Must be either `Printer::IMG_DEFAULT` (default), or any combination of the `Printer::IMG_DOUBLE_HEIGHT` and `Printer::IMG_DOUBLE_WIDTH` flags.

initialize() public méthode

Initialize printer. This resets formatting back to the defaults.

public initialize ( )

pdf417Code() public méthode

Print a two-dimensional data code using the PDF417 standard.

public pdf417Code ( string $content, number $width = 3, number $heightMultiplier = 3, number $dataColumnCount, real $ec = 0.1, number $options = Printer::PDF417_STANDARD )
$content	string	Text or numbers to store in the code
$width	number	Width of a module (pixel) in the printed code. Default is 3 dots.
$heightMultiplier	number	Multiplier for height of a module. Default is 3 times the width.
$dataColumnCount	number	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.
$ec	real	Error correction ratio, from 0.01 to 4.00. Default is 0.10 (10%).
$options	number	Standard code Printer::PDF417_STANDARD with start/end bars, or truncated code Printer::PDF417_TRUNCATED with start bars only.

pulse() public méthode

The default settings should open an Epson drawer.

public pulse ( integer $pin, integer $on_ms = 120, integer $off_ms = 240 )
$pin	integer	0 or 1, for pin 2 or pin 5 kick-out connector respectively.
$on_ms	integer	pulse ON time, in milliseconds.
$off_ms	integer	pulse OFF time, in milliseconds.

qrCode() public méthode

Print the given data as a QR code on the printer.

public qrCode ( string $content, integer $ec = Printer::QR_ECLEVEL_L, integer $size = 3, integer $model = Printer::QR_MODEL_2 )
$content	string	The content of the code. Numeric data will be more efficiently compacted.
$ec	integer	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.
$size	integer	Pixel size to use. Must be 1-16 (default 3)
$model	integer	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).

selectCharacterTable() public méthode

Switch character table (code page) manually. Used in conjunction with textRaw() to print special characters which can't be encoded automatically.

public selectCharacterTable ( integer $table )
$table	integer	The table to select. Available code tables are model-specific.

selectPrintMode() public méthode

Several MODE_* constants can be OR'd together passed to this function's $mode argument. The valid modes are: - Printer::MODE_FONT_A - Printer::MODE_FONT_B - Printer::MODE_EMPHASIZED - Printer::MODE_DOUBLE_HEIGHT - Printer::MODE_DOUBLE_WIDTH - Printer::MODE_UNDERLINE

public selectPrintMode ( integer $mode = Printer::MODE_FONT_A )
$mode	integer	The mode to use. Default is Printer::MODE_FONT_A, with no special formatting. This has a similar effect to running initialize().

setBarcodeHeight() public méthode

Set barcode height.

public setBarcodeHeight ( integer $height = 8 )
$height	integer	Height in dots. If not specified, 8 will be used.

setBarcodeTextPosition() public méthode

Set the position for the Human Readable Interpretation (HRI) of barcode characters.

public setBarcodeTextPosition ( $position = Printer::BARCODE_TEXT_NONE )

setBarcodeWidth() public méthode

Set barcode bar width.

public setBarcodeWidth ( integer $width = 3 )
$width	integer	Bar width in dots. If not specified, 3 will be used. Values above 6 appear to have no effect.

setColor() public méthode

Select print color on printers that support multiple colors.

public setColor ( integer $color = Printer::COLOR_1 )
$color	integer	Color to use. Must be either Printer::COLOR_1 (default), or Printer::COLOR_2.

setDoubleStrike() public méthode

Turn double-strike mode on/off.

public setDoubleStrike ( boolean $on = true )
$on	boolean	true for double strike, false for no double strike

setEmphasis() public méthode

@param boolean $on true for emphasis, false for no emphasis

public setEmphasis ( boolean $on = true )
$on	boolean

setFont() public méthode

Select font. Most printers have two fonts (Fonts A and B), and some have a third (Font C).

public setFont ( integer $font = Printer::FONT_A )
$font	integer	The font to use. Must be either Printer::FONT_A, Printer::FONT_B, or Printer::FONT_C.

setJustification() public méthode

Select justification.

public setJustification ( integer $justification = Printer::JUSTIFY_LEFT )
$justification	integer	One of Printer::JUSTIFY_LEFT, Printer::JUSTIFY_CENTER, or Printer::JUSTIFY_RIGHT.

setLineSpacing() public méthode

Some printers will allow you to overlap lines with a smaller line feed.

public setLineSpacing ( integer $height = null )
$height	integer	The height of each line, in dots. If not set, the printer will reset to its default line spacing.

setPrintBuffer() public méthode

Attach a different print buffer to the printer. Buffers are responsible for handling text output to the printer.

public setPrintBuffer ( Mike42\Escpos\PrintBuffers\PrintBuffer $buffer )
$buffer	Mike42\Escpos\PrintBuffers\PrintBuffer	The buffer to use.

setPrintLeftMargin() public méthode

Set print area left margin. Reset to default with Printer::initialize()

public setPrintLeftMargin ( integer $margin )
$margin	integer	The left margin to set on to the print area, in dots.

setPrintWidth() public méthode

Reset to default with Printer::initialize()

public setPrintWidth ( integer $width = 512 )
$width	integer	The width of the page print area, in dots.

setReverseColors() public méthode

Set black/white reverse mode on or off. In this mode, text is printed white on a black background.

public setReverseColors ( boolean $on = true )
$on	boolean	True to enable, false to disable.

setTextSize() public méthode

Set the size of text, as a multiple of the normal size.

public setTextSize ( integer $widthMultiplier, integer $heightMultiplier )
$widthMultiplier	integer	Multiple of the regular height to use (range 1 - 8)
$heightMultiplier	integer	Multiple of the regular height to use (range 1 - 8)

setUnderline() public méthode

Argument can be true/false, or one of UNDERLINE_NONE, UNDERLINE_SINGLE or UNDERLINE_DOUBLE.

public setUnderline ( integer $underline = Printer::UNDERLINE_SINGLE )
$underline	integer	Either true/false, or one of Printer::UNDERLINE_NONE, Printer::UNDERLINE_SINGLE or Printer::UNDERLINE_DOUBLE. Defaults to Printer::UNDERLINE_SINGLE.

text() public méthode

Text should either be followed by a line-break, or feed() should be called after this to clear the print buffer.

public text ( string $str = "" )
$str	string	Text to print

textChinese() public méthode

Support for this will be merged into a print buffer.

public textChinese ( string $str = "" )
$str	string	Text to print, as UTF-8

textRaw() public méthode

Text should either be followed by a line-break, or feed() should be called after this to clear the print buffer.

public textRaw ( string $str = "" )
$str	string	Text to print

validateBoolean() protected static méthode

Throw an exception if the argument given is not a boolean

protected static validateBoolean ( boolean $test, string $source )
$test	boolean	the input to test
$source	string	the name of the function calling this

validateFloat() protected static méthode

Throw an exception if the argument given is not a float within the specified range

protected static validateFloat ( float $test, float $min, float $max, string $source, string $argument = "Argument" )
$test	float	the input to test
$min	float	the minimum allowable value (inclusive)
$max	float	the maximum allowable value (inclusive)
$source	string	the name of the function calling this
$argument	string	the name of the invalid parameter

validateInteger() protected static méthode

Throw an exception if the argument given is not an integer within the specified range

protected static validateInteger ( integer $test, integer $min, integer $max, string $source, string $argument = "Argument" )
$test	integer	the input to test
$min	integer	the minimum allowable value (inclusive)
$max	integer	the maximum allowable value (inclusive)
$source	string	the name of the function calling this
$argument	string	the name of the invalid parameter

validateIntegerMulti() protected static méthode

Throw an exception if the argument given is not an integer within one of the specified ranges

protected static validateIntegerMulti ( integer $test, array $ranges, string $source, string $argument = "Argument" )
$test	integer	the input to test
$ranges	array	array of two-item min/max ranges.
$source	string	the name of the function calling this
$argument	string	the name of the invalid parameter

validateString() protected static méthode

Throw an exception if the argument given can't be cast to a string

protected static validateString ( string $test, string $source, string $argument = "Argument" )
$test	string	the input to test
$source	string	the name of the function calling this
$argument	string	the name of the parameter being validated

validateStringRegex() protected static méthode

Throw an exception if the argument doesn't match the given regex.

protected static validateStringRegex ( string $test, string $source, string $regex, string $argument = "Argument" )
$test	string	the input to test
$source	string	the name of the function calling this
$regex	string	valid values for this attribute, as a regex
$argument	string	the name of the parameter being validated