API Documentation

Validate/Barcode/AdapterAbstract.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  
version
$Id: AdapterAbstract.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Validate_Barcode_AdapterAbstract

Implements
\Zend_Validate_Barcode_AdapterInterface
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  

Properties

Propertyprotectedstring  $_characters= ''

Allowed barcode characters

Details
Type
string
Propertyprotectedstring|array  $_checksum= ''

Callback to checksum function

Details
Type
stringarray
Propertyprotectedboolean  $_hasChecksum= 'true'

Is a checksum value included?

Default valuetrueDetails
Type
boolean
Propertyprotectedinteger|array|string  $_length= ''

Allowed barcode lengths

Details
Type
integerarraystring

Methods

methodprotected_code25( string $value ) : boolean

Validates the checksum (Modulo 10) CODE25 implementation factor 3

Parameters
Name Type Description
$value string The barcode to validate
Returns
Type Description
boolean
methodprotected_gtin( string $value ) : boolean

Validates the checksum (Modulo 10) GTIN implementation factor 3

Parameters
Name Type Description
$value string The barcode to validate
Returns
Type Description
boolean
methodprotected_identcode( string $value ) : boolean

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

Parameters
Name Type Description
$value string The barcode to validate
Returns
Type Description
boolean
methodprotected_postnet( string $value ) : boolean

Validates the checksum () POSTNET implementation

Parameters
Name Type Description
$value string The barcode to validate
Returns
Type Description
boolean
methodpubliccheckChars( string $value ) : boolean

Checks for allowed characters within the barcode

Parameters
Name Type Description
$value string The barcode to check for allowed characters
Returns
Type Description
boolean
methodpubliccheckLength( string $value ) : boolean

Checks the length of a barcode

Parameters
Name Type Description
$value string The barcode to check for proper length
Returns
Type Description
boolean
methodpublicchecksum( string $value ) : boolean

Validates the checksum

Parameters
Name Type Description
$value string The barcode to check the checksum for
Returns
Type Description
boolean
methodpublicgetCharacters( ) : integer|string

Returns the allowed characters

Returns
Type Description
integerstring
methodpublicgetCheck( ) : boolean

Returns if barcode uses checksum

Returns
Type Description
boolean
methodpublicgetChecksum( ) : void

Returns the checksum function name

methodpublicgetLength( ) : string

Returns the allowed barcode length

Returns
Type Description
string
methodpublicsetCheck( boolean $check ) : \Zend_Validate_Barcode_AdapterAbstract

Sets the checksum validation

Parameters
Name Type Description
$check boolean
Returns
Type Description
\Zend_Validate_Barcode_AdapterAbstract
Documentation was generated by DocBlox 0.13.3.