Zend_Validate_Barcode_Royalmail Class Reference

Inheritance diagram for Zend_Validate_Barcode_Royalmail:

Public Member Functions
	checkChars ($value)
Public Member Functions inherited from Zend_Validate_Barcode_AdapterAbstract
	checkLength ($value)
	checkChars ($value)
	checksum ($value)
	getLength ()
	getCharacters ()
	getChecksum ()
	getCheck ()
	setCheck ($check)

Protected Member Functions
	_royalmail ($value)
Protected Member Functions inherited from Zend_Validate_Barcode_AdapterAbstract
	_gtin ($value)
	_identcode ($value)
	_code25 ($value)
	_postnet ($value)

Protected Attributes
	$_length = -1
	$_characters = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
	$_rows
	$_columns
	$_checksum = '_royalmail'
Protected Attributes inherited from Zend_Validate_Barcode_AdapterAbstract
	$_length
	$_characters
	$_checksum
	$_hasChecksum = true

Detailed Description

Definition at line 33 of file Royalmail.php.

Member Function Documentation

_royalmail()

_royalmail (   $value )

protected

Validates the checksum ()

Parameters

string

$value

The barcode to validate

Returns

boolean

Definition at line 77 of file Royalmail.php.

    {
        $checksum = substr($value, -1, 1);
        $values   = str_split(substr($value, 0, -1));
        $rowvalue = 0;
        $colvalue = 0;
        foreach($values as $row) {
            $rowvalue += $this->_rows[$row];
            $colvalue += $this->_columns[$row];
        }

        $rowvalue %= 6;
        $colvalue %= 6;

        $rowchkvalue = array_keys($this->_rows, $rowvalue);
        $colchkvalue = array_keys($this->_columns, $colvalue);
        $chkvalue    = current(array_intersect($rowchkvalue, $colchkvalue));
        if ($chkvalue == $checksum) {
            return true;
        }

        return false;
    }

checkChars()

checkChars

(

$value

)

Allows start and stop tag within checked chars

Parameters

string

$value

The barcode to check for allowed characters

Returns

boolean

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 107 of file Royalmail.php.

    {
        if ($value[0] == '(') {
            $value = substr($value, 1);

            if ($value[strlen($value) - 1] == ')') {
                $value = substr($value, 0, -1);
            } else {
                return false;
            }
        }

        return parent::checkChars($value);
    }

Field Documentation

$_characters

$_characters = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'

protected

Definition at line 45 of file Royalmail.php.

$_checksum

$_checksum = '_royalmail'

protected

Definition at line 69 of file Royalmail.php.

$_columns

$_columns

protected

Initial value:

= array(
        '0' => 1, '1' => 2, '2' => 3, '3' => 4, '4' => 5, '5' => 0,
        '6' => 1, '7' => 2, '8' => 3, '9' => 4, 'A' => 5, 'B' => 0,
        'C' => 1, 'D' => 2, 'E' => 3, 'F' => 4, 'G' => 5, 'H' => 0,
        'I' => 1, 'J' => 2, 'K' => 3, 'L' => 4, 'M' => 5, 'N' => 0,
        'O' => 1, 'P' => 2, 'Q' => 3, 'R' => 4, 'S' => 5, 'T' => 0,
        'U' => 1, 'V' => 2, 'W' => 3, 'X' => 4, 'Y' => 5, 'Z' => 0,
    )

Definition at line 56 of file Royalmail.php.

$_length

$_length = -1

protected

Definition at line 39 of file Royalmail.php.

$_rows

$_rows

protected

Initial value:

= array(
        '0' => 1, '1' => 1, '2' => 1, '3' => 1, '4' => 1, '5' => 1,
        '6' => 2, '7' => 2, '8' => 2, '9' => 2, 'A' => 2, 'B' => 2,
        'C' => 3, 'D' => 3, 'E' => 3, 'F' => 3, 'G' => 3, 'H' => 3,
        'I' => 4, 'J' => 4, 'K' => 4, 'L' => 4, 'M' => 4, 'N' => 4,
        'O' => 5, 'P' => 5, 'Q' => 5, 'R' => 5, 'S' => 5, 'T' => 5,
        'U' => 0, 'V' => 0, 'W' => 0, 'X' => 0, 'Y' => 0, 'Z' => 0,
     )

Definition at line 47 of file Royalmail.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/Barcode/Royalmail.php