Author image Dominic Sonntag
and 1 contributors

new

Constructs a tags object.

tag_allowed

Returns true if the given tag is defined.

parse( $element )

Method for recursive parsing of tags.

simple_switch

Helper method for simple 0/1 switches.

include_global_options

Helper method to add global options to object options.

_0

Prints plain text and strips out leading and trailing whitespaces.

_text

Prints plain text. To activate automatic word wrapping, you can use the attribute wordwrap to set the word wrap width (use the maximum number of characters per line. When wordwrap is active, you can set the bodystart parameter to define the characters that should be printed at the beginning of each line (except the first one). You can use this to set some indentation.

_bold

Sets text to be printed bold.

_doubleStrike

Sets text to be printed double striked.

_invert

Sets text to be printed inverted.

_underline

Sets text to be printed underlined.

_upsideDown

Sets Upside Down Printing.

_color

Use this tag to use the second color (if support by your printer).

_rot90

Use this tag to use the second color (if support by your printer).

_qr

Prints a QR code. Possible attributes:

ecc

version

moduleSize

_barcode

Prints a barcode to the printer. See Printer::ESCPOS::Manual for a list of possible options. The barcode content should be set as the tag content like <barcode>content</barcode>. All other options must be set as attributes.

_utf8ImagedText

Can print text with special styling. Use the parameters allowed in Printer::ESCPOS's method utf8ImagedText as attributes for the utf8ImagedText tag. In addition you can use the attribute wordwrap to set the word wrap width. By now, it is only possible to set the maximum number of characters per line. Later we should try to implement a wrapping based in the maximum pixel width of a line. When wordwrap is active, you can set the bodystart parameter to define the characters that should be printed at the beginning of each line (except the first one). You can use this to set some indentation.

_lf

Moves to the next line. If the lines attribute is given, move that number of lines.

_tab

Moves the cursor to next horizontal tab position.

_image

Print image from named file.

_printAreaWidth

Sets the print area width.

_set

Sets global variables: paperWidth, wordwrap, fontFamily, fontSize, fontStyle, lineHeight, printAreaWidth

_unset

Resets global variables to standard values: paperWidth, wordwrap, fontFamily, fontSize, fontStyle, lineHeight, printAreaWidth Syntax: <unset fontStyle="" />

_hr

Adds a horizontal line. Use the thickness attribute to set the line's thickness. Defaults to 2.

_tabpositions

Sets horizontal tab positions for tab stops. Syntax for XML is the following:

    <tabpositions>
      <tabposition>5</tabposition>
      <tabposition>9</tabposition>
      <tabposition>13</tabposition>
    </tabpositions>

_repeat

Repeats the content n times. Syntax:

    <repeat times="3">
        [tags to repeat]
    </repeat>

_justify

Set justification to left, right or center. Syntax for XML is the following: <justify align="right">text</justify>

_table

Prints text in table format. By now, this tool is only helpful for monospaced fonts. Possible cell parameters are width (only in pattern row), colspan and align (right, left, center). Possible line parameters are fontStyle and align. Possible table parameters are fontSize, wordwrap, lineHeight, paperWidth, separator, leftBorder, rightBorder and fontStyle.

check_table_validity

Checks validity of table tags and attributes. (Helper for table tag.)

get_rows_and_cells

Returns table rows and cells (options and content). (Helper for table tag.)

calculate_table_column_widths

Calculates the width for each table column. (Helper for table tag.)

break_table_lines

Breaks cell content if it doesn't fit column width and returns table rows and cells (options and content). (Helper for table tag.)

NOT YET IMPLEMENTED TAGS

_font

Choose font a, b or c.

_fontHeight

Set font height.

_fontWidth

Set font width.

_charSpacing

Set character spacing.

_lineSpacing

Set line spacing.

_selectDefaultLineSpacing

Reverts to default line spacing for the printer.

_printPosition

Sets the distance from the beginning of the line to the position at which characters are to be printed.

_leftMargin

Sets the left margin for printing.

_printNVImage

Prints bit image stored in non-volatile (NV) memory of the printer.

_printImage

Prints bit image stored in volatile memory of the printer.