PHP Class PersonStringNlm30NameSchemaFilter, pkp-lib

Inheritance: extends Nlm30PersonStringFilter

Public Properties

Method	Description
__construct ( $assocType, $filterMode = PERSON_STRING_FILTER_SINGLE, $filterTitle = false, $filterDegrees = false )	Constructor
_parsePersonString ( $personString, $title, $degrees ) : MetadataDescription	Converts a string with a single person to an NLM name description.
_parsePersonsString ( $personsString, $title, $degrees ) : array	Converts a string with multiple persons to an array of NLM name descriptions.
getAssocType ( ) : integer	Get the association type
getFilterDegrees ( ) : boolean	Do we parse for degrees?
getFilterTitle ( ) : boolean	Do we parse for a title?
process ( &$input ) : mixed	Transform a person string to an (array of) NLM name description(s).
setFilterDegrees ( $filterDegrees )	Set whether we parse for degrees
setFilterTitle ( $filterTitle )	Set whether we parse for a title
supports ( &$input, &$output )

Constructor

public __construct ( $assocType, $filterMode = PERSON_STRING_FILTER_SINGLE, $filterTitle = false, $filterDegrees = false )

TODO: add initials from all given names to initials element

public _parsePersonString ( $personString, $title, $degrees ) : MetadataDescription
$personString		string
$title		boolean true to parse for title
$degrees		boolean true to parse for degrees
return	MetadataDescription	an NLM name description or null if the string could not be converted

Converts a string with multiple persons to an array of NLM name descriptions.

public _parsePersonsString ( $personsString, $title, $degrees ) : array
$personsString		string
$title		boolean true to parse for title
$degrees		boolean true to parse for degrees
return	array	an array of NLM name descriptions or null if the string could not be converted plus optionally a single 'et-al' string.

Get the association type

public getAssocType ( ) : integer
return	integer

Do we parse for degrees?

public getFilterDegrees ( ) : boolean
return	boolean

Do we parse for a title?

public getFilterTitle ( ) : boolean
return	boolean

Transform a person string to an (array of) NLM name description(s).

Set whether we parse for degrees

public setFilterDegrees ( $filterDegrees )
$filterDegrees		boolean

Set whether we parse for a title

public setFilterTitle ( $filterTitle )
$filterTitle		boolean

public supports ( &$input, &$output )

public int $_assocType
return	integer

public bool $_filterDegrees
return	boolean

public bool $_filterTitle
return	boolean

public process ( &$input ) : mixed
$input		string
return	mixed	Either a MetadataDescription or an array of MetadataDescriptions plus optionally a single 'et-al' string.