Properties

$accession

$accession : array

Type

array<string|int, mixed> —

$sequence

$sequence : \Amelaye\BioPHP\Domain\Sequence\Entity\Sequence

Type

Sequence

$authors

$authors : array

Type

array<string|int, mixed> —

$features

$features : array

Type

array<string|int, mixed> —

$keywords

$keywords : array

Type

array<string|int, mixed> —

$references

$references : array

Type

array<string|int, mixed> —

$srcForm

$srcForm : \Amelaye\BioPHP\Domain\Sequence\Entity\SrcForm

Type

SrcForm

$gbSequence

$gbSequence : \Amelaye\BioPHP\Domain\Sequence\Entity\GbSequence

Type

GbSequence

$spDatabank

$spDatabank : array

Type

array<string|int, mixed> —

$aLines

$aLines : array

Type

array<string|int, mixed> —

Methods

getFormat()

getFormat() : string

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

Returns

string —

isEntryStart()

isEntryStart(string  $sLine) : bool

Tells whether a line opens a new GenBank entry.

Parameters

string $sLine

The line to analyze

Returns

bool —

isEntryEnd()

isEntryEnd(string  $sLine) : bool

Tells whether a line closes a GenBank entry.

Parameters

string $sLine

The line to analyze

Returns

bool —

getEntryId()

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

Extracts the identifier uniquely naming a GenBank entry.

Parameters

array $aFlines

The whole file, buffered

string $sLine

The line opening the entry

Returns

string —

parseDataFile()

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

Parses a GenBank data file and returns a Seq object containing parsed data.

Parameters

array $aFlines

The lines the script has to parse

Throws

\Exception

Returns

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

$oSequence

left()

left(string  $str, int  $numchars) : bool|string

Returns the first $numchars characters of a string.

Parameters

string $str
int $numchars

Returns

bool|string —

right()

right(string  $str, int  $numchars) : bool|string

Returns the substring beginning at $numchars characters from the right end of a string.

Parameters

string $str
int $numchars

Returns

bool|string —

intrim()

intrim(string  $string) : mixed

Removes "internal spaces" (as opposed to leading and trailing spaces) from a string.

Parameters

string $string

Returns

mixed —

getmin()

getmin(int  $x, int  $y, int  $z) : int

Gets the minimum of three (usually numeric) values $x, $y, and $z.

For now, this can't handle situations when one or more arguments is FALSE.

Parameters

int $x
int $y
int $z

Returns

int —

rem_right()

rem_right(string  $str, int  $charcount = 1) : bool|string

Removes $charcount characters from the right (end) of a string.

Parameters

string $str
int $charcount

Returns

bool|string —

trim_element()

trim_element(mixed  $value, mixed  $key) : mixed

trim_element() removes leading and trailing spaces from a string. In conjunction with the array_walk() function, it removes spaces from each element of an array.

Parameters

mixed $value
mixed $key

Returns

mixed —

__construct()

__construct() : mixed

Constructor.

Returns

mixed —

getAccession()

getAccession() : array

Returns

array —

getSequence()

getSequence() : \Amelaye\BioPHP\Domain\Sequence\Entity\Sequence

Returns

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

getAuthors()

getAuthors() : array

Returns

array —

getGbSequence()

getGbSequence() : \Amelaye\BioPHP\Domain\Sequence\Entity\GbSequence

Returns

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

getFeatures()

getFeatures() : array

Returns

array —

getKeywords()

getKeywords() : array

Returns

array —

getReferences()

getReferences() : array

Returns

array —

getSrcForm()

getSrcForm() : \Amelaye\BioPHP\Domain\Sequence\Entity\SrcForm

Returns

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

getSpDatabank()

getSpDatabank() : array

Returns

array —

setAccession()

setAccession(array  $accession) : void

Parameters

array $accession

Returns

void —

setSequence()

setSequence(\Amelaye\BioPHP\Domain\Sequence\Entity\Sequence  $sequence) : void

Parameters

\Amelaye\BioPHP\Domain\Sequence\Entity\Sequence $sequence

Returns

void —

setAuthors()

setAuthors(array  $authors) : void

Parameters

array $authors

Returns

void —

setFeatures()

setFeatures(array  $features) : void

Parameters

array $features

Returns

void —

setKeywords()

setKeywords(array  $keywords) : void

Parameters

array $keywords

Returns

void —

setReferences()

setReferences(array  $references) : void

Parameters

array $references

Returns

void —

setSrcForm()

setSrcForm(\Amelaye\BioPHP\Domain\Sequence\Entity\SrcForm  $srcForm) : void

Parameters

\Amelaye\BioPHP\Domain\Sequence\Entity\SrcForm $srcForm

Returns

void —

setGbSequence()

setGbSequence(\Amelaye\BioPHP\Domain\Sequence\Entity\GbSequence  $gbSequence) : void

Parameters

\Amelaye\BioPHP\Domain\Sequence\Entity\GbSequence $gbSequence

Returns

void —

setSpDatabank()

setSpDatabank(array  $spDatabank) : void

Parameters

array $spDatabank

Returns

void —

parseLocationBounds()

parseLocationBounds(string  $sLocation) : array

Parses an INSDC feature location (shared by GenBank and EMBL) into its outer bounds and strand. Strips the complement()/join() wrappers and the "<"/">" fuzzy-boundary markers.

For a join() of several comma-separated segments (a spliced feature), Feature has no room to keep each exon separately, so this returns the lowest start and the highest end across every segment.

Parameters

string $sLocation

The raw location text, e.g. "complement(join(<1..10,50..>60))".

Returns

array —

[$iFrom, $iTo, $sStrand] - $sStrand is "-" when the location was wrapped in complement(...), "+" otherwise.

parseReferences()

parseReferences(array  $aFlines) : mixed

Parameters

array $aFlines

The lines the script has to parse

Throws

\Exception

Returns

mixed —

seekReferences()

seekReferences(string  $sReferenceProperty) : string

Parse every multi-line fields from REFERENCES

Parameters

string $sReferenceProperty

The references part

Throws

\Exception

Returns

string —

parseOrganism()

parseOrganism(mixed  $flines) : mixed

Parses information about organism

Parameters

mixed $flines

Throws

\Exception

Returns

mixed —

parseLocus()

parseLocus() : mixed

Parses line LOCUS

Throws

\Exception

Returns

mixed —

parseDefinition()

parseDefinition(mixed  $flines) : mixed

Parses DEFINITION field @ param array $flines

Parameters

mixed $flines

Throws

\Exception

Returns

mixed —

parseVersion()

parseVersion() : mixed

Parses VERSION field

Throws

\Exception

Returns

mixed —

parseKeywords()

parseKeywords() : mixed

Parses KEYWORDS field

Throws

\Exception

Returns

mixed —

parseAccession()

parseAccession() : mixed

Parses ACCESSION field

Throws

\Exception

Returns

mixed —

parseFeatures()

parseFeatures(array  $aFlines, string  $sField) : mixed

Parses each fields for FEATURES

Parameters

array $aFlines
string $sField

Throws

\Exception

Returns

mixed —

buildFeature()

buildFeature(string  $sLine, string  $sKey, array  $aBounds) : mixed

Creates Feature object

Parameters

string $sLine
string $sKey
array $aBounds

[$iFtFrom, $iFtTo, $sStrand], as returned by parseLocationBounds().

Returns

mixed —