tweet_live: comparison web/lib/Zend/Service/LiveDocx/MailMerge.php

equal deleted inserted replaced

-:5e7a0fedabdf
+:877f952ae2bd
 * 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)
+* @copyright  Copyright (c) 2005-2012 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 $
+* @version    $Id: MailMerge.php 24593 2012-01-05 20:35:02Z matthew $
 */
 /** Zend_Date **/
 require_once 'Zend/Date.php';
 /**
 * @category   Zend
 * @package    Zend_Service
 * @subpackage LiveDocx
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2012 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';
 /**
 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
 'Cannot read local template from disk.'
 );
 }
 $this->logIn();
 try {
 $this->getSoapClient()->SetLocalTemplate(array(
 'template' => base64_encode(file_get_contents($filename)),
 'format'   => self::getFormat($filename),
 ));
 * @since  LiveDocx 1.0
 */
 public function setRemoteTemplate($filename)
 {
 $this->logIn();
 try {
 $this->getSoapClient()->SetRemoteTemplate(array(
 'filename' => $filename,
 ));
 } catch (Exception $e) {
 * @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) {
 * @since  LiveDocx 1.0
 */
 public function setFieldValue($field, $value)
 {
 $this->_fieldValues[$field] = $value;
 return $this;
 }
 /**
 * Set block field values
 * @since  LiveDocx 1.0
 */
 public function setBlockFieldValues($blockName, $blockFieldValues)
 {
 $this->logIn();
 try {
 $this->getSoapClient()->SetBlockFieldValues(array(
 'blockName'        => $blockName,
 'blockFieldValues' => self::multiAssocArrayToArrayOfArrayOfString($blockFieldValues)
 ));
 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
 ));
 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();
 * @since  LiveDocx 1.0
 */
 public function retrieveDocument($format)
 {
 $this->logIn();
 $format = strtolower($format);
 try {
 $result = $this->getSoapClient()->RetrieveDocument(array(
 'format' => $format,
 ));
 } catch (Exception $e) {
 * @since  LiveDocx 1.2
 */
 public function getMetafiles($fromPage, $toPage)
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetMetafiles(array(
 'fromPage' => (integer) $fromPage,
 'toPage'   => (integer) $toPage,
 ));
 * @since  LiveDocx 1.2
 */
 public function getAllMetafiles()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetAllMetafiles();
 if (isset($result->GetAllMetafilesResult->string)) {
 $pageCounter = 1;
 $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)
 {
 $this->logIn();
 $ret = array();
 $result = $this->getSoapClient()->GetBitmaps(array(
 'fromPage'   => (integer) $fromPage,
 'toPage'     => (integer) $toPage,
 'zoomFactor' => (integer) $zoomFactor,
 'format'     => (string)  $format,
 } else {
 $ret[$pageCounter] = base64_decode($result->GetBitmapsResult->string);
 }
 }
 return $ret;
 }
 /**
 * Return graphical bitmap data for all pages of created document
 * Return array contains bitmap data (binary) - array key is page number
 *
 * @param  integer $zoomFactor
 * @param  string  $format
 * @return array
 * @since  LiveDocx 1.2
 */
 public function getAllBitmaps($zoomFactor, $format)
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetAllBitmaps(array(
 'zoomFactor' => (integer) $zoomFactor,
 'format'     => (string)  $format,
 ));
 } else {
 $ret[$pageCounter] = base64_decode($result->GetAllBitmapsResult->string);
 }
 }
 return $ret;
 }
 /**
 * Return all the fields in the template
 *
 * @return array
 * @since  LiveDocx 1.0
 */
 public function getFieldNames()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetFieldNames();
 if (isset($result->GetFieldNamesResult->string)) {
 if (is_array($result->GetFieldNamesResult->string)) {
 * @since  LiveDocx 1.0
 */
 public function getBlockFieldNames($blockName)
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetBlockFieldNames(array(
 'blockName' => $blockName
 ));
 * @since  LiveDocx 1.0
 */
 public function getBlockNames()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetBlockNames();
 if (isset($result->GetBlockNamesResult->string)) {
 if (is_array($result->GetBlockNamesResult->string)) {
 * @since  LiveDocx 1.0
 */
 public function uploadTemplate($filename)
 {
 $this->logIn();
 try {
 $this->getSoapClient()->UploadTemplate(array(
 'template' => base64_encode(file_get_contents($filename)),
 'filename' => basename($filename),
 ));
 * @since  LiveDocx 1.0
 */
 public function downloadTemplate($filename)
 {
 $this->logIn();
 try {
 $result = $this->getSoapClient()->DownloadTemplate(array(
 'filename' => basename($filename),
 ));
 } catch (Exception $e) {
 * @since  LiveDocx 1.0
 */
 public function deleteTemplate($filename)
 {
 $this->logIn();
 $this->getSoapClient()->DeleteTemplate(array(
 'filename' => basename($filename),
 ));
 }
 /**
 * List all templates stored on LiveDocx service
 *
 * @return array
 * @since  LiveDocx 1.0
 */
 public function listTemplates()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->ListTemplates();
 if (isset($result->ListTemplatesResult)) {
 $ret = $this->_backendListArrayToMultiAssocArray($result->ListTemplatesResult);
 * @since  LiveDocx 1.0
 */
 public function templateExists($filename)
 {
 $this->logIn();
 $result = $this->getSoapClient()->TemplateExists(array(
 'filename' => basename($filename),
 ));
 return (boolean) $result->TemplateExistsResult;
 * @since  LiveDocx 1.0
 */
 public function shareDocument()
 {
 $this->logIn();
 $ret    = null;
 $result = $this->getSoapClient()->ShareDocument();
 if (isset($result->ShareDocumentResult)) {
 $ret = (string) $result->ShareDocumentResult;
 * @since  LiveDocx 1.0
 */
 public function listSharedDocuments()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->ListSharedDocuments();
 if (isset($result->ListSharedDocumentsResult)) {
 $ret = $this->_backendListArrayToMultiAssocArray(
 * @since  LiveDocx 1.0
 */
 public function deleteSharedDocument($filename)
 {
 $this->logIn();
 $this->getSoapClient()->DeleteSharedDocument(array(
 'filename' => basename($filename),
 ));
 }
 * @since  LiveDocx 1.0
 */
 public function downloadSharedDocument($filename)
 {
 $this->logIn();
 try {
 $result = $this->getSoapClient()->DownloadSharedDocument(array(
 'filename' => basename($filename),
 ));
 } catch (Exception $e) {
 * @since  LiveDocx 1.0
 */
 public function sharedDocumentExists($filename)
 {
 $this->logIn();
 $ret             = false;
 $sharedDocuments = $this->listSharedDocuments();
 foreach ($sharedDocuments as $shareDocument) {
 if (isset($shareDocument['filename'])
 && (basename($filename) === $shareDocument['filename'])
 ) {
 $ret = true;
 break;
 }
 * @since  LiveDocx 1.0
 */
 public function getTemplateFormats()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetTemplateFormats();
 if (isset($result->GetTemplateFormatsResult->string)) {
 $ret = $result->GetTemplateFormatsResult->string;
 * @since  LiveDocx 1.1
 */
 public function getDocumentFormats()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetDocumentFormats();
 if (isset($result->GetDocumentFormatsResult->string)) {
 $ret = $result->GetDocumentFormatsResult->string;
 $ret = array_map('strtolower', $ret);
 }
 return $ret;
 }
 /**
 * Return the names of all fonts that are installed on backend server
 *
 * @return array
 * @since  LiveDocx 1.2
 */
 public function getFontNames()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetFontNames();
 if (isset($result->GetFontNamesResult->string)) {
 $ret = $result->GetFontNamesResult->string;
 }
 return $ret;
 }
 /**
 * Return supported document access options
 *
 * @return array
 * @since  LiveDocx 1.2 Premium
 */
 public function getDocumentAccessOptions()
 {
 $this->logIn();
 $ret    = array();
 $result = $this->getSoapClient()->GetDocumentAccessOptions();
 if (isset($result->GetDocumentAccessOptionsResult->string)) {
 $ret = $result->GetDocumentAccessOptionsResult->string;
 . "It has been replaced by %s::%s() (drop in replacement)",
 __CLASS__, __FUNCTION__, __CLASS__, $replacement);
 trigger_error($errorMessage, E_USER_NOTICE);
 */
 return $this->$replacement();
 }
 /**
 * Upload an image file to LiveDocx service
 /**
 * Convert LiveDocx service return value from list methods to consistent PHP array
 *
 * @param  array $list
 * @return array
 * @since  LiveDocx 1.0
 */
 protected function _backendListArrayToMultiAssocArray($list)
 {
 $this->logIn();
 $ret = array();
 if (isset($list->ArrayOfString)) {
 foreach ($list->ArrayOfString as $a) {
 if (is_array($a)) {      // 1 template only
 $o = new stdClass();
 */
 public static function assocArrayToArrayOfArrayOfString($assoc)
 {
 $arrayKeys   = array_keys($assoc);
 $arrayValues = array_values($assoc);
 return array($arrayKeys, $arrayValues);
 }
 /**
 * Convert multi assoc array to required SOAP type

changeset 807	877f952ae2bd
parent 207	621fa6caec0c
child 1230	68c69c656a2c