ParseNcbiLitManager
in package
implements
ParseDatabaseInterface
Class ParseNcbiLitManager The NCBI journal list describes periodicals, not sequences, so this class exposes plain scalars rather than the Sequence/Feature entities of ParseDbAbstractManager. It is the only format the library reads whose fields are "Label: value" pairs and whose entries are closed by a row of dashes rather than a double slash.
Tags
Table of Contents
Interfaces
- ParseDatabaseInterface
- Interface ParseDatabaseInterface
Properties
- $essn : string
- $id : string
- $isoAbbr : string
- $issn : string
- $medAbbr : string
- $nlmId : string
- $title : string
Methods
- __construct() : mixed
- Constructor.
- getEntryId() : string
- Extracts the identifier uniquely naming a journal entry.
- getEssn() : string
- getFormat() : string
- The name this format is known by in the collection records and in DatabaseParserFactory.
- getId() : string
- getIsoAbbr() : string
- getIssn() : string
- getMedAbbr() : string
- getNlmId() : string
- getTitle() : string
- isEntryEnd() : bool
- Tells whether a line closes a journal entry. The NCBI list separates its records with a row of dashes.
- isEntryStart() : bool
- Tells whether a line opens a new journal entry.
- parseDataFile() : Sequence
- Parses an NCBI journal list and populates this manager's fields.
Properties
$essn
private
string
$essn
= ""
$id
private
string
$id
= ""
$isoAbbr
private
string
$isoAbbr
= ""
$issn
private
string
$issn
= ""
$medAbbr
private
string
$medAbbr
= ""
$nlmId
private
string
$nlmId
= ""
$title
private
string
$title
= ""
Methods
__construct()
Constructor.
public
__construct() : mixed
getEntryId()
Extracts the identifier uniquely naming a journal entry.
public
static getEntryId(array<string|int, mixed> $aFlines, string $sLine) : string
Parameters
- $aFlines : array<string|int, mixed>
-
The whole file, buffered
- $sLine : string
-
The line opening the entry
Return values
stringgetEssn()
public
getEssn() : string
Return values
stringgetFormat()
The name this format is known by in the collection records and in DatabaseParserFactory.
public
static getFormat() : string
Return values
stringgetId()
public
getId() : string
Return values
stringgetIsoAbbr()
public
getIsoAbbr() : string
Return values
stringgetIssn()
public
getIssn() : string
Return values
stringgetMedAbbr()
public
getMedAbbr() : string
Return values
stringgetNlmId()
public
getNlmId() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringisEntryEnd()
Tells whether a line closes a journal entry. The NCBI list separates its records with a row of dashes.
public
static isEntryEnd(string $sLine) : bool
Parameters
- $sLine : string
-
The line to analyze
Return values
boolisEntryStart()
Tells whether a line opens a new journal entry.
public
static isEntryStart(string $sLine) : bool
Parameters
- $sLine : string
-
The line to analyze
Return values
boolparseDataFile()
Parses an NCBI journal list and populates this manager's fields.
public
parseDataFile(array<string|int, mixed> $aFlines) : Sequence
Parameters
- $aFlines : array<string|int, mixed>
-
The lines the script has to parse
Tags
Return values
Sequence —$oSequence