\
Amelaye
BioPHP
Api
DTO
Interfaces
DependencyInjection
Domain
Database
Entity
Factory
Interfaces
Service
Parser
Entity
Interfaces
Service
Sequence
Builder
Entity
Interfaces
Service
Traits
ValueObject
Tools
Interfaces
Service

\Amelaye\BioPHP\Domain\Parser\Service ParseTransfacGeneManager

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

Summary

Methods
Properties
Constants
getFormat
parseDataFile
getShortDescription
getDescription
getOrganism
getSpecies
getTaxClass
getCompelAccessions
__construct
isEntryStart
isEntryEnd
getEntryId
getAccession
getId
getDateCreated
getDateUpdated
No public properties found
No public constants found
readLabel
readData
parseCommonField
parseDate
append
splitList
accession
id
dateCreated
dateUpdated
No protected constants found
parseOrganism
shortDescription
description
organism
species
taxClass
compelAccessions
sTaxonomy
No private constants found

Properties

$accession

$accession : string

Type

string —

$id

$id : string

Type

string —

$dateCreated

$dateCreated : string

Type

string —

$dateUpdated

$dateUpdated : string

Type

string —

$shortDescription

$shortDescription : string

Type

string —

$description

$description : string

Type

string —

$organism

$organism : string

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

Type

string —

$species

$species : string

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

Type

string —

$taxClass

$taxClass : array

Type

array<string|int, mixed> —

$compelAccessions

$compelAccessions : array

Type

array<string|int, mixed> —

$sTaxonomy

$sTaxonomy : string

Type

string —

Methods

getFormat()

getFormat() : string

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

Returns

string —

parseDataFile()

parseDataFile(array  $aFlines) : \Amelaye\BioPHP\Domain\Sequence\Entity\Sequence

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

Parameters

array $aFlines

The lines the script has to parse

Throws

\Exception

Returns

\Amelaye\BioPHP\Domain\Sequence\Entity\Sequence —

$oSequence

getShortDescription()

getShortDescription() : string

Returns

string —

getDescription()

getDescription() : string

Returns

string —

getOrganism()

getOrganism() : string

Returns

string —

getSpecies()

getSpecies() : string

Returns

string —

getTaxClass()

getTaxClass() : array

Returns

array —

getCompelAccessions()

getCompelAccessions() : array

Returns

array —

__construct()

__construct() : mixed

Constructor.

Returns

mixed —

isEntryStart()

isEntryStart(string  $sLine) : bool

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

Parameters

string $sLine

The line to analyze

Returns

bool —

isEntryEnd()

isEntryEnd(string  $sLine) : bool

Tells whether a line closes a TRANSFAC record.

Parameters

string $sLine

The line to analyze

Returns

bool —

getEntryId()

getEntryId(array  $aFlines, string  $sLine) : string

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

Parameters

array $aFlines

The whole file, buffered
string $sLine

The line opening the entry

Returns

string —

getAccession()

getAccession() : string

Returns

string —

getId()

getId() : string

Returns

string —

getDateCreated()

getDateCreated() : string

Returns

string —

getDateUpdated()

getDateUpdated() : string

Returns

string —

readLabel()

readLabel(string  $sLine) : string

Reads the two-letter label a line carries.

Parameters

string $sLine

The line to analyze

Returns

string —

readData()

readData(string  $sLine) : string

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

Parameters

string $sLine

The line to analyze

Returns

string —

parseCommonField()

parseCommonField(string  $sLabel, string  $sData) : 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.

Parameters

string $sLabel
string $sData

Returns

bool —

parseDate()

parseDate(string  $sData) : mixed

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

Format : DT 20.06.90 11:00:03 (created); ewi.

Parameters

string $sData

Returns

mixed —

append()

append(string  $sBuffer, string  $sData) : string

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

Parameters

string $sBuffer
string $sData

Returns

string —

splitList()

splitList(string  $sText, string  $sSeparator = ";") : array

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

Parameters

string $sText
string $sSeparator

Returns

array —

parseOrganism()

parseOrganism(string  $sData) : mixed

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

Format : OS human, homo sapiens

Parameters

string $sData

Returns

mixed —