Open Journal Systems  3.3.0
NativeExportFilter Class Reference
Inheritance diagram for NativeExportFilter:
NativeImportExportFilter PersistableFilter Filter DataObject DataciteXmlFilter DOAJXmlFilter IssueCrossrefXmlFilter IssueGalleyNativeXmlFilter IssueNativeXmlFilter O4DOIXmlFilter PKPAuthorNativeXmlFilter PKPPublicationNativeXmlFilter PKPUserUserXmlFilter RepresentationNativeXmlFilter SubmissionFileNativeXmlFilter SubmissionNativeXmlFilter UserGroupNativeXmlFilter

Public Member Functions

 __construct ($filterGroup)
 
 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)
 
 getClassName ()
 
 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 ()
 
process (&$input)
 
 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)
 

Data Fields

 $_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()
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 

Detailed Description

Base class that converts a DataObject to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createLocalizedNodes()

NativeExportFilter::createLocalizedNodes (   $doc,
  $parentNode,
  $name,
  $values 
)

◆ createOptionalNode()

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

Create an optional node with a name and value.

Parameters
$docDOMDocument
$parentNodeDOMElement
$namestring
$valuestring|null
Returns
DOMElement|null

Definition at line 106 of file NativeExportFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by PKPAuthorNativeXmlFilter\createPKPAuthorNode(), and PKPUserUserXmlFilter\createPKPUserNode().

◆ getNoValidation()

NativeExportFilter::getNoValidation ( )

Get no validation option

Returns
boolean true|null

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

References $_noValidation.

Referenced by supports().

◆ setNoValidation()

NativeExportFilter::setNoValidation (   $noValidation)

Set no validation option

Parameters
$noValidationboolean

Definition at line 39 of file NativeExportFilter.inc.php.

◆ setOpts()

NativeExportFilter::setOpts (   $opts)

Set xml filtering opts

Parameters
$optsarray

Definition at line 118 of file NativeExportFilter.inc.php.

References $opts.

◆ supports()

NativeExportFilter::supports ( $input,
$output 
)

Returns true if the given input and output objects represent a valid transformation for this filter.

This check must be type based. It can optionally include an additional stateful inspection of the given object instances.

If the output type is null then only check whether the given input type is one of the input types accepted by this filter.

The standard implementation provides full type based checking. Subclasses must implement any required stateful inspection of the provided objects.

Parameters
$inputmixed
$outputmixed
Returns
boolean

Reimplemented from Filter.

Definition at line 57 of file NativeExportFilter.inc.php.

References Filter\getInputType(), getNoValidation(), and Filter\getOutputType().

Field Documentation

◆ $_noValidation

boolean NativeExportFilter::$_noValidation = null

If set to true no validation (e.g. XML validation) will be done

Definition at line 24 of file NativeExportFilter.inc.php.

Referenced by getNoValidation().

◆ $opts

NativeExportFilter::$opts = array()

Definition at line 25 of file NativeExportFilter.inc.php.

Referenced by setOpts().


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