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

 * @subpackage LiveDocx

 * @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: MailMerge.php 23022 2010-10-05 15:30:55Z jonathan_maron $

 */

/** Zend_Date **/

require_once 'Zend/Date.php';

/** Zend_Service_LiveDocx **/

require_once 'Zend/Service/LiveDocx.php';

/**

 * @category   Zend

 * @package    Zend_Service

 * @subpackage LiveDocx

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

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

 * @since      LiveDocx 1.0 

 */

class Zend_Service_LiveDocx_MailMerge extends Zend_Service_LiveDocx

{

    /**

     * URI of LiveDocx.MailMerge WSDL

     * @since LiveDocx 1.0 

     */

    //const WSDL = 'https://api.livedocx.com/1.2/mailmerge.asmx?WSDL';

    const WSDL = 'https://api.livedocx.com/2.0/mailmerge.asmx?WSDL';

    /**

     * Field values

     *

     * @var   array

     * @since LiveDocx 1.0

     */

    protected $_fieldValues;

    /**

     * Block field values

     *

     * @var   array

     * @since LiveDocx 1.0

     */

    protected $_blockFieldValues;

    /**

     * Constructor (LiveDocx.MailMerge SOAP Service)

     *

     * @return void

     * @return throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function __construct($options = null)

    {

        $this->_wsdl             = self::WSDL;

        $this->_fieldValues      = array();

        $this->_blockFieldValues = array();

        parent::__construct($options);

    }

    /**

     * Set the filename of a LOCAL template

     * (i.e. a template stored locally on YOUR server)

     *

     * @param  string $filename

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function setLocalTemplate($filename)

    {

        if (!is_readable($filename)) {

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot read local template from disk.'

            );

        }

        $this->logIn();

        try {

            $this->getSoapClient()->SetLocalTemplate(array(

                'template' => base64_encode(file_get_contents($filename)),

                'format'   => self::getFormat($filename),

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set local template', 0, $e

            );

        }

        return $this;

    }

    /**

     * Set the filename of a REMOTE template

     * (i.e. a template stored remotely on the LIVEDOCX server)

     *

     * @param  string $filename

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function setRemoteTemplate($filename)

    {

        $this->logIn();

        try {

            $this->getSoapClient()->SetRemoteTemplate(array(

                'filename' => $filename,

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set remote template', 0, $e

            );

        }

        return $this;

    }

    /**

     * Set an associative or multi-associative array of keys and values pairs

     *

     * @param  array $values

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function setFieldValues($values)

    {

        $this->logIn();

        foreach ($values as $value) {

            if (is_array($value)) {

                $method = 'multiAssocArrayToArrayOfArrayOfString';

            } else {

                $method = 'assocArrayToArrayOfArrayOfString';

            }

            break;

        }

        try {

            $this->getSoapClient()->SetFieldValues(array(

                'fieldValues' => self::$method($values),

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set field values', 0, $e

            );

        }

        return $this;

    }

    /**

     * Set an array of key and value or array of values

     *

     * @param string $field

     * @param array|string $value

     *

     * @throws Zend_Service_LiveDocx_Exception

     * @return Zend_Service_LiveDocx_MailMerge

     * @since  LiveDocx 1.0

     */

    public function setFieldValue($field, $value)

    {

        $this->_fieldValues[$field] = $value;

        return $this;

    }

    /**

     * Set block field values

     *

     * @param string $blockName

     * @param array $blockFieldValues

     *

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function setBlockFieldValues($blockName, $blockFieldValues)

    {

        $this->logIn();

        try {

            $this->getSoapClient()->SetBlockFieldValues(array(

                'blockName'        => $blockName,

                'blockFieldValues' => self::multiAssocArrayToArrayOfArrayOfString($blockFieldValues)

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set block field values', 0, $e

            );

        }

        return $this;

    }

    /**

     * Assign values to template fields

     *

     * @param array|string $field

     * @param array|string $value

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.0

     */

    public function assign($field, $value = null)

    {

        try {

            if (is_array($field) && (null === $value)) {

                foreach ($field as $fieldName => $fieldValue) {

                    $this->setFieldValue($fieldName, $fieldValue);

                }

            } elseif (is_array($value)) {

                $this->setBlockFieldValues($field, $value);

            } else {

                $this->setFieldValue($field, $value);

            }

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot assign data to template', 0, $e

            );

        }

        return $this;

    }

    /**

     * Set a password to open to document

     * 

     * This method can only be used for PDF documents

     * 

     * @param  string  $password

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.2 Premium

     */

    public function setDocumentPassword($password)

    {

        $this->logIn();

        try {

            $this->getSoapClient()->SetDocumentPassword(array(

                'password' => $password

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set document password. This method can be used on PDF files only.', 0, $e

            );

        }

        return $this;        

    }

    /**

     * Set a master password for document and determine which security features

     * are accessible without using the master password.

     * 

     * As default, nothing is allowed. To allow a security setting,

     * explicatively set it using one of he DOCUMENT_ACCESS_PERMISSION_* class

     * constants. 

     * 

     * {code}

     * $phpLiveDocx->setDocumentAccessPermissions(

     *     array (

     *         Zend_Service_LiveDocx_MailMerge::DOCUMENT_ACCESS_PERMISSION_ALLOW_PRINTING_HIGH_LEVEL,

     *         Zend_Service_LiveDocx_MailMerge::DOCUMENT_ACCESS_PERMISSION_ALLOW_EXTRACT_CONTENTS

     *     ),

     *     'myDocumentAccessPassword'

     * );

     * {code}

     * 

     * This method can only be used for PDF documents

     * 

     * @param  array  $permissions 

     * @param  string $password

     * @return Zend_Service_LiveDocx_MailMerge

     * @throws Zend_Service_LiveDocx_Exception

     * @since  LiveDocx 1.2 Premium

     */

    public function setDocumentAccessPermissions($permissions, $password)

    {

        $this->logIn();

        try {

            $this->getSoapClient()->SetDocumentAccessPermissions(array(

                'permissions' => $permissions,

                'password'    => $password

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot set document access permissions', 0, $e

            );

        }

        return $this;        

    }    

    /**

     * Merge assigned data with template to generate document

     *

     * @throws Zend_Service_LiveDocx_Excpetion

     * @return void

     * @since  LiveDocx 1.0

     */

    public function createDocument()

    {

        $this->logIn();

        if (count($this->_fieldValues) > 0) {

            $this->setFieldValues($this->_fieldValues);

        }

        $this->_fieldValues      = array();

        $this->_blockFieldValues = array();

        try {

            $this->getSoapClient()->CreateDocument();

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot create document', 0, $e

            );

        }

    }

    /**

     * Retrieve document in specified format

     *

     * @param string $format

     *

     * @throws Zend_Service_LiveDocx_Exception

     * @return binary

     * @since  LiveDocx 1.0

     */

    public function retrieveDocument($format)

    {

        $this->logIn();

        $format = strtolower($format);

        try {

            $result = $this->getSoapClient()->RetrieveDocument(array(

                'format' => $format,

            ));

        } catch (Exception $e) {

            require_once 'Zend/Service/LiveDocx/Exception.php';

            throw new Zend_Service_LiveDocx_Exception(

                'Cannot retrieve document - call setLocalTemplate() or setRemoteTemplate() first', 0, $e

            );

        }

        return base64_decode($result->RetrieveDocumentResult);

    }

    /**

     * Return WMF (aka Windows metafile) data for specified page range of created document

     * Return array contains WMF data (binary) - array key is page number

     *

     * @param  integer $fromPage

     * @param  integer $toPage

     * @return array

     * @since  LiveDocx 1.2

     */

    public function getMetafiles($fromPage, $toPage)

    {

        $this->logIn();

        $ret    = array();

        $result = $this->getSoapClient()->GetMetafiles(array(

            'fromPage' => (integer) $fromPage,

            'toPage'   => (integer) $toPage,

        ));

        if (isset($result->GetMetafilesResult->string)) {

            $pageCounter = (integer) $fromPage;

            if (is_array($result->GetMetafilesResult->string)) {

                foreach ($result->GetMetafilesResult->string as $string) {

                    $ret[$pageCounter] = base64_decode($string);

                    $pageCounter++;

                }

            } else {

               $ret[$pageCounter] = base64_decode($result->GetMetafilesResult->string);

            }

        }

        return $ret;

    }

    /**

     * Return WMF (aka Windows metafile) data for pages of created document

     * Return array contains WMF data (binary) - array key is page number

     *

     * @return array

     * @since  LiveDocx 1.2

     */

    public function getAllMetafiles()

    {

        $this->logIn();

        $ret    = array();

        $result = $this->getSoapClient()->GetAllMetafiles();

        if (isset($result->GetAllMetafilesResult->string)) {

            $pageCounter = 1;

            if (is_array($result->GetAllMetafilesResult->string)) {

                foreach ($result->GetAllMetafilesResult->string as $string) {

                    $ret[$pageCounter] = base64_decode($string);

                    $pageCounter++;

                }

            } else {

               $ret[$pageCounter] = base64_decode($result->GetAllMetafilesResult->string);

            }

        }

        return $ret;

    }    

    /**

     * Return graphical bitmap data for specified page range of created document

     * Return array contains bitmap data (binary) - array key is page number

     *

     * @param  integer $fromPage

     * @param  integer $toPage

     * @param  integer $zoomFactor

     * @param  string  $format

     * @return array

     * @since  LiveDocx 1.2

     */    

    public function getBitmaps($fromPage, $toPage, $zoomFactor, $format)