Documentation

ParseTransfacClassManager extends ParseTransfacAbstractManager

FinalYes

Class ParseTransfacClassManager A class record describes a structural family of transcription factors - zinc fingers, leucine zippers, helix-turn-helix - and lists the factors belonging to it.

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Properties

$accession  : string
$dateCreated  : string
$dateUpdated  : string
$id  : string
$classification  : array<string|int, mixed>
The classification, from the broadest level down to the narrowest.
$comments  : string
$memberFactors  : array<string|int, mixed>
$sClass  : string
$structuralDescription  : string

Methods

__construct()  : mixed
Constructor.
getAccession()  : string
getClassification()  : array<string|int, mixed>
getComments()  : string
getDateCreated()  : string
getDateUpdated()  : 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
getMemberFactors()  : array<string|int, mixed>
getStructuralDescription()  : string
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 class 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.

Properties

$classification

The classification, from the broadest level down to the narrowest.

private array<string|int, mixed> $classification = []

Methods

getClassification()

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

getEntryId()

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

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

getMemberFactors()

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

isEntryEnd()

Tells whether a line closes a TRANSFAC record.

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

The line to analyze

Return values
bool

isEntryStart()

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

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

The line to analyze

Return values
bool

parseDataFile()

Parses a TRANSFAC class 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

append()

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

protected append(string $sBuffer, string $sData) : string
Parameters
$sBuffer : string
$sData : string
Return values
string

parseCommonField()

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.

protected parseCommonField(string $sLabel, string $sData) : bool
Parameters
$sLabel : string
$sData : string
Return values
bool

parseDate()

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

protected parseDate(string $sData) : mixed

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

Parameters
$sData : string

readData()

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

protected static readData(string $sLine) : string
Parameters
$sLine : string

The line to analyze

Return values
string

readLabel()

Reads the two-letter label a line carries.

protected static readLabel(string $sLine) : string
Parameters
$sLine : string

The line to analyze

Return values
string

splitList()

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

protected splitList(string $sText[, string $sSeparator = ";" ]) : array<string|int, mixed>
Parameters
$sText : string
$sSeparator : string = ";"
Return values
array<string|int, mixed>
On this page

Search results