API Documentation

Zend/Validate/Barcode.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id: Barcode.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Validate_Barcode

Package: Zend\Validate

Parent(s)
\Zend_Validate_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  INVALID = 'barcodeInvalid'
Constant  FAILED = 'barcodeFailed'
Constant  INVALID_CHARS = 'barcodeInvalidChars'
Constant  INVALID_LENGTH = 'barcodeInvalidLength'

Properties

Propertyprotected\Zend_Validate_Barcode_BarcodeAdapter  $_adapter= ''

Barcode adapter

Details
Type
\Zend_Validate_Barcode_BarcodeAdapter
Propertyprotectedinteger  $_length= ''

Length for the set subtype

Details
Type
integer
Propertyprotected  $_messageTemplates= 'array( self::FAILED => "'%value%' failed checksum validation"'
Default valuearray( self::FAILED => "'%value%' failed checksum validation"Details
Type
Propertyprotectedarray  $_messageVariables= 'array( 'length' => '_length' )'

Additional variables available for validation failure messages

Default valuearray( 'length' => '_length' )Details
Type
array

Methods

methodpublic__construct( string|\Zend_Config $adapter ) : void

Generates the standard validator object

Parameters
Name Type Description
$adapter string|\Zend_Config

Zend_Validate_Barcode_BarcodeAdapter $adapter Barcode adapter to use

Throws
Exception Description
\Zend_Validate_Exception
methodpublicgetAdapter( ) : \Zend_Validate_Barcode_BarcodeAdapter

Returns the set adapter

Returns
Type Description
\Zend_Validate_Barcode_BarcodeAdapter
methodpublicgetChecksum( ) : boolean

Returns the checksum option

Returns
Type Description
boolean
methodpublicisValid( string $value ) : boolean

Defined by Zend_Validate_Interface

Returns true if and only if $value contains a valid barcode

Parameters
Name Type Description
$value string
Returns
Type Description
boolean
methodpublicsetAdapter( string|\Zend_Validate_Barcode $adapter, array $options = null ) : void

Sets a new barcode adapter

Parameters
Name Type Description
$adapter string|\Zend_Validate_Barcode

Barcode adapter to use

$options array

Options for this adapter

Throws
Exception Description
\Zend_Validate_Exception
methodpublicsetChecksum( boolean $checksum ) : \Zend_Validate_Barcode

Sets the checksum option

Parameters
Name Type Description
$checksum boolean
Returns
Type Description
\Zend_Validate_Barcode
Documentation was generated by DocBlox 0.15.1.