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

Class: ezcDbSchemaHandler

Base class for all schema handlers. [source]

Member Variables

protected mixed

$Params

Method Summary

public ezcDbSchemaHandler	__construct( $params ) Constructs handler object, saving given parameters in the instance.
protected static bool	checkWhat( $what ) Check if the specification of which database part (schema and/or data) to process is correct.
protected static file	fopen( $fileName, $mode ) Exception-enabled wrapper for standard fopen()
public mixed	getSchema( $schema, $internalFormat, $what ) Return schema in one of internal formats without saving it to a file or database.
public static array(string)	getSupportedInternalFormats( ) Returns the list of internal formats supported by the handler.
public array	loadSchema( $src, $storageType, $what ) Load schema from the specified source
public bool	needsSchemaTransformation( ) Check if schema transformation is required before saving it with the handler.
protected static bool	processData( $what ) Check if data should be processed by the caller.
protected static bool	processSchema( $what ) Check if schema should be processed by the caller.
protected bool	runHooks( $type, &$schema, $storageType, $what, $schema ) Run hooks of the specified type.
protected void	runPostLoadHooks( &$schema, $storageType, $what ) Run post-load hooks, callbacks for them have been specified in constructor
protected void	runPreSaveHooks( &$schema, $storageType, $what ) Run pre-save hooks, callbacks for them have been specified in constructor
public abstract bool	saveDelta( $delta, $dst, $storageType ) Save given difference between schemas to the specified destination.
public bool	saveSchema( $schema, $dst, $storageType, $what ) Save given schema to the specified destination.

Methods

__construct

Parameters

Name	Type	Description
$params

checkWhat

Parameters

Name	Type	Description
$what

fopen

Parameters

Name	Type	Description
$fileName	string	Name of the file to open.
$mode	string	Mode (identical to standard fopen()).

Throws

Class	Description
ezcDbSchemaException::GENERIC_ERROR	if an error occurs.

getSchema

Parameters

Name	Type	Description
$schema	array	Schema to return in the specified format.
$internalFormat	string	Format you want to get schema in.
$what	string	What to get. Possible values: 'none', 'schema', 'data', 'both'. Default value is 'schema'.

See also:

ezcDbSchema::get(), ezcDbSchemaHandler::getSupportedInternalFormats().

getSupportedInternalFormats

See also:

ezcDbSchema::get(), ezcDbSchemaHandler::getSchema().

loadSchema

Parameters

Name	Type	Description
$src	mixed	Where to load schema from.
$storageType	string	Schema storage type
$what	string	What to load. Possible values: 'none', 'schema', 'data', 'both'. Default value is 'schema'.

needsSchemaTransformation

processData

Parameters

Name	Type	Description
$what

processSchema

Parameters

Name	Type	Description
$what

runHooks

Parameters

Name	Type	Description
$schema	array	The schema to run hooks on.
$type
&$schema
$storageType
$what

runPostLoadHooks

Parameters

Name	Type	Description
&$schema
$storageType
$what

runPreSaveHooks

Parameters

Name	Type	Description
&$schema
$storageType
$what

saveDelta

Parameters

Name	Type	Description
$delta	array	Difference to save.
$dst	mixed	Destination to save to.
$storageType	string	Storage type to use when saving the difference.

saveSchema

Parameters

Name	Type	Description
$schema	array	Schema to save.
$dst	mixed	Destination to save to.
$storageType	string	Schema storage type.
$what	string	What to save. Possible values: 'none', 'schema', 'data', 'both'. Default value is 'schema'.