classes-Com-Tecnick-Barcode-Type-Linear-RoyalMailFourCc

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.
​

Com\Tecnick\Barcode\Type\Linear\RoyalMailFourCc;

RoyalMailFourCC Barcode type class RMS4CC (Royal Mail 4-state Customer Bar Code)

Tags
since
2015-02-21
category

Library

author

Nicola Asuni info@tecnick.com

copyright

2010-2016 Nicola Asuni - Tecnick.com LTD

license

http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)

link
https://github.com/tecnickcom/tc-lib-barcode

Table of Contents

$bars  : array<string|int, mixed>
Array containing the position and dimensions of each barcode bar (x, y, width, height)
$bg_color_obj  : Color
Backgorund Color object
$chbar  : array<string|int, mixed>
Map characters to barcodes
$chksum  : array<string|int, mixed>
Characters used for checksum
$code  : string
Code to convert (barcode content)
$color_obj  : Color
Foreground Color object
$extcode  : string
Resulting code after applying checksum etc.
$format  : string
Barcode format
$height  : float
Barcode height
$height_ratio  : float
Ratio between the barcode height and the number of columns
$ncols  : int
Total number of columns
$nrows  : int
Total number of rows
$padding  : array<string|int, mixed>
Additional padding to add around the barcode (top, right, bottom, left) in user units.
$params  : array<string|int, mixed>
Array containing extra parameters for the specified barcode type
$type  : string
Barcode type (linear or square)
$width  : float
Barcode width
$width_ratio  : float
Ratio between the barcode width and the number of rows
__construct()  : mixed
Initialize a new barcode object
getArray()  : array<string|int, mixed>
Get the barcode raw array
getBarsArray()  : array<string|int, mixed>
Get the array containing all the formatted bars coordinates
getExtendedCode()  : string
Get the extended code (code + checksum)
getGd()  : object
Get the barcode as GD image object (requires GD library)
getGrid()  : string
Get a raw barcode string representation using characters
getGridArray()  : array<string|int, mixed>
Get a raw barcode grid array
getHtmlDiv()  : string
Get an HTML representation of the barcode.
getPng()  : mixed
Get Barcode as PNG Image (requires GD or Imagick library)
getPngData()  : string
Get the barcode as PNG image (requires GD or Imagick library)
getPngDataImagick()  : object
Get the barcode as PNG image (requires Imagick library)
getSvg()  : mixed
Get the barcode as SVG image object
getSvgCode()  : string
Get the barcode as SVG code
setBackgroundColor()  : mixed
Set the background color
setColor()  : mixed
Set the color of the bars.
setSize()  : mixed
Set the size of the barcode to be exported
convertDecToHex()  : string
Convert large integer number to hexadecimal representation.
convertHexToDec()  : string
Convert large hexadecimal number to decimal representation (string).
formatCode()  : mixed
Format code
getBarRectXYWH()  : array<string|int, mixed>
Get the adjusted rectangular coordinates (x,y,w,h) for the specified bar
getBarRectXYXY()  : array<string|int, mixed>
Get the adjusted rectangular coordinates (x1,y1,x2,y2) for the specified bar
getChecksum()  : char
Calculate the checksum.
getCoreBars()  : mixed
Get the central bars
getRgbColorObject()  : Color
Get the RGB Color object for the given color representation
getRotatedBarArray()  : array<string|int, mixed>
Returns the bars array ordered by columns
processBinarySequence()  : mixed
Import a binary sequence of comma-separated 01 strings
setBars()  : mixed
Get the bars array
setPadding()  : mixed
Set the barcode padding
setParameters()  : mixed
Set extra (optional) parameters

Properties

$bars

Array containing the position and dimensions of each barcode bar (x, y, width, height)

protected array<string|int, mixed> $bars = array()

$bg_color_obj

Backgorund Color object

protected Color $bg_color_obj

object

$chbar

Map characters to barcodes

protected array<string|int, mixed> $chbar = array('0' => '3322', '1' => '3412', '2' => '3421', '3' => '4312', '4' => '4321', '5' => '4411', '6' => '3142', '7' => '3232', '8' => '3241', '9' => '4132', 'A' => '4141', 'B' => '4231', 'C' => '3124', 'D' => '3214', 'E' => '3223', 'F' => '4114', 'G' => '4123', 'H' => '4213', 'I' => '1342', 'J' => '1432', 'K' => '1441', 'L' => '2332', 'M' => '2341', 'N' => '2431', 'O' => '1324', 'P' => '1414', 'Q' => '1423', 'R' => '2314', 'S' => '2323', 'T' => '2413', 'U' => '1144', 'V' => '1234', 'W' => '1243', 'X' => '2134', 'Y' => '2143', 'Z' => '2233')

$chksum

Characters used for checksum

protected array<string|int, mixed> $chksum = array('0' => '11', '1' => '12', '2' => '13', '3' => '14', '4' => '15', '5' => '10', '6' => '21', '7' => '22', '8' => '23', '9' => '24', 'A' => '25', 'B' => '20', 'C' => '31', 'D' => '32', 'E' => '33', 'F' => '34', 'G' => '35', 'H' => '30', 'I' => '41', 'J' => '42', 'K' => '43', 'L' => '44', 'M' => '45', 'N' => '40', 'O' => '51', 'P' => '52', 'Q' => '53', 'R' => '54', 'S' => '55', 'T' => '50', 'U' => '01', 'V' => '02', 'W' => '03', 'X' => '04', 'Y' => '05', 'Z' => '00')

$code

Code to convert (barcode content)

protected string $code = ''

$color_obj

Foreground Color object

protected Color $color_obj

object

$extcode

Resulting code after applying checksum etc.

protected string $extcode = ''

$height

Barcode height

protected float $height

$height_ratio

Ratio between the barcode height and the number of columns

protected float $height_ratio

$ncols

Total number of columns

protected int $ncols = 0

$nrows

Total number of rows

protected int $nrows = 1

$padding

Additional padding to add around the barcode (top, right, bottom, left) in user units.

protected array<string|int, mixed> $padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)

A negative value indicates the multiplication factor for each row or column.

$params

Array containing extra parameters for the specified barcode type

protected array<string|int, mixed> $params

$type

Barcode type (linear or square)

protected string $type = ''

$width

Barcode width

protected float $width

$width_ratio

Ratio between the barcode width and the number of rows

protected float $width_ratio

Methods

__construct()

Initialize a new barcode object

public __construct(string $code[, int $width = -1 ][, int $height = -1 ][, string $color = 'black' ][, array<string|int, mixed> $params = array() ][, array<string|int, mixed> $padding = array(0, 0, 0, 0) ]) : mixed
Parameters
$code : string

Barcode content

$width : int = -1

Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column.

$height : int = -1

Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row.

$color : string = 'black'

Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax)

$params : array<string|int, mixed> = array()

Array containing extra parameters for the specified barcode type

$padding : array<string|int, mixed> = array(0, 0, 0, 0)

Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns.

Tags
throws
Exception

in case of error

throws
Exception

in case of color error

Return values
mixed —

getArray()

Get the barcode raw array

public getArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBarsArray()

Get the array containing all the formatted bars coordinates

public getBarsArray([string $type = 'XYXY' ]) : array<string|int, mixed>
Parameters
$type : string = 'XYXY'

Type of coordinates to return: 'XYXY' or 'XYWH'

Return values
array<string|int, mixed> —

getExtendedCode()

Get the extended code (code + checksum)

public getExtendedCode() : string
Return values
string —

getGd()

Get the barcode as GD image object (requires GD library)

public getGd() : object
Tags
throws
Exception

if the GD library is not installed

Return values
object —

getGrid()

Get a raw barcode string representation using characters

public getGrid([string $space_char = '0' ][, string $bar_char = '1' ]) : string
Parameters
$space_char : string = '0'

Character or string to use for filling empty spaces

$bar_char : string = '1'

Character or string to use for filling bars

Return values
string —

getGridArray()

Get a raw barcode grid array

public getGridArray([string $space_char = '0' ][, string $bar_char = '1' ]) : array<string|int, mixed>
Parameters
$space_char : string = '0'

Character or string to use for filling empty spaces

$bar_char : string = '1'

Character or string to use for filling bars

Return values
array<string|int, mixed> —

getHtmlDiv()

Get an HTML representation of the barcode.

public getHtmlDiv() : string
Return values
string —

HTML code (DIV block)

getPng()

Get Barcode as PNG Image (requires GD or Imagick library)

public getPng() : mixed
Return values
mixed —

getPngData()

Get the barcode as PNG image (requires GD or Imagick library)

public getPngData([bool $imagick = true ]) : string
Parameters
$imagick : bool = true

If true try to use the Imagick extension

Return values
string —

PNG image data

getPngDataImagick()

Get the barcode as PNG image (requires Imagick library)

public getPngDataImagick() : object
Tags
throws
Exception

if the Imagick library is not installed

Return values
object —

getSvg()

Get the barcode as SVG image object

public getSvg() : mixed
Return values
mixed —

getSvgCode()

Get the barcode as SVG code

public getSvgCode() : string
Return values
string —

SVG code

setBackgroundColor()

Set the background color

public setBackgroundColor(string $color) : mixed
Parameters
$color : string

Background color in Web notation (color name, or hexadecimal code, or CSS syntax)

Tags
throws
Exception

in case of color error

Return values
mixed —

setColor()

Set the color of the bars.

public setColor(string $color) : mixed

If the color is transparent or empty it will be set to the default black color.

Parameters
$color : string

Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax)

Tags
throws
Exception

in case of color error

throws
Exception

in case of empty or transparent color

Return values
mixed —

setSize()

Set the size of the barcode to be exported

public setSize(int $width, int $height[, array<string|int, mixed> $padding = array(0, 0, 0, 0) ]) : mixed
Parameters
$width : int

Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column.

$height : int

Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row.

$padding : array<string|int, mixed> = array(0, 0, 0, 0)

Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns.

Return values
mixed —

convertDecToHex()

Convert large integer number to hexadecimal representation.

protected convertDecToHex(string $number) : string
Parameters
$number : string

Number to convert (as string)

Return values
string —

hexadecimal representation

convertHexToDec()

Convert large hexadecimal number to decimal representation (string).

protected convertHexToDec(string $hex) : string
Parameters
$hex : string

Hexadecimal number to convert (as string)

Return values
string —

hexadecimal representation

formatCode()

Format code

protected formatCode() : mixed
Return values
mixed —

getBarRectXYWH()

Get the adjusted rectangular coordinates (x,y,w,h) for the specified bar

protected getBarRectXYWH(mixed $bar) : array<string|int, mixed>
Parameters
$bar : mixed
Return values
array<string|int, mixed> —

Bar coordinates

getBarRectXYXY()

Get the adjusted rectangular coordinates (x1,y1,x2,y2) for the specified bar

protected getBarRectXYXY(mixed $bar) : array<string|int, mixed>
Parameters
$bar : mixed
Return values
array<string|int, mixed> —

Bar coordinates

getChecksum()

Calculate the checksum.

protected getChecksum( $code) : char
Parameters
$code :

(string) code to represent.

Tags
throws
Exception

in case of error

Return values
char —

checksum.

getCoreBars()

Get the central bars

protected getCoreBars() : mixed
Tags
throws
Exception

in case of error

Return values
mixed —

getRgbColorObject()

Get the RGB Color object for the given color representation

protected getRgbColorObject(string $color) : Color
Parameters
$color : string

Color in Web notation (color name, or hexadecimal code, or CSS syntax)

Tags
throws
Exception

in case of color error

Return values
Color —

object or null

getRotatedBarArray()

Returns the bars array ordered by columns

protected getRotatedBarArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

processBinarySequence()

Import a binary sequence of comma-separated 01 strings

protected processBinarySequence(string $code) : mixed
Parameters
$code : string

Code to process

Return values
mixed —

setPadding()

Set the barcode padding

protected setPadding(array<string|int, mixed> $padding) : mixed
Parameters
$padding : array<string|int, mixed>

Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns.

Tags
throws
Exception

in case of error

Return values
mixed —

setParameters()

Set extra (optional) parameters

protected setParameters() : mixed
Return values
mixed —
​
 
​
© 2004-2023 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy