RestrictionEnzymeCatalogInterface
in
Interface RestrictionEnzymeCatalogInterface - gives typed, read-only access to restriction enzyme definitions merged from the Type II, Type IIb and Type IIs endonuclease sources, without exposing the private storage of any single one of them.
Tags
Table of Contents
Methods
- findByFamily() : array<string|int, RestrictionEnzymeDefinition>
- Returns every enzyme belonging to the given family, sorted by canonical name.
- findByName() : RestrictionEnzymeDefinition|null
- Looks a restriction enzyme up by its canonical name or one of its aliases, case-insensitively.
- findByRecognitionSequence() : array<string|int, RestrictionEnzymeDefinition>
- Returns every enzyme whose recognition sequence, cleavage marks stripped, matches $sSequence case-insensitively : either alternative of a "SITE1 or SITE2" sequence, read on either strand (GAGCGG finds AccBSI, CCGCTC). Several enzymes (isoschizomers) may share the same recognition sequence.
- getByName() : RestrictionEnzymeDefinition
- Same as findByName(), but throws instead of returning null.
Methods
findByFamily()
Returns every enzyme belonging to the given family, sorted by canonical name.
public
findByFamily(string $sFamily) : array<string|int, RestrictionEnzymeDefinition>
Parameters
- $sFamily : string
-
One of RestrictionEnzymeDefinition::VALID_FAMILIES
Return values
array<string|int, RestrictionEnzymeDefinition> —Empty when the family is unknown or has no member
findByName()
Looks a restriction enzyme up by its canonical name or one of its aliases, case-insensitively.
public
findByName(string $sName) : RestrictionEnzymeDefinition|null
Parameters
- $sName : string
-
Canonical name or alias
Return values
RestrictionEnzymeDefinition|null —Null when no enzyme matches
findByRecognitionSequence()
Returns every enzyme whose recognition sequence, cleavage marks stripped, matches $sSequence case-insensitively : either alternative of a "SITE1 or SITE2" sequence, read on either strand (GAGCGG finds AccBSI, CCGCTC). Several enzymes (isoschizomers) may share the same recognition sequence.
public
findByRecognitionSequence(string $sSequence) : array<string|int, RestrictionEnzymeDefinition>
Parameters
- $sSequence : string
-
The recognition sequence to search for, without cleavage marks
Return values
array<string|int, RestrictionEnzymeDefinition> —Sorted by canonical name, empty when nothing matches
getByName()
Same as findByName(), but throws instead of returning null.
public
getByName(string $sName) : RestrictionEnzymeDefinition
Parameters
- $sName : string
-
Canonical name or alias