Handles content objects in the package system. More...

Inheritance diagram for eZContentObjectPackageHandler:

Collaboration diagram for eZContentObjectPackageHandler:

Public Member Functions
	add ($packageType, $package, $cli, $parameters)
	addNode ($nodeID, $isSubtree=true)
	contentObjectDirectory ()
	explainInstallItem ($package, $installItem, $requestedInfo=array())
	eZContentObjectPackageHandler ()
	fetchObjectFromFile ($objectFileNode)
	generatePackage ($package, $options)
	getRealObjectNode ($objectNode)
	handleAddParameters ($packageType, $package, $cli, $arguments)
	install ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
	uninstall ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
Static Public Member Functions
static	createArrayFromDOMNode ($domNode)
static	createElementNodeFromArray ($name, $array)
Public Attributes
	$NodeIDArray = array()
	$NodeObjectArray = array()
	$ObjectArray = array()
	$OverrideClassRemoteID = 'content_class_remote_id'
	$OverrideNodeRemoteID = 'content_node_remote_id'
	$OverrideObjectRemoteID = 'content_object_remote_id'
	$OverrideParentNodeRemoteID = 'parent_content_node_remote_id'
	$OverrideSettingsArray = array()
	$Package = null
	$RootNodeIDArray = array()
	$RootNodeObjectArray = array()
	$TemplateFileArray = array()
const	INSTALL_OBJECTS_ERROR_RANGE_FROM = 1
const	INSTALL_OBJECTS_ERROR_RANGE_TO = 100
const	MAX_LISTED_OBJECTS = 30
const	STORE_OBJECTS_TO_SEPARATE_FILES_THRESHOLD = 100
const	UNINSTALL_OBJECTS_ERROR_RANGE_FROM = 101
const	UNINSTALL_OBJECTS_ERROR_RANGE_TO = 200
Private Member Functions
	createDOMNodeFromFile ($filename, $siteAccess, $filetype=false)
	createObjectListNode ($options)
	createSiteAccessListNode ($options)
	createTopNodeListDOMNode ($options)
&	generateClassIDArray ()
&	generateFetchAliasArray ()
	generateObjectArray ($nodeAssignment)
&	generateOverrideSettingsArray ($siteAccessArray, $minimalTemplateSet)
&	generateTemplateFilenameArray ()
	handleParameters ($packageType, $package, $cli, $type, $arguments)
	installContentObjects ($objectNodes, $topNodeListNode, &$installParameters)
	installFetchAliases ($fetchAliasListNode, &$parameters)
	installOverrides ($overrideListNode, &$parameters)
	installSuspendedNodeAssignment (&$installParameters)
	installSuspendedObjectRelations (&$installParameters)
	installTemplates ($templateList, $package, $subdirectory, &$installParameters)

Detailed Description

Handles content objects in the package system.

Definition at line 40 of file ezcontentobjectpackagehandler.php.

Member Function Documentation

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

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

Implements eZPackageHandler.

Definition at line 1455 of file ezcontentobjectpackagehandler.php.

eZContentObjectPackageHandler::addNode	(	$	nodeID,
		$	isSubtree = `true`
	)

Add Node list to ezcontentobject package handler.

Parameters:

nodeID	node id
isSubtree	subtree (optional, default true )

Definition at line 197 of file ezcontentobjectpackagehandler.php.

Referenced by add().

eZContentObjectPackageHandler::contentObjectDirectory ( )

Definition at line 1674 of file ezcontentobjectpackagehandler.php.

Referenced by createDOMNodeFromFile(), createObjectListNode(), fetchObjectFromFile(), and generatePackage().

static eZContentObjectPackageHandler::createArrayFromDOMNode ( $ domNode ) [static]

Creates recursive array from DOMNodeElement

Definition at line 1726 of file ezcontentobjectpackagehandler.php.

Referenced by installFetchAliases(), and installOverrides().

eZContentObjectPackageHandler::createDOMNodeFromFile	(	$	filename,
		$	siteAccess,
		$	filetype = `false`
	)		`[private]`

Add file to repository and return DONNode description of file

Parameters:

filename
siteAccess
filetype	(optional)

Definition at line 560 of file ezcontentobjectpackagehandler.php.

Referenced by generateTemplateFilenameArray().

static eZContentObjectPackageHandler::createElementNodeFromArray	(	$	name,
		$	array
	)		`[static]`

Creates DOMNodeElement recursivly from recursive array

Definition at line 1683 of file ezcontentobjectpackagehandler.php.

Referenced by generateFetchAliasArray(), and generateOverrideSettingsArray().

eZContentObjectPackageHandler::createObjectListNode ( $ options ) [private]

Serializes and adds all contentobjects to package

Parameters:

options

Definition at line 344 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::createSiteAccessListNode ( $ options ) [private]

Create DOMNode for list of added siteaccesses.

Parameters:

options

Definition at line 321 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::createTopNodeListDOMNode ( $ options ) [private]

Create DOMNode for list of top nodes.

Parameters:

options

Definition at line 296 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::explainInstallItem	(	$	package,
		$	installItem,
		$	requestedInfo = `array()`
	)		`[virtual]`

Returns an explanation for the content object install item.

The explanaition is actually a list having the following structure: array( array( 'description' => 'Content object Foo' ), array( 'description' => 'Content object Bar' ), array( 'description' => 'Content object Baz' ) );

When number of items in the above list is too high, the following array is returned instead: array( 'description' => 'NNN content objects' );

Implements eZPackageHandler.

Definition at line 112 of file ezcontentobjectpackagehandler.php.

eZContentObjectPackageHandler::eZContentObjectPackageHandler ( )

Constructor

Definition at line 57 of file ezcontentobjectpackagehandler.php.

eZContentObjectPackageHandler::fetchObjectFromFile ( $ objectFileNode )

Fetches object stored in separate xml file

Definition at line 66 of file ezcontentobjectpackagehandler.php.

Referenced by explainInstallItem(), and getRealObjectNode().

& eZContentObjectPackageHandler::generateClassIDArray ( ) [private]

Get list of all class objects used in by the nodes in NodeArray

Definition at line 825 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

& eZContentObjectPackageHandler::generateFetchAliasArray ( ) [private]

Definition at line 429 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::generateObjectArray ( $ nodeAssignment ) [private]

Generate list of content objects to export, and store them to

Parameters:

nodeAssignment which node assignments to include, either 'selected' or 'main'

Definition at line 408 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

& eZContentObjectPackageHandler::generateOverrideSettingsArray	(	$	siteAccessArray,
		$	minimalTemplateSet
	)		`[private]`

Get all template overrides used by exported objects

Parameters:

siteAccessArray site access array

Definition at line 594 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::generatePackage	(	$	package,
		$	options
	)

Generate package based on NodeArray and input options

Parameters:

package
options

Definition at line 218 of file ezcontentobjectpackagehandler.php.

Referenced by add().

& eZContentObjectPackageHandler::generateTemplateFilenameArray ( ) [private]

Definition at line 512 of file ezcontentobjectpackagehandler.php.

Referenced by generatePackage().

eZContentObjectPackageHandler::getRealObjectNode ( $ objectNode )

Definition at line 85 of file ezcontentobjectpackagehandler.php.

Referenced by installContentObjects(), and uninstall().

eZContentObjectPackageHandler::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 1489 of file ezcontentobjectpackagehandler.php.

eZContentObjectPackageHandler::handleParameters	(	$	packageType,
		$	package,
		$	cli,
		$	type,
		$	arguments
	)		`[private]`

Definition at line 1497 of file ezcontentobjectpackagehandler.php.

Referenced by handleAddParameters().

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

Creates a new contentobject as defined in the xml structure.

Implements eZPackageHandler.

Definition at line 966 of file ezcontentobjectpackagehandler.php.

eZContentObjectPackageHandler::installContentObjects	(	$	objectNodes,
		$	topNodeListNode,
		&$	installParameters
	)		`[private]`

Serialize and install content objects

Parameters:

objectNodes	object-list DOMNode
topNodeListNode
installParameters	install parameters

Definition at line 1028 of file ezcontentobjectpackagehandler.php.

Referenced by install().

eZContentObjectPackageHandler::installFetchAliases	(	$	fetchAliasListNode,
		&$	parameters
	)		`[private]`

Install fetch alias overrides

Parameters:

fetch	alias list
install	parameters

Definition at line 1379 of file ezcontentobjectpackagehandler.php.

Referenced by install().

eZContentObjectPackageHandler::installOverrides	(	$	overrideListNode,
		&$	parameters
	)		`[private]`

Install overrides

Parameters:

override	list
install	parameters

Definition at line 1286 of file ezcontentobjectpackagehandler.php.

Referenced by install().

eZContentObjectPackageHandler::installSuspendedNodeAssignment ( &$ installParameters ) [private]

Parameters:

install parameters

Definition at line 1117 of file ezcontentobjectpackagehandler.php.

Referenced by installContentObjects().

eZContentObjectPackageHandler::installSuspendedObjectRelations ( &$ installParameters ) [private]

Installs suspended content object relations (need for complex content-relations structure)

Parameters:

install parameters

Definition at line 1174 of file ezcontentobjectpackagehandler.php.

Referenced by installContentObjects().

eZContentObjectPackageHandler::installTemplates	(	$	templateList,
		$	package,
		$	subdirectory,
		&$	installParameters
	)		`[private]`

Set and install templates

Parameters:

template	list
package
subdirectory
install	parameters.

Definition at line 1215 of file ezcontentobjectpackagehandler.php.

Referenced by install().

eZContentObjectPackageHandler::uninstall	(	$	package,
		$	installType,
		$	parameters,
		$	name,
		$	os,
		$	filename,
		$	subdirectory,
		$	content,
		&$	installParameters,
		&$	installData
	)		`[virtual]`