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

Source for file SettingsDocument.php

Documentation is available at SettingsDocument.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /*
  6.  * Created on 05. Jan. 2007 by Norman Markgraf (nmarkgraf(at)user.sourceforge.net) 
  7.  */
  8.  
  9. /**
  10.  * SettingsDocument class file.
  11.  * 
  12.  * OpenDocumentPHP does not support the settings document right now. But it is in
  13.  * the OpenDocument documentation, so we have build a wrapper class for it.
  14.  *  
  15.  * Because of that, no real functionality is added. Feel free to change it. ;-)
  16.  *
  17.  * PHP versions 5
  18.  *   
  19.  * LICENSE:
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * This software consists of voluntary contributions made by many individuals
  33.  * and is licensed under the GPL. For more information please see
  34.  * <http://opendocumentphp.org>.
  35.  * 
  36.  * $Id: SettingsDocument.php 236 2007-07-24 07:43:40Z nmarkgraf $
  37.  *
  38.  * @category    File Formats
  39.  * @package        OpenDocumentPHP
  40.  * @subpackage    settings
  41.  * @author         Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  42.  * @copyright     Copyright in 2006, 2007 by The OpenDocumentPHP Team
  43.  * @license     http://www.gnu.org/licenses/gpl.html GNU General Public License 2.0.
  44.  * @version        SVN: $Id: SettingsDocument.php 236 2007-07-24 07:43:40Z nmarkgraf $
  45.  * @link           http://opendocumentphp.org
  46.  * @since         0.5.0 - 08. Feb. 2007
  47.  */
  48.  
  49. /**
  50.  * 
  51.  */
  52. require_once 'OpenDocumentPHP/util/AbstractDocument.php';
  53.  
  54. /**
  55.  * SettingsDocument class.
  56.  * 
  57.  * OpenDocumentPHP does not support the settings document right now. But it is in
  58.  * the OpenDocument documentation, so we have build a wrapper class for it.
  59.  *  
  60.  * Because of that, no real functionality is added. Feel free to change it. ;-)
  61.  * 
  62.  * @category    File Formats
  63.  * @package        OpenDocumentPHP
  64.  * @subpackage    settings
  65.  * @author         Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
  66.  * @copyright     Copyright in 2006, 2007 by The OpenDocumentPHP Team
  67.  * @license     http://www.gnu.org/licenses/gpl.html GNU General Public License 2.0.
  68.  * @version     Release: @package_version@
  69.  * @link           http://opendocumentphp.org
  70.  * @since         0.5.0 - 08. Feb. 2007
  71.  */
  72. class SettingsDocument extends AbstractDocument {
  73.     /**
  74.      * Root element of the settings DOM document.
  75.      * 
  76.      * @var         DOMElement 
  77.      * @access        private
  78.      * @since         0.5.0 - 08. Feb. 2007
  79.      */
  80.     private $settings;
  81.     /**
  82.      * Constructor method.
  83.      * 
  84.      * We construct an empty settings document here. It should look like:
  85.      * <code>
  86.      *  <?xml version="1.0" encoding="UTF-8"?>
  87.      *     <office:document-settings xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" office:version="1.0">
  88.      *         <office:settings/>
  89.      *    </office:document-settings>
  90.      * </code>
  91.      * 
  92.      * This is in general not a valid document, because the <office:settings> tag needs
  93.      * some children (one or more config items). If there are no such children the
  94.      * {@link saveXML()} method will remove the <office:settings/> tag to match the
  95.      * RelaxNG specification.
  96.      * So currently the saved settings.xml should look more like:
  97.      * <code>
  98.      *  <?xml version="1.0" encoding="UTF-8"?>
  99.      *     <office:document-settings xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" office:version="1.0" /
  100.      * </code>
  101.      *       
  102.      * 
  103.      * @since         0.5.0 - 08. Feb. 2007
  104.      */
  105.     function __construct() {
  106.         parent :: __construct('office:document-settings');
  107.         /*
  108.          * create a main (not root) element ( <office:settings>...</office:settings> )
  109.          */ 
  110.         $this->settings = $this->createElementNS(self :: OFFICE, 'office:settings');
  111.         /*
  112.          * and add it to the document root. This may be wrong, if we did not add
  113.          * any further config items to the settings document. But we will correct this
  114.          * later in the saveXML method.
  115.          */
  116.         $this->root->appendChild($this->settings);
  117.     }
  118.     
  119.     /**
  120.      * Save the needed parts of the settings.xml as a XML. If we do not have
  121.      * any config items in th settings document, we remove anything and leave
  122.      * just the skeleton.
  123.      *  
  124.      * @access        private
  125.      * @since        0.5.3 - 09. Jul. 2007
  126.      */
  127.     function saveXML() {
  128.         /*
  129.          * We must check if this->settings has any children, if not we *must* remove it from the tree.
  130.          */
  131.         if ( !$this->settings->hasChildNodes() ) {
  132.             $this->root->removeChild( $this->settings );
  133.         }
  134.         /*
  135.          * Now we can do the inhereted stuff.
  136.          */
  137.         return parent::saveXML();
  138.     }
  139.     /**
  140.      * Loads a settings document into this SettingsDocument object.
  141.      * 
  142.      * @access     public
  143.      * @since     0.5.2 - 22. Feb. 2007
  144.      */
  145.     function loadXML($source) {
  146.         /*
  147.          * First we load the document by the parent method
  148.          */
  149.         $ret = parent::loadXML($source);
  150.         
  151.         if ($ret === TRUE) {
  152.             /*
  153.              * If it was loaded correctly, we need to set up some
  154.              * local attributes. Therefore we first init the XPath stuff
  155.              */                
  156.             $this->initXpath();
  157.             /*
  158.              * Now we need the document root element to fill $this->root 
  159.              */
  160.             $this->root = $this->documentElement;
  161.             /*
  162.              * We now setup the $this->settings element... 
  163.              * First we ask XPath to give us the <office:settings> tag. 
  164.              */            
  165.             $tmp = $this->xpath->query('/office:document-settings/office:settings');            
  166.             
  167.             if ($tmp->length == 1) {
  168.                 /*
  169.                  * The only result is the settings tag in this case. So we can put
  170.                  * it in the $this->settings attribute.
  171.                  */
  172.                 $this->settings = $tmp->item( 0 );
  173.             } elseif ($tmp->length == 0) {
  174.                 /*
  175.                  * We got an empty seetings document. This could happen. We need
  176.                  * to setup a <office:settings> element and add it to the document.
  177.                  * If no other config item will be added to this, the saveXML 
  178.                  * method will eliminate this empty tag.
  179.                  */
  180.                 $this->settings = $this->createElementNS(self :: OFFICE, 'office:settings');
  181.                 $this->root->appendChild($this->settings);                
  182.             } else {
  183.                 /*
  184.                  * Something strange happend and this should never occure.
  185.                  * *** EXCEPTION HANDLING ***
  186.                  */
  187.                 $ret = FALSE;            
  188.             }
  189.         }
  190.         return $ret;
  191.     }
  192. }
  193. ?>
Documentation generated on Wed, 18 Jun 2008 06:31:56 +0200 by phpDocumentor 1.3.2