Validate/Barcode.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_Barcode

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

Constants

>VConstant  INVALID = 'barcodeInvalid'
>VConstant  FAILED = 'barcodeFailed'
>VConstant  INVALID_CHARS = 'barcodeInvalidChars'
>VConstant  INVALID_LENGTH = 'barcodeInvalidLength'

Properties

>VPropertyprotected\Zend_Validate_Barcode_BarcodeAdapter $_adapter
Barcode adapter
>VPropertyprotectedinteger $_length
Length for the set subtype
Details
Type
integer
>VPropertyprotected$_messageTemplates = array(self::FAILED => "'%value%' failed checksum validation", self::INVALID_CHARS => "'%value%' contains invalid characters", self::INVALID_LENGTH => "'%value%' should have a length of %length% characters", self::INVALID => "Invalid type given. String expected")
Default valuearray(self::FAILED => "'%value%' failed checksum validation", self::INVALID_CHARS => "'%value%' contains invalid characters", self::INVALID_LENGTH => "'%value%' should have a length of %length% characters", self::INVALID => "Invalid type given. String expected")Details
Type
n/a
>VPropertyprotectedarray $_messageVariables = array('length' => '_length')
Additional variables available for validation failure messages
Default valuearray('length' => '_length')Details
Type
array

Methods

methodpublic__construct( $adapter) : void

Generates the standard validator object

Parameters
NameTypeDescription
$adapter
Throws
ExceptionDescription
\Zend_Validate_Exception
methodpublicgetAdapter() : \Zend_Validate_Barcode_BarcodeAdapter

Returns the set adapter

methodpublicgetChecksum() : boolean

Returns the checksum option

Returns
TypeDescription
boolean
methodpublicisValid(string $value) : boolean

Defined by Zend_Validate_Interface

Returns true if and only if $value contains a valid barcode
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
boolean
methodpublicsetAdapter(string | \Zend_Validate_Barcode $adapter, array $options = null) : void

Sets a new barcode adapter

Parameters
NameTypeDescription
$adapterstring | \Zend_Validate_Barcode

Barcode adapter to use

$optionsarray

Options for this adapter

Throws
ExceptionDescription
\Zend_Validate_Exception
methodpublicsetChecksum(boolean $checksum) : \Zend_Validate_Barcode

Sets the checksum option

Parameters
NameTypeDescription
$checksumboolean
Returns
TypeDescription
\Zend_Validate_Barcode
Documentation was generated by phpDocumentor 2.2.0 .