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


Files:
OpenDocumentAbstract.php
OpenDocumentArchive.php
OpenDocumentSpreadsheet.php
OpenDocumentText.php
Style.php
TableCell.php

subpackage content
ContentDocument.php
ScriptsFragment.php

subpackage content_body
BodyFragment.php

subpackage content_body_text
Heading.php
Paragraph.php
TextFragment.php
UserFieldDecl.php
UserFieldDecls.php
UserFieldGet.php

subpackage content_script
Script.php

subpackage manifest
ManifestDocument.php

subpackage meta
DublinCoreFragment.php
MetaDocument.php
MetaFragment.php

subpackage settings
SettingsDocument.php

subpackage util
AbstractDocument.php
AutomaticStylesFragment.php
DefaultStyle.php
ElementFragment.php
FontFace.php
FontFaceDeclFragment.php
Fragment.php
GraphicProperties.php
MasterStylesFragment.php
ODPElement.php
ParagraphProperties.php
StylesDocument.php
StylesFragment.php
TableFragment.php
TableProperties.php
TableRowProperties.php
TextProperties.php
Validator.php

Classes:
util
   AbstractDocument
   AutomaticStylesFragment
   DefaultStyle
   ElementFragment
   FontFace
   FontFaceDeclFragment
   Fragment
   GraphicProperties
   MasterStylesFragment
   ODPElement
   ParagraphProperties
   StylesDocument
   StylesFragment
   TableFragment
   TableProperties
   TableRowProperties
   TextProperties
   Validator
content_body
   BodyFragment
content
   ContentDocument
   ScriptsFragment
meta
   DublinCoreFragment
   MetaDocument
   MetaFragment
content_body_text
   Heading
   Paragraph
   TextFragment
   UserFieldDecl
   UserFieldDecls
   UserFieldGet
manifest
   ManifestDocument
OpenDocumentAbstract
OpenDocumentArchive
OpenDocumentSpreadsheet
OpenDocumentText
Style
TableCell
content_script
   Script
settings
   SettingsDocument

Class: MetaFragment

Source Location: /meta/MetaFragment.php

Class Overview

Fragment
   |
   --MetaFragment

MetaFragment class.


Author(s):

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

Version:

  • $Revision: 183 $

Copyright:

  • Copyright in 2006, 2007 by The OpenDocumentPHP Team

Methods

Inherited Constants

Class: Fragment

Fragment::ANIM
Fragment::CHART
Fragment::CONFIG
Fragment::DC
Fragment::DR3D
Fragment::DRAW
Fragment::FO
Fragment::FORM
Fragment::MANIFEST
Fragment::MATHML
Fragment::META
Fragment::NUMBER
Fragment::OFFICE
Fragment::PRESENTATION
Fragment::SCRIPT
Fragment::SMIL
Fragment::STYLE
Fragment::SVG
Fragment::TABLE
Fragment::TEXT
Fragment::XFORMS
Fragment::XLINK

Inherited Variables

Class: Fragment

Fragment::$domFragment
Fragment::$root
Fragment::$xpath

Inherited Methods

Class: 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.

Class Details

[line 35]
MetaFragment class.



Tags:

author:  Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
version:  $Revision: 183 $
copyright:  Copyright in 2006, 2007 by The OpenDocumentPHP Team
since:  0.5.0 - 08.02.2007
license:  GNU General Public License 2.0.


[ Top ]

Class Methods

constructor __construct [line 89]

MetaFragment __construct( $domFragment, $root)

Constructor method.



Tags:

since:  0.5.0 - 08.02.2007


Overrides Fragment::__construct() (Constructor method.)

Parameters:

   $domFragment  
   $root  

[ Top ]

method getCreationDate [line 224]

void getCreationDate( )

Retrieve the creation date of this document.



Tags:

since:  0.5.0 - 08.02.2007
access:  public


[ Top ]

method getDocumentFragment [line 120]

void getDocumentFragment( )



Tags:

deprecated:  0.5.1 - 09.02.2007
since:  0.5.0 - 08.02.2007
access:  public


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

[ Top ]

method getGenerator [line 172]

String getGenerator( )

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



Tags:

return:  The generator tag.
since:  0.5.0 - 08.02.2007
access:  public


[ Top ]

method getInitialCreator [line 136]

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




Tags:

return:  The initial creator of this document.
since:  0.5.0 - 08.02.2007
access:  public


[ Top ]

method getPrintDate [line 252]

void getPrintDate( )



Tags:

since:  0.5.0 - 08.02.2007
access:  public


[ Top ]

method getTag [line 111]

void getTag( $tag, $defaultValue)



Tags:

since:  0.5.0 - 08.02.2007
access:  protected


Overrides Fragment::getTag() (parent method not documented)

Parameters:

   $tag  
   $defaultValue  

[ Top ]

method makeCreationDate [line 199]

void makeCreationDate( [ $s = null])



Tags:

since:  0.5.0 - 08.02.2007
access:  protected


Parameters:

   $s  

[ Top ]

method setCreationDate [line 238]

void setCreationDate( [ $date = null])

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



Tags:

since:  0.5.0 - 08.02.2007
access:  public


Parameters:

   $date  

[ Top ]

method setGenerator [line 186]

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

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



Tags:

since:  0.5.0 - 08.02.2007
access:  public


Parameters:

String   $generator   The new generator tag.

[ Top ]

method setInitialCreator [line 156]

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:

  1.      $metaDoc->setInitialCreator('Norman Markgraf');
to a MetaDocument $metaDoc, the initial creator is set to the string 'Norman Markgraf'.




Tags:

since:  0.5.0 - 08.02.2007
access:  public


Parameters:

String   $creator   The new initial creator of this OpenDocument.

[ Top ]

method setPrintDate [line 264]

void setPrintDate( [ $date = null])



Tags:

since:  0.5.0 - 08.02.2007
access:  public


Parameters:

   $date  

[ Top ]

method setUserDefined [line 290]

void setUserDefined( string $name, string $value)



Tags:

since:  0.5.2 - 03.03.2007
access:  public


Parameters:

string   $name  
string   $value  

[ Top ]

method setUserDefinedArray [line 278]

void setUserDefinedArray( $userDefined)



Tags:

since:  0.5.2 - 03.03.2007
access:  public


Parameters:

array   $userDefined  

[ Top ]

Documentation generated on Tue, 12 Jun 2007 10:00:13 +0200 by phpDocumentor 1.3.2