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

Source for file OpenDocumentText.php

Documentation is available at OpenDocumentText.php

  1. <?php
  2. /*
  3.  * Created on 04.01.2007 by Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  4.  *
  5.  * PHP versions 5.2 or better.
  6.  *
  7.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  8.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  9.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  10.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  11.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  12.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  13.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  14.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  15.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  16.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  17.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  18.  *
  19.  * This software consists of voluntary contributions made by many individuals
  20.  * and is licensed under the GPL. For more information please see
  21.  * <http://opendocumentphp.org>.
  22.  * 
  23.  * $Id: OpenDocumentText.php 182 2007-06-11 13:32:34Z nmarkgraf $
  24.  */
  25. require_once 'OpenDocumentPHP/OpenDocumentAbstract.php';
  26. /**
  27.  * OpenDocumentText class.
  28.  *   
  29.  * You could uses this class as follows:
  30.  * 
  31.  * <code>
  32.  *         $text = new OpenDocumentText( 'YourFavoriteTextDocument.odt' );
  33.  *         // do some thing with it
  34.  *         ...
  35.  *         // And write it back
  36.  *         $text->close();
  37.  * </code>
  38.  * 
  39.  * Be aware that even if <b>you</b> do not modifiy the OpenDocument, the library will!
  40.  * So do not expect the that the file is absolut the same after you run the close method.
  41.  * 
  42.  * @author         Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  43.  * @copyright     Copyright in 2006, 2007 by The OpenDocumentPHP Team
  44.  * @license     http://www.gnu.org/licenses/gpl.html GNU Public License 2.0 or above.
  45.  * @version        $Revision: 182 $
  46.  * @package        OpenDocumentPHP
  47.  * @since         0.5.0 - 08.02.2007
  48.  */
  49. class OpenDocumentText extends OpenDocumentAbstract {
  50.     /**
  51.      * Namespace TEXT
  52.      */
  53.     const odmTextNamespace = 'application/vnd.oasis.opendocument.text';
  54.     /**
  55.      * Constructor method.
  56.      * 
  57.      * Read (and if not exists create) an OpenDocument text file.
  58.      * 
  59.      * @param         string fullpath Full path and name of the document
  60.      * @since         0.5.0 - 08.02.2007
  61.      */
  62.     function __construct($fullpath=null) {
  63.         // Construct a text document
  64.         parent :: __construct(self :: odmTextNamespace);
  65.         // Is the variable $fullpath given?
  66.         if (isset($fullpath) && is_string($fullpath)) {            
  67.             if (file_exists($fullpath)) {
  68.                 // File does exist, so we can load it via open.
  69.                 parent :: open($fullpath);
  70.             } else {
  71.                 // File does not exist, so we can create it.        
  72.                 parent :: open($fullpath, self :: CREATE, self :: odmTextNamespace);
  73.                 // Clean it, with a fresh init call.                
  74.                 $this->init();                
  75.                 // Set everything to a OpenDocument TEXT file.
  76.                 $this->content->setText();
  77.             }
  78.         } else {
  79.             // JUST A CLEAN FILE WITH NO FILE NAME JET!!!! DANGER!!!!
  80.             $this->init();
  81.             $this->content->setText();
  82.         }
  83.     }
  84.     /**     
  85.      * @since        0.5.2 - 21.03.2007
  86.      */
  87.     function setDefaultStyles() {
  88.         
  89.     }
  90.     /**
  91.      * Setup some default data for the meta.xml.
  92.      * 
  93.      * @since        0.5.2 - 21.03.2007
  94.      */
  95.     function setDefaultMeta() {
  96.         // =====================================================================
  97.         $dc = $this->getMeta()->getDublinCoreFragment();
  98.         // ---------------------------------------------------------------------
  99.         $dc->setSubject('A generated subject by OpenDocumentPHP.');
  100.         $dc->setTitle('This is a generated title by OpenDocumentPHP.');
  101.         $dc->setDescription('This is a short description by OpenDocumentPHP.');
  102.         $dc->setLanguage('en');
  103.         // =====================================================================    
  104.         $meta = $this->getMeta()->getMetaFragment();
  105.         // ---------------------------------------------------------------------        
  106.     }
  107. }
  108. ?>
Documentation generated on Tue, 12 Jun 2007 10:00:31 +0200 by phpDocumentor 1.3.2