Zend_Validate_Barcode Class Reference

Inheritance diagram for Zend_Validate_Barcode:

Public Member Functions
	__construct ($adapter)
	getAdapter ()
	setAdapter ($adapter, $options=null)
	getChecksum ()
	setChecksum ($checksum)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
const	INVALID = 'barcodeInvalid'
const	FAILED = 'barcodeFailed'
const	INVALID_CHARS = 'barcodeInvalidChars'
const	INVALID_LENGTH = 'barcodeInvalidLength'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_length
	$_adapter
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 38 of file Barcode.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$adapter

)

Generates the standard validator object

Parameters

string|Zend_Config|

Zend_Validate_Barcode_BarcodeAdapter $adapter Barcode adapter to use

Exceptions

Zend_Validate_Exception

Definition at line 82 of file Barcode.php.

    {
        if ($adapter instanceof Zend_Config) {
            $adapter = $adapter->toArray();
        }

        $options  = null;
        $checksum = null;
        if (is_array($adapter)) {
            if (array_key_exists('options', $adapter)) {
                $options = $adapter['options'];
            }

            if (array_key_exists('checksum', $adapter)) {
                $checksum = $adapter['checksum'];
            }

            if (array_key_exists('adapter', $adapter)) {
                $adapter = $adapter['adapter'];
            } else {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("Missing option 'adapter'");
            }
        }

        $this->setAdapter($adapter, $options);
        if ($checksum !== null) {
            $this->setChecksum($checksum);
        }
    }

Member Function Documentation

getAdapter()

getAdapter

(

)

Returns the set adapter

Returns

Zend_Validate_Barcode_BarcodeAdapter

Definition at line 118 of file Barcode.php.

    {
        return $this->_adapter;
    }

getChecksum()

getChecksum

(

)

Returns the checksum option

Returns

boolean

Definition at line 159 of file Barcode.php.

    {
        return $this->getAdapter()->getCheck();
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

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

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 184 of file Barcode.php.

    {
        if (!is_string($value)) {
            $this->_error(self::INVALID);
            return false;
        }

        $this->_setValue($value);
        $adapter       = $this->getAdapter();
        $this->_length = $adapter->getLength();
        $result        = $adapter->checkLength($value);
        if (!$result) {
            if (is_array($this->_length)) {
                $temp = $this->_length;
                $this->_length = "";
                foreach($temp as $length) {
                    $this->_length .= "/";
                    $this->_length .= $length;
                }

                $this->_length = substr($this->_length, 1);
            }

            $this->_error(self::INVALID_LENGTH);
            return false;
        }

        $result = $adapter->checkChars($value);
        if (!$result) {
            $this->_error(self::INVALID_CHARS);
            return false;
        }

        if ($this->getChecksum()) {
            $result = $adapter->checksum($value);
            if (!$result) {
                $this->_error(self::FAILED);
                return false;
            }
        }

        return true;
    }

setAdapter()

setAdapter	(		$adapter,
			$options = null
	)

Sets a new barcode adapter

Parameters

string | Zend_Validate_Barcode	$adapter	Barcode adapter to use
array	$options	Options for this adapter

Returns

$this

Exceptions

Zend_Validate_Exception

Definition at line 131 of file Barcode.php.

    {
        $adapter = ucfirst(strtolower($adapter));
        #require_once 'Zend/Loader.php';
        if (Zend_Loader::isReadable('Zend/Validate/Barcode/' . $adapter. '.php')) {
            $adapter = 'Zend_Validate_Barcode_' . $adapter;
        }

        if (!class_exists($adapter)) {
            Zend_Loader::loadClass($adapter);
        }

        $this->_adapter = new $adapter($options);
        if (!$this->_adapter instanceof Zend_Validate_Barcode_AdapterInterface) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception(
                "Adapter " . $adapter . " does not implement Zend_Validate_Barcode_AdapterInterface"
            );
        }

        return $this;
    }

setChecksum()

setChecksum

(

$checksum

)

Sets the checksum option

Parameters

boolean

$checksum

Returns

Zend_Validate_Barcode

Definition at line 170 of file Barcode.php.

    {
        $this->getAdapter()->setCheck($checksum);
        return $this;
    }

Field Documentation

$_adapter

$_adapter

protected

Definition at line 73 of file Barcode.php.

$_length

$_length

protected

Definition at line 66 of file Barcode.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= 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",
    )

Definition at line 45 of file Barcode.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'length' => '_length'
    )

Definition at line 57 of file Barcode.php.

FAILED

const FAILED = 'barcodeFailed'

Definition at line 41 of file Barcode.php.

INVALID

const INVALID = 'barcodeInvalid'

Definition at line 40 of file Barcode.php.

INVALID_CHARS

const INVALID_CHARS = 'barcodeInvalidChars'

Definition at line 42 of file Barcode.php.

INVALID_LENGTH

const INVALID_LENGTH = 'barcodeInvalidLength'

Definition at line 43 of file Barcode.php.

---

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

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