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

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

 * @version    $Id: Style.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

require_once 'Zend/Pdf/Canvas/Interface.php';

/** Internally used classes */

require_once 'Zend/Pdf/Element.php';

require_once 'Zend/Pdf/Element/Array.php';

require_once 'Zend/Pdf/Element/String/Binary.php';

require_once 'Zend/Pdf/Element/Boolean.php';

require_once 'Zend/Pdf/Element/Dictionary.php';

require_once 'Zend/Pdf/Element/Name.php';

require_once 'Zend/Pdf/Element/Null.php';

require_once 'Zend/Pdf/Element/Numeric.php';

require_once 'Zend/Pdf/Element/String.php';

require_once 'Zend/Pdf/Resource/GraphicsState.php';

require_once 'Zend/Pdf/Resource/Font.php';

require_once 'Zend/Pdf/Resource/Image.php';

/**

 * Canvas is an abstract rectangle drawing area which can be dropped into

 * page object at specified place.

 *

 * @package    Zend_Pdf

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

 */

abstract class Zend_Pdf_Canvas_Abstract implements Zend_Pdf_Canvas_Interface

{

    /**

     * Drawing instructions

     *

     * @var string

     */

    protected $_contents = '';

    /**

     * Current font

     *

     * @var Zend_Pdf_Resource_Font

     */

    protected $_font = null;

    /**

     * Current font size

     *

     * @var float

     */

    protected $_fontSize;

    /**

     * Current style

     *

     * @var Zend_Pdf_Style

     */

    protected $_style = null;

    /**

     * Counter for the "Save" operations

     *

     * @var integer

     */

    protected $_saveCount = 0;

    /**

     * Add procedureSet to the Page description

     *

     * @param string $procSetName

     */

    abstract protected function _addProcSet($procSetName);

    /**

     * Attach resource to the canvas

     *

     * Method returns a name of the resource which can be used

     * as a resource reference within drawing instructions stream

     * Allowed types: 'ExtGState', 'ColorSpace', 'Pattern', 'Shading',

     * 'XObject', 'Font', 'Properties'

     *

     * @param string $type

     * @param Zend_Pdf_Resource $resource

     * @return string

     */

    abstract protected function _attachResource($type, Zend_Pdf_Resource $resource);

    /**

     * Draw a canvas at the specified location

     *

     * If upper right corner is not specified then canvas heght and width

     * are used.

     *

     * @param Zend_Pdf_Canvas_Interface $canvas

     * @param float $x1

     * @param float $y1

     * @param float $x2

     * @param float $y2

     * @return Zend_Pdf_Canvas_Interface

     */

    public function drawCanvas(Zend_Pdf_Canvas_Interface $canvas, $x1, $y1, $x2 = null, $y2 = null)

    {

        $this->saveGS();

        $this->translate($x1, $y1);

        if ($x2 === null) {

            $with = $canvas->getWidth();

        } else {

            $with = $x2 - $x1;

        }

        if ($y2 === null) {

            $height = $canvas->getHeight();

        } else {

            $height = $y2 - $y1;

        }

        $this->clipRectangle(0, 0, $with, $height);

        if ($x2 !== null  ||  $y2 !== null) {

            // Drawn canvas has to be scaled.

            if ($x2 !== null) {

                $xScale = $with/$canvas->getWidth();

            } else {

                $xScale = 1;

            }

            if ($y2 !== null) {

                $yScale = $height/$canvas->getHeight();

            } else {

                $yScale = 1;

            }

            $this->scale($xScale, $yScale);

        }

        $contentsToDraw = $canvas->getContents();

        /** @todo implementation */

        $this->restoreGS();

        return $this;

    }

    /**

     * Set fill color.

     *

     * @param Zend_Pdf_Color $color

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setFillColor(Zend_Pdf_Color $color)

    {

        $this->_addProcSet('PDF');

        $this->_contents .= $color->instructions(false);

        return $this;

    }

    /**

     * Set line color.

     *

     * @param Zend_Pdf_Color $color

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setLineColor(Zend_Pdf_Color $color)

    {

        $this->_addProcSet('PDF');

        $this->_contents .= $color->instructions(true);

        return $this;

    }

    /**

     * Set line width.

     *

     * @param float $width

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setLineWidth($width)

    {

        $this->_addProcSet('PDF');

        $widthObj = new Zend_Pdf_Element_Numeric($width);

        $this->_contents .= $widthObj->toString() . " w\n";

        return $this;

    }

    /**

     * Set line dashing pattern

     *

     * Pattern is an array of floats: array(on_length, off_length, on_length, off_length, ...)

     * or Zend_Pdf_Page::LINE_DASHING_SOLID constant

     * Phase is shift from the beginning of line.

     *

     * @param mixed $pattern

     * @param array $phase

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setLineDashingPattern($pattern, $phase = 0)

    {

        $this->_addProcSet('PDF');

        require_once 'Zend/Pdf/Page.php';

        if ($pattern === Zend_Pdf_Page::LINE_DASHING_SOLID) {

            $pattern = array();

            $phase   = 0;

        }

        $dashPattern  = new Zend_Pdf_Element_Array();

        $phaseEleemnt = new Zend_Pdf_Element_Numeric($phase);

        foreach ($pattern as $dashItem) {

            $dashElement = new Zend_Pdf_Element_Numeric($dashItem);

            $dashPattern->items[] = $dashElement;

        }

        $this->_contents .= $dashPattern->toString() . ' '

                         . $phaseEleemnt->toString() . " d\n";

        return $this;

    }

    /**

     * Set current font.

     *

     * @param Zend_Pdf_Resource_Font $font

     * @param float $fontSize

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setFont(Zend_Pdf_Resource_Font $font, $fontSize)

    {

        $this->_addProcSet('Text');

        $fontName = $this->_attachResource('Font', $font);

        $this->_font     = $font;

        $this->_fontSize = $fontSize;

        $fontNameObj = new Zend_Pdf_Element_Name($fontName);

        $fontSizeObj = new Zend_Pdf_Element_Numeric($fontSize);

        $this->_contents .= $fontNameObj->toString() . ' ' . $fontSizeObj->toString() . " Tf\n";

        return $this;

    }

    /**

     * Set the style to use for future drawing operations on this page

     *

     * @param Zend_Pdf_Style $style

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setStyle(Zend_Pdf_Style $style)

    {

        $this->_addProcSet('Text');

        $this->_addProcSet('PDF');

        if ($style->getFont() !== null) {

            $this->setFont($style->getFont(), $style->getFontSize());

        }

        $this->_contents .= $style->instructions($this->_dictionary->Resources);

        $this->_style = $style;

        return $this;

    }

    /**

     * Get current font.

     *

     * @return Zend_Pdf_Resource_Font $font

     */

    public function getFont()

    {

        return $this->_font;

    }

    /**

     * Get current font size

     *

     * @return float $fontSize

     */

    public function getFontSize()

    {

        return $this->_fontSize;

    }

    /**

     * Return the style, applied to the page.

     *

     * @return Zend_Pdf_Style

     */

    public function getStyle()

    {

        return $this->_style;

    }

    /**

     * Save the graphics state of this page.

     * This takes a snapshot of the currently applied style, position, clipping area and

     * any rotation/translation/scaling that has been applied.

     *

     * @todo check for the open paths

     * @throws Zend_Pdf_Exception    - if a save is performed with an open path

     * @return Zend_Pdf_Canvas_Interface

     */

    public function saveGS()

    {

        $this->_saveCount++;

        $this->_addProcSet('PDF');

        $this->_contents .= " q\n";

        return $this;

    }

    /**

     * Restore the graphics state that was saved with the last call to saveGS().

     *

     * @throws Zend_Pdf_Exception   - if there is no previously saved state

     * @return Zend_Pdf_Canvas_Interface

     */

    public function restoreGS()

    {

        if ($this->_saveCount-- <= 0) {

            require_once 'Zend/Pdf/Exception.php';

            throw new Zend_Pdf_Exception('Restoring graphics state which is not saved');

        }

        $this->_contents .= " Q\n";

        return $this;

    }

    /**

     * Set the transparancy

     *

     * $alpha == 0  - transparent

     * $alpha == 1  - opaque

     *

     * Transparency modes, supported by PDF:

     * Normal (default), Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight,

     * SoftLight, Difference, Exclusion

     *

     * @param float $alpha

     * @param string $mode

     * @return Zend_Pdf_Canvas_Interface

     */

    public function setAlpha($alpha, $mode = 'Normal')

    {

        $this->_addProcSet('Text');

        $this->_addProcSet('PDF');

        $graphicsState = new Zend_Pdf_Resource_GraphicsState();

        $graphicsState->setAlpha($alpha, $mode);

        $gStateName = $this->_attachResource('ExtGState', $graphicsState);

        $gStateNameObject = new Zend_Pdf_Element_Name($gStateName);

        $this->_contents .= $gStateNameObject->toString() . " gs\n";

        return $this;

    }

    /**

     * Intersect current clipping area with a circle.

     *

     * @param float $x

     * @param float $y

     * @param float $radius

     * @param float $startAngle

     * @param float $endAngle

     * @return Zend_Pdf_Canvas_Interface

     */

    public function clipCircle($x, $y, $radius, $startAngle = null, $endAngle = null)

    {

        $this->clipEllipse($x - $radius, $y - $radius,

                           $x + $radius, $y + $radius,

                           $startAngle, $endAngle);

        return $this;

    }

    /**

     * Intersect current clipping area with a polygon.

     *

     * Method signatures:

     * drawEllipse($x1, $y1, $x2, $y2);

     * drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle);

     *

     * @todo process special cases with $x2-$x1 == 0 or $y2-$y1 == 0

     *

     * @param float $x1

     * @param float $y1

     * @param float $x2

     * @param float $y2

     * @param float $startAngle

     * @param float $endAngle

     * @return Zend_Pdf_Canvas_Interface

     */

    public function clipEllipse($x1, $y1, $x2, $y2, $startAngle = null, $endAngle = null)

    {

        $this->_addProcSet('PDF');

        if ($x2 < $x1) {

            $temp = $x1;

            $x1   = $x2;

            $x2   = $temp;

        }

        if ($y2 < $y1) {

            $temp = $y1;

            $y1   = $y2;

            $y2   = $temp;

        }

        $x = ($x1 + $x2)/2.;

        $y = ($y1 + $y2)/2.;

        $xC = new Zend_Pdf_Element_Numeric($x);

        $yC = new Zend_Pdf_Element_Numeric($y);

        if ($startAngle !== null) {

            if ($startAngle != 0) { $startAngle = fmod($startAngle, M_PI*2); }

            if ($endAngle   != 0) { $endAngle   = fmod($endAngle,   M_PI*2); }

            if ($startAngle > $endAngle) {

                $endAngle += M_PI*2;

            }

            $clipPath    = $xC->toString() . ' ' . $yC->toString() . " m\n";

            $clipSectors = (int)ceil(($endAngle - $startAngle)/M_PI_4);

            $clipRadius  = max($x2 - $x1, $y2 - $y1);