Inheritance diagram for PKPUserUserXmlFilter:

Public Member Functions
	__construct ($filterGroup)

	addUserGroups ($doc, $rootNode)

	createPKPUserNode ($doc, $user)

	getClassName ()

&	process (&$users)

Public Member Functions inherited from NativeExportFilter
	createLocalizedNodes ($doc, $parentNode, $name, $values)

	createOptionalNode ($doc, $parentNode, $name, $value)

	getNoValidation ()

	setNoValidation ($noValidation)

	setOpts ($opts)

	supports (&$input, &$output)

Public Member Functions inherited from NativeImportExportFilter
	getDeployment ()

	setDeployment ($deployment)

Public Member Functions inherited from PersistableFilter
	addSetting ($setting)

	getFilterGroup ()

	getInternalSettings ()

	getIsTemplate ()

	getLocalizedSettingNames ()

	getParentFilterId ()

	getSetting ($settingName)

	getSettingNames ()

&	getSettings ()

	hasSetting ($settingName)

	hasSettings ()

	setIsTemplate ($isTemplate)

	setParentFilterId ($parentFilterId)

Public Member Functions inherited from Filter
	__construct ($inputType, $outputType)

	addError ($message)

	clearErrors ()

&	execute (&$input, $returnErrors=false)

	getDisplayName ()

	getErrors ()

&	getInputType ()

&	getLastInput ()

&	getLastOutput ()

&	getOutputType ()

&	getRuntimeEnvironment ()

	getSequence ()

	hasErrors ()

	isCompatibleWithRuntimeEnvironment ()

	setDisplayName ($displayName)

	setRuntimeEnvironment (&$runtimeEnvironment)

	setSequence ($seq)

	setTransformationType (&$inputType, &$outputType)

	supportsAsInput (&$input)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	getMetadataFieldNames ($translated=true)

	getSetMetadataFieldNames ($translated=true)

	getSupportedExtractionAdapters ()

	getSupportedInjectionAdapters ()

	getSupportedMetadataSchemas ()

	hasData ($key, $locale=null)

	injectMetadata ($metadataDescription)

	removeSupportedMetadataAdapter ($metadataSchemaName)

	setAllData (&$data)

	setData ($key, $value, $locale=null)

	setHasLoadableAdapters ($hasLoadableAdapters)

	setId ($id)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Additional Inherited Members
Static Public Member Functions inherited from PersistableFilter
static	tempGroup ($inputType, $outputType)

Static Public Member Functions inherited from Filter
static	supportedRuntimeEnvironmentSettings ()

Data Fields inherited from NativeExportFilter
	$_noValidation = null

	$opts = array()

Data Fields inherited from NativeImportExportFilter
	$_deployment

Data Fields inherited from PersistableFilter
	$_filterGroup

	$_settings = array()

Data Fields inherited from Filter
	$_errors = array()

	$_input

	$_inputType

	$_output

	$_outputType

	$_runtimeEnvironment = false

Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

Base class that converts a set of users to a User XML document.

Definition at line 18 of file PKPUserUserXmlFilter.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPUserUserXmlFilter::__construct ( $filterGroup )

Constructor

Parameters

$filterGroup FilterGroup

Reimplemented from NativeExportFilter.

Definition at line 23 of file PKPUserUserXmlFilter.inc.php.

References Filter\setDisplayName().

Member Function Documentation

◆ addUserGroups()

PKPUserUserXmlFilter::addUserGroups	(	$doc,
		$rootNode
	)

Definition at line 148 of file PKPUserUserXmlFilter.inc.php.

References DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

Referenced by process().

◆ createPKPUserNode()

PKPUserUserXmlFilter::createPKPUserNode	(	$doc,
		$user
	)

Create and return a user node.

Parameters

$doc	DOMDocument
$user	User

Returns: DOMElement

Definition at line 78 of file PKPUserUserXmlFilter.inc.php.

References NativeExportFilter\createLocalizedNodes(), NativeExportFilter\createOptionalNode(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and Config\getVar().

Referenced by process().

◆ getClassName()

PKPUserUserXmlFilter::getClassName ( )

Return the fully qualified class name of the filter class. This information must be persisted when saving a filter so that the filter can later be reconstructed from the information in the database.

(This must be hard coded by sub-classes for PHP4 compatibility. PHP4 always returns class names lowercase which we cannot tolerate as we need this path to find the class on case sensitive file systems.)

Reimplemented from PersistableFilter.

Definition at line 35 of file PKPUserUserXmlFilter.inc.php.