ParseKeggEnzymeManager
extends ParseKeggAbstractManager
in package
Class ParseKeggEnzymeManager An enzyme record gathers what KEGG knows of one EC number : the reaction it catalyses, what it consumes and produces, the genes coding for it and the diseases a defect in it causes.
Tags
Table of Contents
Properties
- $entry : string
- $names : array<string|int, mixed>
- $classification : array<string|int, mixed>
- $comment : string
- $dbLinks : array<string|int, mixed>
- $diseases : array<string|int, mixed>
- $genes : array<string|int, mixed>
- $motifs : array<string|int, mixed>
- $orthologs : array<string|int, mixed>
- $pathways : array<string|int, mixed>
- $products : array<string|int, mixed>
- $reactions : array<string|int, mixed>
- $structures : array<string|int, mixed>
- $substrates : array<string|int, mixed>
- $sysname : string
- The systematic name, which spells out the chemistry the enzyme performs.
Methods
- __construct() : mixed
- Constructor.
- getClassification() : array<string|int, mixed>
- getComment() : string
- getDbLinks() : array<string|int, mixed>
- getDiseases() : array<string|int, mixed>
- getEntry() : string
- getEntryId() : string
- Extracts the identifier uniquely naming a KEGG record.
- getFormat() : string
- The name this format is known by in the collection records and in DatabaseParserFactory.
- getGenes() : array<string|int, mixed>
- getMotifs() : array<string|int, mixed>
- getNames() : array<string|int, mixed>
- getOrthologs() : array<string|int, mixed>
- getPathways() : array<string|int, mixed>
- getProducts() : array<string|int, mixed>
- getReactions() : array<string|int, mixed>
- getStructures() : array<string|int, mixed>
- getSubstrates() : array<string|int, mixed>
- getSysname() : string
- isEntryEnd() : bool
- Tells whether a line closes a KEGG record. KEGG closes on three slashes where most flat files use two.
- isEntryStart() : bool
- Tells whether a line opens a new KEGG record.
- parseDataFile() : Sequence
- Parses a KEGG enzyme data file and populates this manager's fields.
- joinLines() : string
- Joins the lines of a field into one string. A line opening with "$" continues the word the line above broke off, so it joins without a space.
- parseDbLinks() : array<string|int, mixed>
- Reads a DBLINKS field into pairs of database name and identifier, one per line.
- parsePathways() : array<string|int, mixed>
- Reads a PATHWAY field into pairs of map identifier and pathway name.
- readData() : string
- Reads the data a line carries, which starts at its thirteenth column.
- readEntryId() : string
- Reads the identifier out of an ENTRY line. Its last word names the kind of record rather than the record itself - "C00031 Compound", "EC 2.7.1.1 Enzyme" - so the identifier is what comes before it, which for an enzyme is the two words "EC" and its number.
- readFields() : array<string|int, mixed>
- Gathers a record into its fields : one entry per label, holding the data of its own line and of every continuation line below it.
- readLabel() : string
- Reads the label a line carries in its first twelve columns.
- splitTokens() : array<string|int, mixed>
- Splits the lines of a field into the whitespace-separated identifiers they list.
- splitClasses() : array<string|int, mixed>
- Reads the CLASS field, whose levels are separated by semicolons and may wrap over lines.
- splitLines() : array<string|int, mixed>
- Reads a field listing one item per line, a long item wrapping onto the next : a wrapped line is indented past the column the items start at.
- splitStructures() : array<string|int, mixed>
- Reads the STRUCTURES field, which names the database holding the structures before listing them : only the identifiers are kept.
Properties
$entry
protected
string
$entry
= ""
$names
protected
array<string|int, mixed>
$names
= []
$classification
private
array<string|int, mixed>
$classification
= []
$comment
private
string
$comment
= ""
$dbLinks
private
array<string|int, mixed>
$dbLinks
= []
$diseases
private
array<string|int, mixed>
$diseases
= []
$genes
private
array<string|int, mixed>
$genes
= []
$motifs
private
array<string|int, mixed>
$motifs
= []
$orthologs
private
array<string|int, mixed>
$orthologs
= []
$pathways
private
array<string|int, mixed>
$pathways
= []
$products
private
array<string|int, mixed>
$products
= []
$reactions
private
array<string|int, mixed>
$reactions
= []
$structures
private
array<string|int, mixed>
$structures
= []
$substrates
private
array<string|int, mixed>
$substrates
= []
$sysname
The systematic name, which spells out the chemistry the enzyme performs.
private
string
$sysname
= ""
Methods
__construct()
Constructor.
public
__construct() : mixed
getClassification()
public
getClassification() : array<string|int, mixed>
Return values
array<string|int, mixed>getComment()
public
getComment() : string
Return values
stringgetDbLinks()
public
getDbLinks() : array<string|int, mixed>
Return values
array<string|int, mixed>getDiseases()
public
getDiseases() : array<string|int, mixed>
Return values
array<string|int, mixed>getEntry()
public
getEntry() : string
Return values
stringgetEntryId()
Extracts the identifier uniquely naming a KEGG record.
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
stringgetFormat()
The name this format is known by in the collection records and in DatabaseParserFactory.
public
static getFormat() : string
Return values
stringgetGenes()
public
getGenes() : array<string|int, mixed>
Return values
array<string|int, mixed>getMotifs()
public
getMotifs() : array<string|int, mixed>
Return values
array<string|int, mixed>getNames()
public
getNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getOrthologs()
public
getOrthologs() : array<string|int, mixed>
Return values
array<string|int, mixed>getPathways()
public
getPathways() : array<string|int, mixed>
Return values
array<string|int, mixed>getProducts()
public
getProducts() : array<string|int, mixed>
Return values
array<string|int, mixed>getReactions()
public
getReactions() : array<string|int, mixed>
Return values
array<string|int, mixed>getStructures()
public
getStructures() : array<string|int, mixed>
Return values
array<string|int, mixed>getSubstrates()
public
getSubstrates() : array<string|int, mixed>
Return values
array<string|int, mixed>getSysname()
public
getSysname() : string
Return values
stringisEntryEnd()
Tells whether a line closes a KEGG record. KEGG closes on three slashes where most flat files use two.
public
static isEntryEnd(string $sLine) : bool
Parameters
- $sLine : string
-
The line to analyze
Return values
boolisEntryStart()
Tells whether a line opens a new KEGG record.
public
static isEntryStart(string $sLine) : bool
Parameters
- $sLine : string
-
The line to analyze
Return values
boolparseDataFile()
Parses a KEGG enzyme 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
Return values
Sequence —$oSequence
joinLines()
Joins the lines of a field into one string. A line opening with "$" continues the word the line above broke off, so it joins without a space.
protected
joinLines(array<string|int, mixed> $aLines) : string
Parameters
- $aLines : array<string|int, mixed>
Return values
stringparseDbLinks()
Reads a DBLINKS field into pairs of database name and identifier, one per line.
protected
parseDbLinks(array<string|int, mixed> $aLines) : array<string|int, mixed>
Format : DBLINKS CAS: 50-99-7
Parameters
- $aLines : array<string|int, mixed>
Return values
array<string|int, mixed>parsePathways()
Reads a PATHWAY field into pairs of map identifier and pathway name.
protected
parsePathways(array<string|int, mixed> $aLines) : array<string|int, mixed>
Format : PATHWAY PATH: map00010 Glycolysis / Gluconeogenesis
Parameters
- $aLines : array<string|int, mixed>
Return values
array<string|int, mixed>readData()
Reads the data a line carries, which starts at its thirteenth column.
protected
static readData(string $sLine) : string
Parameters
- $sLine : string
-
The line to analyze
Return values
stringreadEntryId()
Reads the identifier out of an ENTRY line. Its last word names the kind of record rather than the record itself - "C00031 Compound", "EC 2.7.1.1 Enzyme" - so the identifier is what comes before it, which for an enzyme is the two words "EC" and its number.
protected
static readEntryId(string $sData) : string
Parameters
- $sData : string
Return values
stringreadFields()
Gathers a record into its fields : one entry per label, holding the data of its own line and of every continuation line below it.
protected
readFields(array<string|int, mixed> $aFlines) : array<string|int, mixed>
Parameters
- $aFlines : array<string|int, mixed>
-
The lines the script has to parse
Return values
array<string|int, mixed>readLabel()
Reads the label a line carries in its first twelve columns.
protected
static readLabel(string $sLine) : string
Parameters
- $sLine : string
-
The line to analyze
Return values
stringsplitTokens()
Splits the lines of a field into the whitespace-separated identifiers they list.
protected
splitTokens(array<string|int, mixed> $aLines) : array<string|int, mixed>
Parameters
- $aLines : array<string|int, mixed>
Return values
array<string|int, mixed>splitClasses()
Reads the CLASS field, whose levels are separated by semicolons and may wrap over lines.
private
splitClasses(array<string|int, mixed> $aLines) : array<string|int, mixed>
Parameters
- $aLines : array<string|int, mixed>
Return values
array<string|int, mixed>splitLines()
Reads a field listing one item per line, a long item wrapping onto the next : a wrapped line is indented past the column the items start at.
private
splitLines(array<string|int, mixed> $aLines) : array<string|int, mixed>
Parameters
- $aLines : array<string|int, mixed>
Return values
array<string|int, mixed>splitStructures()
Reads the STRUCTURES field, which names the database holding the structures before listing them : only the identifiers are kept.
private
splitStructures(array<string|int, mixed> $aLines) : array<string|int, mixed>
Format : STRUCTURES PDB: 1HKB 1HKC 1IG8
Parameters
- $aLines : array<string|int, mixed>