Skip to content

Commit

Permalink
slight modification in storage interface
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.php.net/repository/pear/packages/OpenDocument/trunk@282807 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information
cweiske committed Jun 26, 2009
1 parent dc7b8a0 commit b71e3d7
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions OpenDocument/Storage.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
<?php

/**
* PEAR OpenDocument package
*
* PHP version 5
*
* @category File Formats
* @package OpenDocument
* @author Christian Weiske <cweiske@php.et>
* @license http://www.gnu.org/copyleft/lesser.html Lesser General Public License 2.1
* @version @package_version@
* @link http://pear.php.net/package/OpenDocument
* @since File available since Release 0.2.0
*/

/**
* Generic OpenDocument data and file storage interface.
* Each storage mechanism needs to implement this interface.
*
* The OpenDocument specification defines two document
* representations:
* - one single XML element
* - one single large XML document
* - a ZIP file containing several subdocuments
*
* By providing an implementation agnostic interface, we can
Expand All @@ -22,17 +34,18 @@ interface OpenDocument_Storage
* The file name may be passed, but can be omitted if the
* final storage location is not known yet.
*
* Storage drivers might create temporary directories or files
* in case no file name is given here.
* Storage drivers may choose to create temporary files or
* directories in case no file name is given here.
*
* @param string $type Document type ('text', 'spreadsheet')
* @param string $file Name of the file to be created
*
* @return void
*
* @throws OpenDocument_Exception In case creating the given file
* is not possible.
*/
public function create($file = null);
public function create($type, $file = null);

/**
* Opens the given file.
Expand All @@ -58,23 +71,20 @@ public function open($file);
*/
public function getContentDom();


/**
* Returns the Dom object containing the meta data.
*
* @return DOMDocument
*/
public function getMetaDom();


/**
* Returns the Dom object containing the settings.
*
* @return DOMDocument
*/
public function getSettingsDom();


/**
* Returns the Dom object containing the styles.
*
Expand Down

0 comments on commit b71e3d7

Please sign in to comment.