Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Nlm30PersonStringFilter Class Reference
Inheritance diagram for Nlm30PersonStringFilter:
Filter DataObject Nlm30NameSchemaPersonStringFilter PersonStringNlm30NameSchemaFilter

Public Member Functions

 getFilterMode ()
 
 Nlm30PersonStringFilter ($inputType, $outputType, $filterMode=PERSON_STRING_FILTER_SINGLE)
 
removeEtAlEntries ($personDescriptions)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supportedRuntimeEnvironmentSettings ()
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Filter that converts from a string to an (array of) NLM name description(s).

See Also
Nlm30NameSchema

Definition at line 28 of file Nlm30PersonStringFilter.inc.php.

Member Function Documentation

Nlm30PersonStringFilter::getFilterMode ( )
Nlm30PersonStringFilter::Nlm30PersonStringFilter (   $inputType,
  $outputType,
  $filterMode = PERSON_STRING_FILTER_SINGLE 
)

Constructor

Parameters
$inputTypestring
$outputTypestring
$filterModeinteger one of the PERSON_STRING_FILTER_* constants

Definition at line 38 of file Nlm30PersonStringFilter.inc.php.

& Nlm30PersonStringFilter::removeEtAlEntries (   $personDescriptions)

Remove et-al entries from input/output which are valid but do not conform to the canonical transformation type definition.

Parameters
$personDescriptionsmixed
Returns
mixed false if more than one et-al string was found otherwise the filtered person description list.

NB: We cannot pass person descriptions by reference otherwise we'd alter our data.

Definition at line 69 of file Nlm30PersonStringFilter.inc.php.

References getFilterMode().

Referenced by Nlm30NameSchemaPersonStringFilter\supports(), and PersonStringNlm30NameSchemaFilter\supports().


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