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

Source for file Writer.php

Documentation is available at Writer.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.  * Spreadsheet_OpenDocument_Format class file.
  11.  * 
  12.  * Implementation of a <i>Writert</i> class for OpenDocuments like the <i>Writer</i>
  13.  * class in <i>PEAR_Spreadsheet_Writer</i> 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: Writer.php 250 2007-07-31 08:52:06Z 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: Writer.php 250 2007-07-31 08:52:06Z 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/OpenDocumentSpreadsheet.php';
  53. require_once 'OpenDocumentPHP/util/Spreadsheet/Workbook.php';
  54.  
  55. /**
  56.  * Spreadsheet_OpenDocument_Writer
  57.  * 
  58.  * @category    File Formats
  59.  * @package     OpenDocumentPHP
  60.  * @subpackage  util_Spreadsheet
  61.  * @author      Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  62.  * @copyright   Copyright in 2006, 2007 by The OpenDocumentPHP Team
  63.  * @license     http://www.gnu.org/licenses/gpl.html GNU General Public License 2.0.
  64.  * @version     Release: @package_version@
  65.  * @link        http://opendocumentphp.org
  66.  * @link        http://pear.php.net/package/Spreadsheet_Excel_Writer
  67.  * @since       0.6.0 - 22. Jul. 2007
  68.  */
  69. class Spreadsheet_OpenDocument_Writer extends Spreadsheet_OpenDocument_Workbook {
  70.  
  71.     /**
  72.      * The constructor. It just creates a Workbook
  73.      *
  74.      * @param       string|OpenDocumentArchive $filename   Eigther the optional filename
  75.      *                                                       for the Workbook or a completly ready
  76.      *                                                       OpenDocumentArchive object.
  77.      * @throws      Exception if no filename or OpenDocumentArchive is given.
  78.      * @since       0.6.0 - 22. Jul. 2007
  79.      */
  80.     function __construct($filename=null)
  81.     {
  82.         if (is_null($filename)) {
  83.             /*
  84.              * FATAL ERROR !!! We need a file name or a OpenDocument here! 
  85.              */
  86.             throw new Exception('Spreadsheet_OpenDocument_Writer::__construct needs a file name or a OpenDocumentArchive class as input');
  87.         }
  88.         if ($filename instanceof OpenDocumentArchive) {
  89.             /*
  90.              * We got a read OpenDocumentArchive object here, everything will be fine!
  91.              */
  92.             $tmpOpenDocument = $filename;
  93.         } else {
  94.            /*
  95.             * We first need to create an OpenDocumentSpreadsheet file here!
  96.             */
  97.             $tmpOpenDocument = new OpenDocumentSpreadsheet($filename);
  98.         }        
  99.         parent::__construct($tmpOpenDocument);            
  100.     }
  101.     
  102.     /**
  103.      * Utility function for writing formulas Converts a cell's coordinates to the A1 format.
  104.      * 
  105.      * Make sure that $col is in [0..701] as this is the range [A..ZZ]!
  106.      * Also make sure that $row is in [0..MAXINT]!
  107.      * 
  108.      * Examples:
  109.      * <code>
  110.      *      $cellA1 = Spreadsheet_OpenDocument_Writer::rowcolToCell(0, 0);
  111.      *      $cellB4 = Spreadsheet_OpenDocument_Writer::rowcolToCell(3, 1);
  112.      *      $cellD2 = Spreadsheet_OpenDocument_Writer::rowcolToCell(1, 3);
  113.      * </code>
  114.      * 
  115.      * @return      The cell identifier in A1 format
  116.      * @static
  117.      * @access      public
  118.      * @param       integer $row    Row for the cell to convert (0-indexed).
  119.      * @param       integer $col    Column for the cell to convert (0-indexed).
  120.      * 
  121.      */
  122.     static function rowcolToCell($row, $col)
  123.     {
  124.         if ($row < 0) {
  125.             throw new Exception('Index out of bounds (row negative).');
  126.         }
  127.         
  128.         if ($col < 0) {
  129.             throw new Exception('Index out of bounds (col negative).');        
  130.         }
  131.         if ($col > 701) {
  132.             throw new Exception('Index out of bounds (col greater ZZ).');
  133.         }
  134.         $strCol = '';
  135.         $c = $col;   
  136.         do {
  137.             $tmp = (int) $c % 26;
  138.             $strCol = chr(65 + $tmp) . $strCol;
  139.             $c = $c / 27;
  140.         } while ($c > 0);
  141.         return $strCol."$row";
  142.     }
  143.     
  144.     /**
  145.      * Send HTTP headers for the OpenDocument Calc file.
  146.      * 
  147.      * *** NOT IMPLEMENTED NOW ***
  148.      * 
  149.      * @access      public
  150.      * @param       string $filename    The filename to use for HTTP headers
  151.      * 
  152.      */
  153.     function send($filename)
  154.     {
  155.     
  156.     }
  157. }
Documentation generated on Wed, 18 Jun 2008 06:34:43 +0200 by phpDocumentor 1.3.2