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

Public Member Functions

 __construct ($filterGroup)
 
 _getControlledVocabulariesMappings ()
 
 _getLocalizedPublicationFields ()
 
 getClassName ()
 
 getImportFilter ($elementName)
 
 getPluralElementName ()
 
 getRepresentationExportFilterGroupName ()
 
 getSingularElementName ()
 
 handleChildElement ($n, $publication)
 
 handleElement ($node)
 
 parseAuthor ($n, $publication)
 
 parseAuthors ($node, $publication)
 
 parseCitations ($n, $publication)
 
 parseIdentifier ($element, $publication)
 
 populateObject ($publication, $node)
 
- 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 publications.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlPKPPublicationFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ _getControlledVocabulariesMappings()

NativeXmlPKPPublicationFilter::_getControlledVocabulariesMappings ( )

Get node name to DAO and insert function mapping.

Returns
array

Definition at line 277 of file NativeXmlPKPPublicationFilter.inc.php.

Referenced by handleChildElement().

◆ _getLocalizedPublicationFields()

NativeXmlPKPPublicationFilter::_getLocalizedPublicationFields ( )

Get node name to setter function mapping for localized data.

Returns
array

Definition at line 259 of file NativeXmlPKPPublicationFilter.inc.php.

Referenced by handleChildElement().

◆ getClassName()

NativeXmlPKPPublicationFilter::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 NativeXmlPublicationFilter.

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

◆ getImportFilter()

NativeXmlPKPPublicationFilter::getImportFilter (   $elementName)

Get the import filter for a given element.

Parameters
$elementNamestring Name of XML element
Returns
Filter

Reimplemented in NativeXmlPublicationFilter.

Definition at line 299 of file NativeXmlPKPPublicationFilter.inc.php.

◆ getPluralElementName()

NativeXmlPKPPublicationFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 47 of file NativeXmlPKPPublicationFilter.inc.php.

◆ getRepresentationExportFilterGroupName()

NativeXmlPKPPublicationFilter::getRepresentationExportFilterGroupName ( )

Get the representation export filter group name

Returns
string

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

◆ getSingularElementName()

NativeXmlPKPPublicationFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 55 of file NativeXmlPKPPublicationFilter.inc.php.

◆ handleChildElement()

NativeXmlPKPPublicationFilter::handleChildElement (   $n,
  $publication 
)

◆ handleElement()

NativeXmlPKPPublicationFilter::handleElement (   $node)

Handle a singular element import.

Parameters
$nodeDOMElement

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlPublicationFilter.

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

References PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), handleChildElement(), and populateObject().

◆ parseAuthor()

NativeXmlPKPPublicationFilter::parseAuthor (   $n,
  $publication 
)

Parse an author and add it to the submission.

Parameters
$nDOMElement
$publicationPublication

Definition at line 229 of file NativeXmlPKPPublicationFilter.inc.php.

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

Referenced by parseAuthors().

◆ parseAuthors()

NativeXmlPKPPublicationFilter::parseAuthors (   $node,
  $publication 
)

Parse an authors element

Parameters
$nodeDOMElement
$publicationPKPPublication

Definition at line 215 of file NativeXmlPKPPublicationFilter.inc.php.

References parseAuthor().

Referenced by handleChildElement().

◆ parseCitations()

NativeXmlPKPPublicationFilter::parseCitations (   $n,
  $publication 
)

Parse a publication citation and add it to the publication.

Parameters
$nDOMElement
$publicationPKPPublication

Definition at line 245 of file NativeXmlPKPPublicationFilter.inc.php.

References DAORegistry\getDAO().

Referenced by handleChildElement().

◆ parseIdentifier()

NativeXmlPKPPublicationFilter::parseIdentifier (   $element,
  $publication 
)

Parse an identifier node and set up the publication object accordingly

Parameters
$elementDOMElement
$publicationPKPPublication

Definition at line 182 of file NativeXmlPKPPublicationFilter.inc.php.

References NativeImportExportFilter\getDeployment(), and PluginRegistry\loadCategory().

Referenced by handleChildElement().

◆ populateObject()

NativeXmlPKPPublicationFilter::populateObject (   $publication,
  $node 
)

Populate the entity object from the node

Parameters
$publicationPKPPublication
$nodeDOMElement
Returns
PKPPublication

Reimplemented in NativeXmlPublicationFilter.

Definition at line 110 of file NativeXmlPKPPublicationFilter.inc.php.

Referenced by handleElement().


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