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

Class: OpenDocument

Source Location: /OpenDocument-0.2.1/OpenDocument.php

Class Overview


Base class containing methods to open and create documents.


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 47]
Base class containing methods to open and create documents.

It contains namespace definitions as well.

This class is not to be extendet or derived from. Its only purpose is to server as hub to create document objects, and to keep commonly used constants.



[ Top ]


Class Variables

$documenttypes = array(
        'text',
        'spreadsheet',
        'presentation',
        'drawing',
        'image',
        'chart',
    )

[line 91]

Array of supported document types.

Type:   array


[ Top ]



Method Detail

chart   [line 315]

OpenDocument_Document_Chart chart( [string $file = null], [mixed $storage = null])

Creates and returns a new chart document.

NOT IMPLEMENTED YET


Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]

create   [line 174]

OpenDocument_Document create( string $type, [string $file = null], [mixed $storage = null])

Creates and returns a new OpenDocument document object.

Parameters:

string   $type     Type of document to create: 'text', 'spreadsheet', 'drawing', 'chart', 'image', 'presentation'
string   $file     Name of the file to be saved as
mixed   $storage     Storage class or object to use. Object need to implement OpenDocument_Storage

[ Top ]

drawing   [line 273]

OpenDocument_Document_Drawing drawing( [string $file = null], [mixed $storage = null])

Creates and returns a new drawing document.

NOT IMPLEMENTED YET


Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]

image   [line 336]

OpenDocument_Document_Image image( [string $file = null], [mixed $storage = null])

Creates and returns a new image document.

NOT IMPLEMENTED YET


Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]

includeClassFile   [line 211]

void includeClassFile( string $class)

Includes the correct class for the given file
  • Throws: OpenDocument_Exception When the class cannot be loaded
  • Access: protected
  • Usedby: OpenDocument::create()

Parameters:

string   $class     Class name to load file for

[ Top ]

open   [line 123]

OpenDocument_Document open( string $file)

Open the given file
  • Return: A document object
  • Access: public

Parameters:

string   $file     Name (path) of file to open

[ Top ]

presentation   [line 294]

OpenDocument_Document_Presentation presentation( [string $file = null], [mixed $storage = null])

Creates and returns a new presentation document.

NOT IMPLEMENTED YET


Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]

spreadsheet   [line 252]

OpenDocument_Document_Spreadsheet spreadsheet( [string $file = null], [mixed $storage = null])

Creates and returns a new spreadsheet document.

NOT IMPLEMENTED YET


Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]

text   [line 234]

OpenDocument_Document_Text text( [string $file = null], [mixed $storage = null])

Creates and returns a new text document.

Parameters:

string   $file     Name of file that will be saved
mixed   $storage     Storage class or object to use

[ Top ]


Documentation generated on Tue, 23 Oct 2012 12:00:08 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.