Open Journal Systems  3.3.0
UserXmlPKPUserFilter Class Reference
Inheritance diagram for UserXmlPKPUserFilter:
NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 getPluralElementName ()
 
 handleChildElement ($n)
 
 handleElement ($node)
 
 importUserPasswordValidation ($userToImport, $encryption)
 
 parseUser ($node)
 
 parseUserGroup ($node)
 
- Public Member Functions inherited from NativeImportFilter
 getSingularElementName ()
 
 parseLocalizedContent ($element)
 
process (&$document)
 
- 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)
 
 supports (&$input, &$output)
 
 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 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 User XML document to a set of users.

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

Constructor & Destructor Documentation

◆ __construct()

UserXmlPKPUserFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ getClassName()

UserXmlPKPUserFilter::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 45 of file UserXmlPKPUserFilter.inc.php.

◆ getPluralElementName()

UserXmlPKPUserFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

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

◆ handleChildElement()

UserXmlPKPUserFilter::handleChildElement (   $n)

Handle an element whose parent is the submission element.

Parameters
$nDOMElement

Definition at line 290 of file UserXmlPKPUserFilter.inc.php.

References fatalError(), parseUser(), and parseUserGroup().

Referenced by handleElement().

◆ handleElement()

UserXmlPKPUserFilter::handleElement (   $node)

Handle a singular element import.

Parameters
$nodeDOMElement

Reimplemented from NativeImportFilter.

Definition at line 274 of file UserXmlPKPUserFilter.inc.php.

References NativeImportExportFilter\getDeployment(), and handleChildElement().

◆ importUserPasswordValidation()

UserXmlPKPUserFilter::importUserPasswordValidation (   $userToImport,
  $encryption 
)

Validation process for imported passwords

Parameters
$userToImportUser ByRef. The user that is being imported.
$encryptionstring null, sha1, md5 (or any other encryption algorithm defined)
Returns
string if a new password is generated, the function returns it.

Definition at line 309 of file UserXmlPKPUserFilter.inc.php.

References Filter\addError(), Validation\encryptCredentials(), Validation\generatePassword(), and DAORegistry\getDAO().

Referenced by parseUser().

◆ parseUser()

UserXmlPKPUserFilter::parseUser (   $node)

Handle a users element

Parameters
$nodeDOMElement
Returns
array Array of User objects

Definition at line 71 of file UserXmlPKPUserFilter.inc.php.

References Filter\addError(), fatalError(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and importUserPasswordValidation().

Referenced by handleChildElement().

◆ parseUserGroup()

UserXmlPKPUserFilter::parseUserGroup (   $node)

Handle a user_groups element

Parameters
$nodeDOMElement
Returns
array Array of UserGroup objects

Definition at line 54 of file UserXmlPKPUserFilter.inc.php.

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

Referenced by handleChildElement().


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