Zend_Validate_Barcode_AdapterAbstract Class Reference

Inheritance diagram for Zend_Validate_Barcode_AdapterAbstract:

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

Protected Member Functions
	_gtin ($value)
	_identcode ($value)
	_code25 ($value)
	_postnet ($value)

Protected Attributes
	$_length
	$_characters
	$_checksum
	$_hasChecksum = true

Detailed Description

Definition at line 33 of file AdapterAbstract.php.

Member Function Documentation

_code25()

_code25 (   $value )

protected

Validates the checksum (Modulo 10) CODE25 implementation factor 3

Parameters

string

$value

The barcode to validate

Returns

boolean

Definition at line 267 of file AdapterAbstract.php.

    {
        $barcode = substr($value, 0, -1);
        $sum     = 0;
        $length  = strlen($barcode) - 1;

        for ($i = 0; $i <= $length; $i++) {
            if (($i % 2) === 0) {
                $sum += $barcode[$i] * 3;
            } else {
                $sum += $barcode[$i];
            }
        }

        $calc     = $sum % 10;
        $checksum = ($calc === 0) ? 0 : (10 - $calc);
        if ($value[$length + 1] != $checksum) {
            return false;
        }

        return true;
    }

_gtin()

_gtin (   $value )

protected

Validates the checksum (Modulo 10) GTIN implementation factor 3

Parameters

string

$value

The barcode to validate

Returns

boolean

Definition at line 207 of file AdapterAbstract.php.

    {
        $barcode = substr($value, 0, -1);
        $sum     = 0;
        $length  = strlen($barcode) - 1;

        for ($i = 0; $i <= $length; $i++) {
            if (($i % 2) === 0) {
                $sum += $barcode[$length - $i] * 3;
            } else {
                $sum += $barcode[$length - $i];
            }
        }

        $calc     = $sum % 10;
        $checksum = ($calc === 0) ? 0 : (10 - $calc);
        if ($value[$length + 1] != $checksum) {
            return false;
        }

        return true;
    }

_identcode()

_identcode (   $value )

protected

Validates the checksum (Modulo 10) IDENTCODE implementation factors 9 and 4

Parameters

string

$value

The barcode to validate

Returns

boolean

Definition at line 237 of file AdapterAbstract.php.

    {
        $barcode = substr($value, 0, -1);
        $sum     = 0;
        $length  = strlen($value) - 2;

        for ($i = 0; $i <= $length; $i++) {
            if (($i % 2) === 0) {
                $sum += $barcode[$length - $i] * 4;
            } else {
                $sum += $barcode[$length - $i] * 9;
            }
        }

        $calc     = $sum % 10;
        $checksum = ($calc === 0) ? 0 : (10 - $calc);
        if ($value[$length + 1] != $checksum) {
            return false;
        }

        return true;
    }

_postnet()

_postnet (   $value )

protected

Validates the checksum () POSTNET implementation

Parameters

string

$value

The barcode to validate

Returns

boolean

Definition at line 297 of file AdapterAbstract.php.

    {
        $checksum = substr($value, -1, 1);
        $values   = str_split(substr($value, 0, -1));

        $check = 0;
        foreach($values as $row) {
            $check += $row;
        }

        $check %= 10;
        $check = 10 - $check;
        if ($check == $checksum) {
            return true;
        }

        return false;
    }

checkChars()

checkChars

(

$value

)

Checks for allowed characters within the barcode

Parameters

string

$value

The barcode to check for allowed characters

Returns

boolean

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 106 of file AdapterAbstract.php.

    {
        if (!is_string($value)) {
            return false;
        }

        $characters = $this->getCharacters();
        if ($characters == 128) {
            for ($x = 0; $x < 128; ++$x) {
                $value = str_replace(chr($x), '', $value);
            }
        } else {
            $chars = str_split($characters);
            foreach ($chars as $char) {
                $value = str_replace($char, '', $value);
            }
        }

        if (strlen($value) > 0) {
            return false;
        }

        return true;
    }

checkLength()

checkLength

(

$value

)

Checks the length of a barcode

Parameters

string

$value

The barcode to check for proper length

Returns

boolean

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 66 of file AdapterAbstract.php.

    {
        if (!is_string($value)) {
            return false;
        }

        $fixum  = strlen($value);
        $found  = false;
        $length = $this->getLength();
        if (is_array($length)) {
            foreach ($length as $value) {
                if ($fixum == $value) {
                    $found = true;
                }

                if ($value == -1) {
                    $found = true;
                }
            }
        } elseif ($fixum == $length) {
            $found = true;
        } elseif ($length == -1) {
            $found = true;
        } elseif ($length == 'even') {
            $count = $fixum % 2;
            $found = ($count == 0) ? true : false;
        } elseif ($length == 'odd') {
            $count = $fixum % 2;
            $found = ($count == 1) ? true : false;
        }

        return $found;
    }

checksum()

checksum

(

$value

)

Validates the checksum

Parameters

string

$value

The barcode to check the checksum for

Returns

boolean

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 137 of file AdapterAbstract.php.

    {
        $checksum = $this->getChecksum();
        if (!empty($checksum)) {
            if (method_exists($this, $checksum)) {
                return call_user_func(array($this, $checksum), $value);
            }
        }

        return false;
    }

getCharacters()

getCharacters

(

)

Returns the allowed characters

Returns

integer|string

Definition at line 164 of file AdapterAbstract.php.

    {
        return $this->_characters;
    }

getCheck()

getCheck

(

)

Returns if barcode uses checksum

Returns

boolean

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 183 of file AdapterAbstract.php.

    {
        return $this->_hasChecksum;
    }

getChecksum()

getChecksum

(

)

Returns the checksum function name

Definition at line 173 of file AdapterAbstract.php.

    {
        return $this->_checksum;
    }

getLength()

getLength

(

)

Returns the allowed barcode length

Returns

string

Definition at line 154 of file AdapterAbstract.php.

    {
        return $this->_length;
    }

setCheck()

setCheck

(

$check

)

Sets the checksum validation

Parameters

boolean

$check

Returns

Zend_Validate_Barcode_AdapterAbstract

Implements Zend_Validate_Barcode_AdapterInterface.

Definition at line 194 of file AdapterAbstract.php.

    {
        $this->_hasChecksum = (boolean) $check;
        return $this;
    }

Field Documentation

$_characters

$_characters

protected

Definition at line 46 of file AdapterAbstract.php.

$_checksum

$_checksum

protected

Definition at line 52 of file AdapterAbstract.php.

$_hasChecksum

$_hasChecksum = true

protected

Definition at line 58 of file AdapterAbstract.php.

$_length

$_length

protected

Definition at line 40 of file AdapterAbstract.php.

---

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

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