Class: MetaFragment

Source Location: /meta/MetaFragment.php

Class MetaFragment

Class Overview

MetaFragment class.

Located in /meta/MetaFragment.php [line 62]

Fragment
   |
   --MetaFragment

Author(s):

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

Information Tags:

Version:	Release: @package_version@
Copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
Link:	http://opendocumentphp.org
Since:	0.5.0 - 08. Feb. 2007
License:	GNU General Public License 2.0.

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Fragment

Fragment::$domFragment

Fragment::$root

Fragment::$xpath

Inherited From Fragment

Fragment::__construct()

Constructor method.

Fragment::appendChild()

Set attribute with namespace.

Fragment::createDCElement()

Create an DOMElement in the DC namespace with tag $tag.

Fragment::createMetaElement()

Create an DOMElement in the Meta namespace with tag $tag.

Fragment::createOfficeElement()

Create an DOMElement in the Office namespace with tag $tag.

Fragment::createStyleElement()

Create an DOMElement in the Meta namespace with tag $tag.

Fragment::getChild()

Retrieve a child by its namespace and tag from the current node.

Fragment::getDocumentFragment()

Returns the root DOMElement of this DOM fragment.

Fragment::getTag()

Fragment::hasChild()

Check if the current element has a child $tag with $namespace.

Fragment::initXpath()

Initialize xpath. You must do this before using xpath.

Fragment::setTag()

Set (which means append or replace an existing node) a new node.

[ Top ]

Method Summary

MetaFragment	__construct()	Constructor method.
string	getCreationDate()	Retrieve the creation date of this document.
void	getDocumentFragment()
String	getGenerator()	Retrieve the generator tag. The generator is the name of the programm on which the current OpenDocument was generated.
String	getInitialCreator()	Retrieve the so called initial-creator. This should be the first author of this document.
void	getPrintDate()
void	getTag()
void	initMetaFragment()
void	makeCreationDate()
void	setCreationDate()	Put the creation date into the meta document. If no date parameter where given, the current date will be used.
void	setGenerator()	Put the generator tag into the meta document. If called with no parameter the generator tag will be set to: 'OpenDocumentPHP/$Revision: 250 $', as this is the default value
void	setInitialCreator()	Put the so called initial-creator into the current meta document. The initial creator should be the first author of an OpenDocument and should allways be put in.
void	setPrintDate()
void	setUserDefined()
void	setUserDefinedArray()

[ Top ]

Properties

Methods

Constructor __construct [line 117]

MetaFragment __construct(

$domFragment, 
$root 
)

Constructor method.

Parameters:

	$domFragment:
	$root:

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

Fragment::__construct(): Constructor method.

[ Top ]

getCreationDate [line 264]

string getCreationDate(
)

Retrieve the creation date of this document.

API Tags:

Return:	creation date
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getDocumentFragment [line 160]

void getDocumentFragment(
)

API Tags:

Deprecated:	0.5.1 - 09. Feb. 2007
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

Fragment::getDocumentFragment(): Returns the root DOMElement of this DOM fragment.

[ Top ]

getGenerator [line 212]

String getGenerator(
)

Retrieve the generator tag. The generator is the name of the programm on which the current OpenDocument was generated.

API Tags:

Return:	The generator tag.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getInitialCreator [line 176]

String getInitialCreator(
)

Retrieve the so called initial-creator. This should be the first author of this document.

In a meta document, if there is a tag like this one

<meta:initial-creator>Alex Latchford</meta:initial-creator>

this method will return "Alex Latchford" as a string.

API Tags:

Return:	The initial creator of this document.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getPrintDate [line 292]

void getPrintDate(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getTag [line 151]

void getTag(

$tag, 
$defaultValue 
)

Parameters:

	$tag:
	$defaultValue:

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

Fragment::getTag()

[ Top ]

initMetaFragment [line 141]

void initMetaFragment(
)

[ Top ]

makeCreationDate [line 239]

void makeCreationDate(
[
$s = null] 
)

Parameters:

$s:

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setCreationDate [line 278]

void setCreationDate(
[string|date
$date = null] 
)

Put the creation date into the meta document. If no date parameter where given, the current date will be used.

Parameters:

string|date

$date:

new creation date

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setGenerator [line 226]

void setGenerator(
[String
$generator = 'OpenDocumentPHP/$Revision: 250 $'] 
)

Put the generator tag into the meta document. If called with no parameter the generator tag will be set to: 'OpenDocumentPHP/$Revision: 250 $', as this is the default value

Parameters:

String

$generator:

The new generator tag.

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setInitialCreator [line 196]

void setInitialCreator(
String
$creator 
)

Put the so called initial-creator into the current meta document. The initial creator should be the first author of an OpenDocument and should allways be put in.

If you write something like:

$metaDoc->setInitialCreator('Norman Markgraf');

to a MetaDocument $metaDoc, the initial creator is set to the string 'Norman Markgraf'.

Parameters:

String

$creator:

The new initial creator of this OpenDocument.

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setPrintDate [line 304]

void setPrintDate(
[
$date = null] 
)

Parameters:

$date:

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setUserDefined [line 330]

void setUserDefined(
string
$name, string
$value 
)

Parameters:

string	$name:
string	$value:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 03. Mar. 2007

[ Top ]

setUserDefinedArray [line 318]

void setUserDefinedArray(

$userDefined 
)

Parameters:

array

$userDefined:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 03. Mar. 2007

[ Top ]

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

	OpenDocumentPHP meta

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