Zend\Barcode\Object\ObjectInterface
Interface for generate Barcode
Synopsis
interface ObjectInterface
{
- // methods
- public void __construct()
- public ObjectInterface setOptions()
- public ObjectInterface setBarcodeNamespace()
- public string getBarcodeNamespace()
- public string getType()
- public ObjectInterface setBarHeight()
- public int getBarHeight()
- public ObjectInterface setBarThinWidth()
- public int getBarThinWidth()
- public ObjectInterface setBarThickWidth()
- public int getBarThickWidth()
- public ObjectInterface setFactor()
- public int getFactor()
- public ObjectInterface setForeColor()
- public int getForeColor()
- public ObjectInterface setBackgroundColor()
- public int getBackgroundColor()
- public ObjectInterface setWithBorder()
- public bool getWithBorder()
- public ObjectInterface setReverseColor()
- public ObjectInterface setOrientation()
- public float getOrientation()
- public ObjectInterface setText()
- public string getText()
- public string getRawText()
- public string getTextToDisplay()
- public ObjectInterface setDrawText()
- public bool getDrawText()
- public ObjectInterface setStretchText()
- public bool getStretchText()
- public ObjectInterface setWithChecksum()
- public bool getWithChecksum()
- public ObjectInterface setWithChecksumInText()
- public bool getWithChecksumInText()
- public ObjectInterface setFont()
- public int|string getFont()
- public ObjectInterface setFontSize()
- public float getFontSize()
- public int getQuietZone()
- public array getInstructions()
- public void checkParams()
- public int getHeight()
- public int getWidth()
- public float getOffsetLeft()
- public float getOffsetTop()
- public array draw()
- public void validateText()
Methods
public
- __construct() — Constructor
- checkParams() — Checking of parameters after all settings
- draw() — Complete drawing of the barcode
- getBackgroundColor() — Retrieve background color of the image
- getBarHeight() — Get height of the barcode bar
- getBarThickWidth() — Get thickness of thick bar
- getBarThinWidth() — Get thickness of thin bar
- getBarcodeNamespace() — Retrieve barcode namespace
- getDrawText() — Retrieve if drawing of text to encode is enabled
- getFactor() — Get factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize
- getFont() — Retrieve the font
- getFontSize() — Retrieve the size of the font in case of TTF
- getForeColor() — Retrieve color of the barcode and text
- getHeight() — Get height of the result object
- getInstructions() — Retrieve the set of drawing instructions
- getOffsetLeft() — Calculate the offset from the left of the object if an orientation is activated
- getOffsetTop() — Calculate the offset from the top of the object if an orientation is activated
- getOrientation() — Retrieve orientation of barcode and text
- getQuietZone() — Quiet zone before first bar and after the last bar
- getRawText() — Retrieve text to encode
- getStretchText() — Retrieve if the adjustment of the position of the characters to the position of the bars is enabled
- getText() — Retrieve text to encode
- getTextToDisplay() — Retrieve text to display
- getType() — Retrieve type of barcode
- getWidth() — Get width of the result object
- getWithBorder() — Retrieve if border are draw or not
- getWithChecksum() — Retrieve if the checksum character is automatically added to the barcode text
- getWithChecksumInText() — Retrieve if the checksum character is automatically added to the barcode text
- setBackgroundColor() — Set the color of the background
- setBarHeight() — Set height of the barcode bar
- setBarThickWidth() — Set thickness of thick bar
- setBarThinWidth() — Set thickness of thin bar
- setBarcodeNamespace() — Set barcode namespace for autoloading
- setDrawText() — Activate/deactivate drawing of text to encode
- setFactor() — Set factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize
- setFont() — Set the font: - if integer between 1 and 5, use gd built-in fonts - if string, $value is assumed to be the path to a TTF font
- setFontSize() — Set the size of the font in case of TTF
- setForeColor() — Set color of the barcode and text
- setOptions() — Set barcode state from options array
- setOrientation() — Set orientation of barcode and text
- setReverseColor() — Allow fast inversion of font/bars color and background color
- setStretchText() — Activate/deactivate the adjustment of the position of the characters to the position of the bars
- setText() — Set text to encode
- setWithBorder() — Activate/deactivate drawing of the bar
- setWithChecksum() — Activate/deactivate the automatic generation of the checksum character added to the barcode text
- setWithChecksumInText() — Activate/deactivate the automatic generation of the checksum character added to the barcode text
- validateText() — Check for invalid characters