Read from the package's own PHP files at the commit bcbb3753faa5: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.
InterProSourceclassInterPro, the EBI's classification of protein families, domains and sites, through its API: an InterPro entry ("IPR000971", globin) or a Pfam family ("PF00042") - its name, type, description, member signatures, GO terms, how many proteins and structures it covers, its Pfam clan, its representative structure, its overlapping entries and its place in InterPro's hierarchy -; a UniProt protein ("P68871") with the InterPro entries and the Pfam families it matches, each by its type (domain, family, homologous superfamily, repeat, site) as related things, and where on the sequence; a search of InterPro entries by text.
5 methods · 2 constants
InterProSourceFactoryclassInterPro: InterPro entries and Pfam families, the domains and families a UniProt protein matches, a search - no key needed.
2 options
Omnilab\InterPro
InterProSource class
final class InterProSource extends HttpSource InterProSource.php:35
InterPro, the EBI's classification of protein families, domains and sites, through its API: an InterPro entry ("IPR000971", globin) or a Pfam family ("PF00042") - its name, type, description, member signatures, GO terms, how many proteins and structures it covers, its Pfam clan, its representative structure, its overlapping entries and its place in InterPro's hierarchy -; a UniProt protein ("P68871") with the InterPro entries and the Pfam families it matches, each by its type (domain, family, homologous superfamily, repeat, site) as related things, and where on the sequence; a search of InterPro entries by text.
No key, no account, no published rate: no throttle by default. One call an entry, two a protein (the protein, its entries), one a search page; over HTTP/1.1, InterPro's 204 (nothing found) being refused by curl over HTTP/2.
const BASE_URI = 'https://www.ebi.ac.uk/interpro/api/'const MAX_LIMIT = 200The most entries a search page holds (the API's own cap is 200).
InterProSource::__construct()
public function __construct(HttpClientInterface $http, string $baseUri = self::BASE_URI, array $headers = [], float $throttle = 0.0)InterProSource::getName()
public function getName(): stringInterProSource::capabilities()
public function capabilities(): arrayInterProSource::entity()
public function entity(Identifier|string $id): ?EntityAn InterPro entry ("IPR000971", "interpro:IPR000971", its page), a Pfam family ("PF00042", versioned or not) or a UniProt protein ("P68871", "uniprot:P68871", its page); another base's identifier is refused before any call; null when InterPro has no such entry or protein.
InterProSource::search()
public function search(Query $query): PageInterPro entries whose name or text holds the words, in InterPro's order (by accession: the API does not rank); a domain other than biology answers nothing. An entity of a page holds its name, type, member signatures and GO terms: entity() reads it whole.
InterProSourceFactory class
final class InterProSourceFactory extends SourceFactory InterProSourceFactory.php:19
InterPro: InterPro entries and Pfam families, the domains and families a UniProt protein matches, a search - no key needed.
options: mailto: 'support@glitchr.io' # in the User-Agent throttle: 0 # seconds between two calls: InterPro publishes no rate base_uri: 'https://www.ebi.ac.uk/interpro/api/'
Options
| Option | Default | |
|---|---|---|
throttle | 0.0 | |
base_uri | InterProSource::BASE_URI |