eZDBPackageHandler Class Reference

Handles SQL files in the package system. More...

Inheritance diagram for eZDBPackageHandler:

Collaboration diagram for eZDBPackageHandler:

List of all members.

Public Member Functions
	add ($packageType, $package, $cli, $parameters)
	createInstallNode ($package, $installNode, $installItem, $installType)
	eZDBPackageHandler ()
	handleAddParameters ($packageType, $package, $cli, $arguments)
	handleParameters ($packageType, $package, $cli, $type, $arguments)
	install ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
	parseInstallNode ($package, $installNode, &$installParameters, $isInstall)
	sqlDirectory ()
	sqlFileExists (&$sqlFile, &$databaseType, &$triedFiles)

---

Detailed Description

Handles SQL files in the package system.

Definition at line 40 of file ezdbpackagehandler.php.

---

Member Function Documentation

eZDBPackageHandler::add	(	$	packageType,
		$	package,
		$	cli,
		$	parameters
	)		[virtual]

Adds items defined in $parameters to the package $package.

Implements eZPackageHandler.

Definition at line 98 of file ezdbpackagehandler.php.

eZDBPackageHandler::createInstallNode	(	$	package,
		$	installNode,
		$	installItem,
		$	installType
	)		[virtual]

Fills in extra information on the install node $installNode which is specific to the current handler.

Parameters:

$package	The current package.
$installItem	Contains all variables for the install
$installType	The type of install, can be 'install' or 'uninstall'

Implements eZPackageHandler.

Definition at line 218 of file ezdbpackagehandler.php.

eZDBPackageHandler::eZDBPackageHandler

(

)

Constructor

Definition at line 45 of file ezdbpackagehandler.php.

eZDBPackageHandler::handleAddParameters	(	$	packageType,
		$	package,
		$	cli,
		$	arguments
	)		[virtual]

Called when command line parameters must be handled by the package handler. This function must return an array with values which can easily be used in the add() function.

Parameters:

$packageType	The type that was specified when using the add command, which is either the name of this handler or an alias for it.
$package	The package object.
$cli	Command line interface object, can be used to output errors etc.
$arguments	An array with string values taken from the command line after the add command.

Implements eZPackageHandler.

Definition at line 122 of file ezdbpackagehandler.php.

eZDBPackageHandler::handleParameters	(	$	packageType,
		$	package,
		$	cli,
		$	type,
		$	arguments
	)

Definition at line 127 of file ezdbpackagehandler.php.

Referenced by handleAddParameters().

eZDBPackageHandler::install	(	$	package,
		$	installType,
		$	parameters,
		$	name,
		$	os,
		$	filename,
		$	subdirectory,
		$	content,
		&$	installParameters,
		&$	installData
	)		[virtual]

Installs the package type

Implements eZPackageHandler.

Definition at line 53 of file ezdbpackagehandler.php.

eZDBPackageHandler::parseInstallNode	(	$	package,
		$	installNode,
		&$	installParameters,
		$	isInstall
	)		[virtual]

Parses the XML node $installNode and fills in extra information not handled by the package parser.

Parameters:

$package	The current package.
$installParameters	Reference to an array which must be filled with specific data for the current handler.
$isInstall	Is true if this is an install node, false if it is an uninstall node

Implements eZPackageHandler.

Definition at line 232 of file ezdbpackagehandler.php.

eZDBPackageHandler::sqlDirectory

(

)

Definition at line 213 of file ezdbpackagehandler.php.

Referenced by createInstallNode(), and install().

eZDBPackageHandler::sqlFileExists	(	&$	sqlFile,
		&$	databaseType,
		&$	triedFiles
	)

Definition at line 188 of file ezdbpackagehandler.php.

Referenced by handleParameters().

---

The documentation for this class was generated from the following file:

• ezdbpackagehandler.php