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

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 parseIdentifier ($element, $author)
 
- Public Member Functions inherited from NativeImportFilter
 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 Native XML document to a set of authors.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlPKPAuthorFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlAuthorFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ getClassName()

NativeXmlPKPAuthorFilter::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.

Reimplemented in NativeXmlAuthorFilter.

Definition at line 53 of file NativeXmlPKPAuthorFilter.inc.php.

◆ getPluralElementName()

NativeXmlPKPAuthorFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

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

◆ getSingularElementName()

NativeXmlPKPAuthorFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 43 of file NativeXmlPKPAuthorFilter.inc.php.

◆ handleElement()

NativeXmlPKPAuthorFilter::handleElement (   $node)

Handle an author element

Parameters
$nodeDOMElement
Returns
PKPAuthor

Reimplemented from NativeImportFilter.

Definition at line 63 of file NativeXmlPKPAuthorFilter.inc.php.

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

◆ parseIdentifier()

NativeXmlPKPAuthorFilter::parseIdentifier (   $element,
  $author 
)

Parse an identifier node

Parameters
$elementDOMElement
$authorPKPAuthor

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

References NativeImportExportFilter\getDeployment().


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