Zend_Validate_Barcode_EAN13 - Andries Seutens

Zend Framework: Zend_Validate_Barcode_EAN13 Component Proposal

Proposed Component Name	Zend_Validate_Barcode_EAN13
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Validate_Barcode_EAN13
Proposers	Andries Seutens Darby Felton, Zend liaison
Revision	1.0 - Initial draft: 3 july 2007 (wiki revision: 12)

<?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
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id$
 */


/**
 * @see Zend_Validate_Abstract
 */
require_once 'Zend/Validate/Abstract.php';


/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate_Barcode_EAN13 extends Zend_Validate_Abstract
{
    /**
     * Validation failure message key for when the value is
     * an invalid barcode
     */
    const INVALID = 'stringInvalid';

    /**
     * Validation failure message key for when the value is
     * not 13 characters long
     */
    const INVALID_LENGTH = 'stringLength';

    /**
     * Validation failure message key for when the value is
     * an empty string
     */
    const STRING_EMPTY = 'stringEmpty';

    /**
     * Validation failure message template definitions
     *
     * @var array
     */
    protected $_messageTemplates = array(
        self::INVALID        => "'%value%' is an invalid EAN13 barcode",
        self::INVALID_LENGTH => "'%value%' should be 13 characters",
        self::STRING_EMPTY   => "'%value%' is an empty string"
    );

    /**
     * Defined by Zend_Validate_Interface
     *
     * Returns true if and only if $value contains a valid barcode
     *
     * @param  string $value
     * @return boolean
     */
    public function isValid($value)
    {
        $valueString = (string) $value;
        $this->_setValue($valueString);

        if ('' === $valueString) {
            $this->_error(self::STRING_EMPTY);
            return false;
        }

        if (strlen($valueString) !== 13) {
            $this->_error(self::INVALID_LENGTH);
            return false;
        }

        $barcode = strrev(substr($valueString, 0, -1));
        $oddSum  = 0;
        $evenSum = 0;

        for ($i = 0; $i < 12; $i++) {
            if ($i % 2 === 0) {
                $oddSum += $barcode[$i] * 3;
            } elseif ($i % 2 === 1) {
                $evenSum += $barcode[$i];
            }
        }

        $calculation = ($oddSum + $evenSum) % 10;
        $checksum    = ($calculation === 0) ? 0 : 10-$calculation;

        if ($valueString[12] != $checksum) {
            $this->_error(self::INVALID);
            return false;
        }

        return true;
    }
}

Page Operations

Browse Space

Zend_Validate_Barcode_EAN13 - Andries Seutens

Labels

Zend Framework: Zend_Validate_Barcode_EAN13 Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons