Path

ez components / documentation / api reference / 2008.2.3 / databaseschema


eZ Components 2008.2.3

DatabaseSchema: ezcDbSchemaXmlReader

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcDbSchemaXmlReader

Handler that reads database definitions and database difference definitions from a file in an XML format. [source]

Implemented Interfaces

Method Summary

public int getDiffReaderType( )
Returns what type of schema difference reader this class implements.
public int getReaderType( )
Returns what type of reader writer this class implements.
public ezcDbSchemaDiff loadDiffFromFile( $file )
Returns the database differences stored in the XML file $file
public ezcDbSchema loadFromFile( $file )
Returns the database schema stored in the XML file $file

Methods

getDiffReaderType

int getDiffReaderType( )
Returns what type of schema difference reader this class implements.
This method always returns ezcDbSchema::FILE

getReaderType

int getReaderType( )
Returns what type of reader writer this class implements.
This method always returns ezcDbSchema::FILE

loadDiffFromFile

ezcDbSchemaDiff loadDiffFromFile( string $file )
Returns the database differences stored in the XML file $file

Parameters

Name Type Description
$file string  

Throws

ClassDescription
ezcBaseFileNotFoundException if the file $file could not be found.
ezcDbSchemaInvalidSchemaException if the XML in the $file is corrupt or when the file could not be opened.

loadFromFile

ezcDbSchema loadFromFile( string $file )
Returns the database schema stored in the XML file $file

Parameters

Name Type Description
$file string  

Throws

ClassDescription
ezcBaseFileNotFoundException if the file $file could not be found.
ezcDbSchemaInvalidSchemaException if the XML in the $file is corrupt or when the file could not be opened.

Last updated: Mon, 11 May 2009