Documentation

ParseEpdManager implements ParseDatabaseInterface

FinalYes

Class ParseEpdManager An EPD entry describes a promoter. It borrows the two character tag layout of EMBL, but its fields carry different things, so this class exposes plain scalars rather than the Sequence/Feature entities of ParseDbAbstractManager. The three dated events the format defines are all read here, where the original BioPHP parser had commented two of them out.

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Interfaces

ParseDatabaseInterface
Interface ParseDatabaseInterface

Properties

$accessions  : array<string|int, mixed>
$comments  : string
$createDate  : string
$createRel  : string
$dataClass  : string
$description  : string
$entryName  : string
$insiteType  : string
$notupdDate  : string
$notupdRel  : string
$sequpdDate  : string
$sequpdRel  : string
$taxDiv  : string

Methods

__construct()  : mixed
Constructor.
getAccessions()  : array<string|int, mixed>
getComments()  : string
getCreateDate()  : string
getCreateRel()  : string
getDataClass()  : string
getDescription()  : string
getEntryId()  : string
Extracts the identifier uniquely naming an EPD entry, read from its AC line.
getEntryName()  : string
getFormat()  : string
The name this format is known by in the collection records and in DatabaseParserFactory.
getInsiteType()  : string
getNotupdDate()  : string
getNotupdRel()  : string
getSequpdDate()  : string
getSequpdRel()  : string
getTaxDiv()  : string
isEntryEnd()  : bool
Tells whether a line closes an EPD entry.
isEntryStart()  : bool
Tells whether a line opens a new EPD entry.
parseDataFile()  : Sequence
Parses an EPD data file and populates this manager's fields.
parseDate()  : void
Reads a DT line, which dates one event and names the release it happened in.
parseIdentifier()  : void
Reads the ID line, which names the entry then qualifies it.

Properties

Methods

getAccessions()

public getAccessions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCreateDate()

public getCreateDate() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getEntryId()

Extracts the identifier uniquely naming an EPD entry, read from its AC line.

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
string

getFormat()

The name this format is known by in the collection records and in DatabaseParserFactory.

public static getFormat() : string
Return values
string

getInsiteType()

public getInsiteType() : string
Return values
string

getNotupdDate()

public getNotupdDate() : string
Return values
string

getSequpdDate()

public getSequpdDate() : string
Return values
string

isEntryEnd()

Tells whether a line closes an EPD entry.

public static isEntryEnd(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

isEntryStart()

Tells whether a line opens a new EPD entry.

public static isEntryStart(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

parseDataFile()

Parses an EPD data file 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
throws
Exception
Return values
Sequence

$oSequence

parseDate()

Reads a DT line, which dates one event and names the release it happened in.

private parseDate(string $sData) : void

Example: DT 15-JUN-2001 (REL. 75, CREATED)

Parameters
$sData : string

The DT line, tag stripped

parseIdentifier()

Reads the ID line, which names the entry then qualifies it.

private parseIdentifier(string $sData) : void

Example: ID HS_ACHA_1 standard; single; HUM.

Parameters
$sData : string

The ID line, tag stripped

On this page

Search results