phpDocumentor OpenDocumentPHP
util_Spreadsheet
[ class tree: OpenDocumentPHP ] [ index: OpenDocumentPHP ] [ all elements ]
OpenDocumentPHP
Packages:
OpenDocumentPHP

Source for file Workbook.php

Documentation is available at Workbook.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /*
  6.  * Created on 22. Jul. 2007 by Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  7.  */
  8.  
  9. /**
  10.  * Speadsheet_OpenDocument_Workbook class file.
  11.  * 
  12.  * Implementation of a Workbook for OpenDocuments like the PEAR_Spreadsheet_Writer
  13.  * does.
  14.  * 
  15.  * PHP versions 5
  16.  *   
  17.  * LICENSE:
  18.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29.  *
  30.  * This software consists of voluntary contributions made by many individuals
  31.  * and is licensed under the GPL. For more information please see
  32.  * <http://opendocumentphp.org>.
  33.  * 
  34.  * $Id: Workbook.php 257 2007-08-02 12:19:56Z nmarkgraf $
  35.  * 
  36.  * @category    File Formats
  37.  * @package     OpenDocumentPHP
  38.  * @subpackage  util_Spreadsheet
  39.  * @author      Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  40.  * @copyright   Copyright in 2006, 2007 by The OpenDocumentPHP Team
  41.  * @license     http://www.gnu.org/licenses/gpl.html GNU General Public License 2.0.
  42.  * @version     SVN: $Id: Workbook.php 257 2007-08-02 12:19:56Z nmarkgraf $
  43.  * @link        http://opendocumentphp.org
  44.  * @link        http://pear.php.net/package/Spreadsheet_Excel_Writer
  45.  * @since       0.6.0 - 22. Jul. 2007
  46.  */
  47.  
  48. /**
  49.  * 
  50.  */
  51. require_once 'OpenDocumentPHP/OpenDocumentArchive.php';
  52. require_once 'OpenDocumentPHP/util/Spreadsheet/Worksheet.php';
  53.  
  54. /**
  55.  * Spreadsheet_OpenDocument_Workbook
  56.  * 
  57.  * @category    File Formats
  58.  * @package     OpenDocumentPHP
  59.  * @subpackage  util_Spreadsheet
  60.  * @author      Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  61.  * @copyright   Copyright in 2006, 2007 by The OpenDocumentPHP Team
  62.  * @license     http://www.gnu.org/licenses/gpl.html GNU General Public License 2.0.
  63.  * @version     Release: @package_version@
  64.  * @link        http://opendocumentphp.org
  65.  * @link        http://pear.php.net/package/Spreadsheet_Excel_Writer
  66.  * @since       0.6.0 - 22. Jul. 2007
  67.  */
  68. class Spreadsheet_OpenDocument_Workbook {
  69.  
  70.     protected $_worksheets;
  71.  
  72.     protected $mainOpenDocument;
  73.     
  74.     protected $_automaticStyles;
  75.  
  76.     /**
  77.      * Constructor
  78.      */
  79.     function __construct($openDocument)
  80.     {
  81.         /*
  82.          * Connect this Workbook to the $opendocument
  83.          */
  84.         $this->mainOpenDocument = $openDocument;
  85.         /*
  86.          * Initialize the worksheets array
  87.          */
  88.         $this->_worksheets = array();
  89.         /*
  90.          * Initialize automatic-styles class.
  91.          */
  92.         $this->_automaticStyles = $this->mainOpenDocument->getContent()->getAutomaticStyles();
  93.         /*
  94.          * Add something like:
  95.          * <style:style style:name="DefaultColumn" style:family="table-column">
  96.          *      <style:table-column-properties fo:break-before="auto"
  97.          *                                     style:column-width="2.267cm" />
  98.          * </style:style>
  99.          *  
  100.          */
  101.         $defColStyle = $this->addNewAutomaticStyle('DefaultColumn');
  102.         $tableColumnProperties = new TableColumnProperties();
  103.         $defColStyle->appendChild($tableColumnProperties);
  104.         $tableColumnProperties->setColumnWidth('2.267cm');
  105.         /*
  106.          * Add something like:      
  107.          * <style:style style:name="ro1" style:family="table-row">
  108.          *      <style:table-row-properties style:row-height="0.453cm"
  109.          *                                  fo:break-before="auto" 
  110.          *                                  style:use-optimal-row-height="true" />
  111.          * </style:style>
  112.          */
  113.         $defRowStyle = $this->addNewAutomaticStyle('DefaultRow');
  114.         $tableRowProperties = new TableRowProperties();
  115.         $defRowStyle->appendChild($tableRowProperties);
  116.         $tableRowProperties->setRowHeight('0.453cm');
  117.         $tableRowProperties->setUseOptimalRowHeight();
  118.         
  119. /*        
  120.         <style:style style:name="co2" style:family="table-column">
  121.             <style:table-column-properties fo:break-before="auto"
  122.                 style:column-width="1cm" />
  123.         </style:style>
  124. */        
  125.         
  126.     }
  127.     
  128.     /**
  129.      * @param $name string
  130.      * @return Worksheet|PEAR_ErrorWorksheet object on success, PEAR_Error on failure
  131.      */     
  132.     function addWorksheet($name='') 
  133.     {
  134.         /*
  135.          * Check if $opendocument is from type Calc.
  136.          * Connect this Worksheet to the $opendocument
  137.         $this->mainOpenDocument = $opendocument;
  138.          */
  139.         /*
  140.          * Check if no $name was given, in this case we need to find a free space 
  141.          * and add the new worksheer there.
  142.          */
  143.         if ($name = '') {
  144.             $i = 0;
  145.             while ($this->_worksheets["$i"]) {
  146.                 $i++;
  147.             }
  148.             $name = "$i";
  149.         }
  150.         /*
  151.          * Create a new OpenDocument Worksheet
  152.          */
  153.         $newWorksheet = new Spreadsheet_OpenDocument_Worksheet($name, $this);
  154.         /*
  155.          * Add it to the worksheet list
  156.          */
  157.         $this->_worksheets[$name] = $newWorksheet;
  158.         /*
  159.          * return the new worksheet
  160.          */
  161.         return $newWorksheet; 
  162.     }
  163.     
  164.     /**
  165.      * @param $properties array
  166.      */
  167.     function addFormat($properties=array())
  168.     {
  169.     
  170.     }
  171.     
  172.     /**
  173.      * @param $dir string
  174.      */
  175.     function setTempDir($dir)
  176.     {
  177.     
  178.     }
  179.     
  180.     /**
  181.      * @param integer $index, 
  182.      * @param integer $red 
  183.      * @param integer $green 
  184.      * @param integer $blue 
  185.      */
  186.     function setCustomsColor($index, $red, $green, $blue)
  187.     {
  188.     
  189.     }
  190.     
  191.     /**
  192.      * @return bool|PEAR_Errortrue on success, PEAR_Error on failure
  193.      */
  194.     function close() 
  195.     {           
  196.         /*
  197.          * We need to check if there is any worksheet in the workbook.
  198.          * If there are some, we include ever worksheet to the 
  199.          * OpenDocument calc archive
  200.          */
  201.  
  202.         /*
  203.          * Get body object of the OpenDocument.
  204.          */
  205.         $body = $this->mainOpenDocument->getContent()->getBody();
  206.         
  207.         foreach($this->_worksheets as $worksheet) {
  208.             /*
  209.              * create a new table
  210.              */
  211.             $table = $body->getNewTableFragment($worksheet->getName());
  212.             /*
  213.              * If this worksheet is protected by a password...
  214.              */
  215.             if ($worksheet->proteced) {
  216.                 /*
  217.                  * ... add password to the table in the OpenDocument
  218.                  */
  219.                 $table->setProtection('true', $worksheet->protectionKey);             
  220.             }
  221.             /*
  222.              * 
  223.              */
  224.             /*
  225.              * Put cells into the OpenDocument
  226.              */
  227.             $cells = $worksheet->getCells();
  228.             foreach($cells as $row => $cellRow) {
  229.                 foreach($cellRow as $col => $cellRowCol) {
  230.                     switch ($cellRowCol['type']) {
  231.                         case 'url':
  232.                             $cell = $table->getCell($col, $row);
  233.                             $cell->setLinkContent($cellRowCol['url'], $cellRowCol['token']);
  234.                             break;
  235.                             
  236.                         default:
  237.                             $table->setCellContent($cellRowCol['token'], $col, $row);
  238.                     }
  239.                 }
  240.             }
  241.         }
  242.         $tmp = $body->getDocumentFragment();
  243.         $this->mainOpenDocument->close();
  244.         return true;
  245.     }
  246.     
  247.     function addNewAutomaticStyle($name=null) {
  248.         static $counter = 1;
  249.         $newStyle = new Style();
  250.         $this->_automaticStyles->appendChild($newStyle);
  251.         if (is_null($name)) {
  252.             $newStyle->setStyleName('au'."$counter");
  253.             $counter++;
  254.         } else {
  255.             $newStyle->setStyleName($name);
  256.         }
  257.         return $newStyle;                
  258.     }
  259. }
  260. ?>
Documentation generated on Wed, 18 Jun 2008 06:34:26 +0200 by phpDocumentor 1.3.2