<?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_Barcode

 * @subpackage Object

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: ObjectAbstract.php 23400 2010-11-19 17:18:31Z mikaelkael $

 */

/**

 * Class for generate Barcode

 *

 * @category   Zend

 * @package    Zend_Barcode

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

abstract class Zend_Barcode_Object_ObjectAbstract

{

    /**

     * Namespace of the barcode for autoloading

     * @var string

     */

    protected $_barcodeNamespace = 'Zend_Barcode_Object';

    /**

     * Set of drawing instructions

     * @var array

     */

    protected $_instructions = array();

    /**

     * Barcode type

     * @var string

     */

    protected $_type = null;

    /**

     * Height of the object

     * @var integer

     */

    protected $_height = null;

    /**

     * Width of the object

     * @var integer

     */

    protected $_width = null;

    /**

     * Height of the bar

     * @var integer

     */

    protected $_barHeight = 50;

    /**

     * Width of a thin bar

     * @var integer

     */

    protected $_barThinWidth = 1;

    /**

     * Width of a thick bar

     * @var integer

     */

    protected $_barThickWidth = 3;

    /**

     * Factor to multiply bar and font measure

     * (barHeight, barThinWidth, barThickWidth & fontSize)

     * @var integer

     */

    protected $_factor = 1;

    /**

     * Font and bars color of the object

     * @var integer

     */

    protected $_foreColor = 0x000000;

    /**

     * Background color of the object

     * @var integer

     */

    protected $_backgroundColor = 0xFFFFFF;

    /**

     * Activate/deactivate border of the object

     * @var boolean

     */

    protected $_withBorder = false;

    /**

     * Activate/deactivate drawing of quiet zones

     * @var boolean

     */

    protected $_withQuietZones = true;

    /**

     * Force quiet zones even if

     * @var boolean

     */

    protected $_mandatoryQuietZones = false;

    /**

     * Orientation of the barcode in degrees

     * @var float

     */

    protected $_orientation = 0;

    /**

     * Offset from the top the object

     * (calculated from the orientation)

     * @var integer

     */

    protected $_offsetTop = null;

    /**

     * Offset from the left the object

     * (calculated from the orientation)

     * @var integer

     */

    protected $_offsetLeft = null;

    /**

     * Text to display

     * @var string

     */

    protected $_text = null;

    /**

     * Display (or not) human readable text

     * @var boolean

     */

    protected $_drawText = true;

    /**

     * Adjust (or not) position of human readable characters with barcode

     * @var boolean

     */

    protected $_stretchText = false;

    /**

     * Font resource

     *  - integer (1 to 5): corresponds to GD included fonts

     *  - string: corresponds to path of a TTF font

     * @var integer|string

     */

    protected $_font = null;

    /**

     * Font size

     * @var float

     */

    protected $_fontSize = 10;

    /**

     * Drawing of checksum

     * @var boolean

     */

    protected $_withChecksum = false;

    /**

     * Drawing of checksum inside text

     * @var boolean

     */

    protected $_withChecksumInText = false;

    /**

     * Fix barcode length (numeric or string like 'even')

     * @var $_barcodeLength integer | string

     */

    protected $_barcodeLength = null;

    /**

     * Activate automatic addition of leading zeros

     * if barcode length is fixed

     * @var $_addLeadingZeros boolean

     */

    protected $_addLeadingZeros = true;

    /**

     * Activation of mandatory checksum

     * to deactivate unauthorized modification

     * @var $_mandatoryChecksum boolean

     */

    protected $_mandatoryChecksum = false;

    /**

     * Character used to substitute checksum character for validation

     * @var $_substituteChecksumCharacter mixed

     */

    protected $_substituteChecksumCharacter = 0;

    /**

     * TTF font name: can be set before instanciation of the object

     * @var string

     */

    protected static $_staticFont = null;

    /**

     * Constructor

     * @param array|Zend_Config $options

     * @return void

     */

    public function __construct($options = null)

    {

        $this->_getDefaultOptions();

        if (self::$_staticFont !== null) {

            $this->_font = self::$_staticFont;

        }

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

        if (is_array($options)) {

            $this->setOptions($options);

        }

        $this->_type = strtolower(substr(get_class($this), strlen($this->_barcodeNamespace) + 1));

        if ($this->_mandatoryChecksum) {

            $this->_withChecksum = true;

            $this->_withChecksumInText = true;

        }

    }

    /**

     * Set default options for particular object

     * @return void

     */

    protected function _getDefaultOptions()

    {

    }

    /**

     * Set barcode state from options array

     * @param  array $options

     * @return Zend_Barcode_Object

     */

    public function setOptions($options)

    {

        foreach ($options as $key => $value) {

            $method = 'set' . $key;

            if (method_exists($this, $method)) {

                $this->$method($value);

            }

        }

        return $this;

    }

    /**

     * Set barcode state from config object

     * @param Zend_Config $config

     * @return Zend_Barcode_Object

     */

    public function setConfig(Zend_Config $config)

    {

        return $this->setOptions($config->toArray());

    }

    /**

     * Set barcode namespace for autoloading

     *

     * @param string $namespace

     * @return Zend_Barcode_Object

     */

    public function setBarcodeNamespace($namespace)

    {

        $this->_barcodeNamespace = $namespace;

        return $this;

    }

    /**

     * Retrieve barcode namespace

     *

     * @return string

     */

    public function getBarcodeNamespace()

    {

        return $this->_barcodeNamespace;

    }

    /**

     * Retrieve type of barcode

     * @return string

     */

    public function getType()

    {

        return $this->_type;

    }

    /**

     * Set height of the barcode bar

     * @param integer $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setBarHeight($value)

    {

        if (intval($value) <= 0) {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Bar height must be greater than 0'

            );

        }

        $this->_barHeight = intval($value);

        return $this;

    }

    /**

     * Get height of the barcode bar

     * @return integer

     */

    public function getBarHeight()

    {

        return $this->_barHeight;

    }

    /**

     * Set thickness of thin bar

     * @param integer $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setBarThinWidth($value)

    {

        if (intval($value) <= 0) {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Bar width must be greater than 0'

            );

        }

        $this->_barThinWidth = intval($value);

        return $this;

    }

    /**

     * Get thickness of thin bar

     * @return integer

     */

    public function getBarThinWidth()

    {

        return $this->_barThinWidth;

    }

    /**

     * Set thickness of thick bar

     * @param integer $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setBarThickWidth($value)

    {

        if (intval($value) <= 0) {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Bar width must be greater than 0'

            );

        }

        $this->_barThickWidth = intval($value);

        return $this;

    }

    /**

     * Get thickness of thick bar

     * @return integer

     */

    public function getBarThickWidth()

    {

        return $this->_barThickWidth;

    }

    /**

     * Set factor applying to

     * thinBarWidth - thickBarWidth - barHeight - fontSize

     * @param float $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setFactor($value)

    {

        if (floatval($value) <= 0) {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Factor must be greater than 0'

            );

        }

        $this->_factor = floatval($value);

        return $this;

    }

    /**

     * Get factor applying to

     * thinBarWidth - thickBarWidth - barHeight - fontSize

     * @return integer

     */

    public function getFactor()

    {

        return $this->_factor;

    }

    /**

     * Set color of the barcode and text

     * @param string $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setForeColor($value)

    {

        if (preg_match('`\#[0-9A-F]{6}`', $value)) {

            $this->_foreColor = hexdec($value);

        } elseif (is_numeric($value) && $value >= 0 && $value <= 16777125) {

            $this->_foreColor = intval($value);

        } else {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Text color must be set as #[0-9A-F]{6}'

            );

        }

        return $this;

    }

    /**

     * Retrieve color of the barcode and text

     * @return unknown

     */

    public function getForeColor()

    {

        return $this->_foreColor;

    }

    /**

     * Set the color of the background

     * @param integer $value

     * @return Zend_Barcode_Object

     * @throw Zend_Barcode_Object_Exception

     */

    public function setBackgroundColor($value)

    {

        if (preg_match('`\#[0-9A-F]{6}`', $value)) {

            $this->_backgroundColor = hexdec($value);

        } elseif (is_numeric($value) && $value >= 0 && $value <= 16777125) {

            $this->_backgroundColor = intval($value);

        } else {

            require_once 'Zend/Barcode/Object/Exception.php';

            throw new Zend_Barcode_Object_Exception(

                'Background color must be set as #[0-9A-F]{6}'

            );

        }

        return $this;

    }

    /**

     * Retrieve background color of the image