Documentation

ParseTransfacGeneManager extends ParseTransfacAbstractManager

in package

• Amelaye
• BioPHP
• Domain
• Parser

Class ParseTransfacGeneManager A gene record names a gene whose regulation TRANSFAC describes, and points at the regulatory sites and composite elements found around it.

Tags

author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Properties

$accession  : string

$dateCreated  : string

$dateUpdated  : string

$id  : string

$compelAccessions  : array<string|int, mixed>

$description  : string

$organism  : string

Common name of the organism, e.g. "human".

$shortDescription  : string

$species  : string

Scientific name of the organism, e.g. "homo sapiens".

$sTaxonomy  : string

$taxClass  : array<string|int, mixed>

Methods

__construct()  : mixed

Constructor.

getAccession()  : string

getCompelAccessions()  : array<string|int, mixed>

getDateCreated()  : string

getDateUpdated()  : string

getDescription()  : string

getEntryId()  : string

Extracts the identifier uniquely naming a TRANSFAC record, its accession number.

getFormat()  : string

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

getId()  : string

getOrganism()  : string

getShortDescription()  : string

getSpecies()  : string

getTaxClass()  : array<string|int, mixed>

isEntryEnd()  : bool

Tells whether a line closes a TRANSFAC record.

isEntryStart()  : bool

Tells whether a line opens a new TRANSFAC record, which the accession number does.

parseDataFile()  : Sequence

Parses a TRANSFAC gene data file and populates this manager's fields.

append()  : string

Appends the data of a line to a field written over several of them.

parseCommonField()  : bool

Reads the fields every TRANSFAC record carries, and says whether it did : a subclass calls this first and only looks at the labels of its own record when it did not.

parseDate()  : mixed

Parses one DT line, which dates either the creation or the last update of the record and may carry a time of day.

readData()  : string

Reads the data a line carries, which starts at its fifth column.

readLabel()  : string

Reads the two-letter label a line carries.

splitList()  : array<string|int, mixed>

Splits a field listing its values, semicolon separated and possibly closed by a period, into its items.

parseOrganism()  : mixed

Parses the OS line, which names the organism twice : commonly, then scientifically.