Class: OpenDocumentAbstract

Source Location: /OpenDocumentAbstract.php

Class OpenDocumentAbstract

Class Overview

OpenDocumentAbstract class.

Located in /OpenDocumentAbstract.php [line 72]

ZipArchive
   |
   --OpenDocumentArchive
      |
      --OpenDocumentAbstract

Author(s):

Norman Markgraf (nmarkgraf(at)user.sourceforge.net)

API Tags:

Abstract:

Information Tags:

Version:	Release: @package_version@
Copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
Link:	http://www.oasis-open.org/committees/download.php/20847/OpenDocument-v1.1-cs1.pdf Open Document Format for Office Applications Release 1.1
Link:	http://www.oasis-open.org/committees/download.php/19274/OpenDocument-v1.0ed2-cs1.pdf Open Document Format for Office Applications Release 1.0 2nd Edition
Link:	http://opendocumentphp.org
Link:	http://www.oasis-open.org/committees/download.php/12572/OpenDocument-v1.0-os.pdf Open Document Format for Office Applications Release 1.0
Since:	0.5.0 - 08. Feb. 2007
License:	GNU General Public License 2.0.

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
OpenDocumentText	OpenDocumentText class.
OpenDocumentSpreadsheet	OpenDocumentSpreadsheet class.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From OpenDocumentArchive

OpenDocumentArchive::__construct()

Constructor method.

OpenDocumentArchive::addFile()

Adds a file to a ZIP archive from the given path.

OpenDocumentArchive::addFromString()

Add a file to a ZIP archive using its contents.

OpenDocumentArchive::close()

Close opened or created archive and save changes. This method is automatically called at the end of the script.

OpenDocumentArchive::deleteIndex()

Delete an entry in the archive using its index.

OpenDocumentArchive::deleteName()

Delete an entry in the archive using its name.

OpenDocumentArchive::getDOMFromName()

Retrieve file from archive as a DOM document.

OpenDocumentArchive::getFilelist()

Retrieve file list.

OpenDocumentArchive::getManifest()

Retreive the manifest document as a ManifestDocument object.

OpenDocumentArchive::getMimeType()

Retrieve mime type of the OpenDocument archive.

OpenDocumentArchive::open()

Opens a new zip archive for reading, writing or modifying.

OpenDocumentArchive::renameIndex()

Renames an entry defined by its index.

OpenDocumentArchive::renameName()

Renames an entry defined by its name.

OpenDocumentArchive::setMimeType()

Set mime type of the OpenDocument archive.

OpenDocumentArchive::statName()

Get the details of an entry defined by its name.

OpenDocumentArchive::unchangeAll()

Undo all changes done in the archive. Always returns false!

OpenDocumentArchive::unchangeIndex()

Revert all changes done to an entry at the given index.

OpenDocumentArchive::unchangeName()

Revert all changes done to an entry with the given name.

Inherited From OpenDocumentArchive

OpenDocumentArchive::NOMANIFEST

OpenDocumentArchive::PathToManifestXml

[ Top ]

Property Summary

ContentDocument	$content	The content document as object.
MetaDocument	$meta	The meta document as object.
SettingsDocument	$settings	The settings document as object.
StylesDocument	$styles	The styles document as object.

[ Top ]

Method Summary

void	close()	Close the current OpenDocument.
BodyFragment	getBody()	Retrieve the body part of the content document as an object of the BodyFragment class.
ContentDocument	getContent()	Retrieve the content document as an object of the ContentDocument class.
MetaDocument	getMeta()	Retrieve the meta document as an object of the MetaDocument class.
StylesDocument	getStyles()	Retrieve the styles document as an object of the StylesDocument class.
void	init()	Initialise the usual attributes of this class.
void	loadContent()	Load content document.
void	loadMeta()	Load meta document.
void	loadSettings()	Load settings document.
void	loadStyles()	Load styles document.
bool	open()	Open an OpenDocument and read the meta, settings, content and styles data out of the ususal xml files and stores them into their attributes.

[ Top ]

Properties

ContentDocument $content [line 80]

The content document as object.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

MetaDocument $meta [line 96]

The meta document as object.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

SettingsDocument $settings [line 104]

The settings document as object.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

StylesDocument $styles [line 88]

The styles document as object.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

Methods

close [line 186]

void close(
[bool
$write = true] 
)

Close the current OpenDocument.

When ever you work with an OpenDocument, you should close it a the end.

$text = new OpenDocumentText($fullpath);
//... do something ...
$text->close();

If you want to revert all modifications and do not write anything back to the archive you can use the first parameter of this function and set it to false.

$text = new OpenDocumentText($fullpath);
//... do something ...
// But we do not want to write it back to the archive
$text->close( false );

Parameters:

bool

$write:

Should we write something back to the archive? - Default is true.

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

OpenDocumentArchive::close(): Close opened or created archive and save changes. This method is automatically called at the end of the script.

[ Top ]

getBody [line 138]

BodyFragment getBody(
)

Retrieve the body part of the content document as an object of the BodyFragment class.

API Tags:

Return:	The body part of the content document as object.
Deprecated:	0.5.3 - 02. Jul. 2007
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getContent [line 158]

ContentDocument getContent(
)

Retrieve the content document as an object of the ContentDocument class.

API Tags:

Return:	The meta document as object.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getMeta [line 127]

MetaDocument getMeta(
)

Retrieve the meta document as an object of the MetaDocument class.

API Tags:

Return:	The meta document as object.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getStyles [line 148]

StylesDocument getStyles(
)

Retrieve the styles document as an object of the StylesDocument class.

API Tags:

Return:	The styles document as object.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

init [line 114]

void init(
)

Initialise the usual attributes of this class.

Calling this method will initialise fresh and new objects for the content, the meta, the styles and the settings document as part of this OpenDocument.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

loadContent [line 223]

void loadContent(
)

Load content document.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 02. Mar. 2007

[ Top ]

loadMeta [line 205]

void loadMeta(
)

Load meta document.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 02. Mar. 2007

[ Top ]

loadSettings [line 214]

void loadSettings(
)

Load settings document.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 02. Mar. 2007

[ Top ]

loadStyles [line 232]

void loadStyles(
)

Load styles document.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 02. Mar. 2007

[ Top ]

open [line 246]

bool open(
string
$filename, [int
$flags = 0], [string
$mimetype = ''] 
)

Open an OpenDocument and read the meta, settings, content and styles data out of the ususal xml files and stores them into their attributes.

Parameters:

string	$filename:	Filename
int	$flags:	File opening flags
string	$mimetype:	Mimetype

API Tags:

Return:	If everything went fine, we got true as result, else we get false.
Access:	public

Information Tags:

Since:

0.5.2 - 22. Feb. 2007

Redefinition of:

OpenDocumentArchive::open(): Opens a new zip archive for reading, writing or modifying.

[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:30:36 +0200 by phpDocumentor 1.3.2

	OpenDocumentPHP

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