UniProtPHPClass

Source-verified API signatures#

Public signatures transcribed from the current PHP source.

League\UniProt\Http\HttpClientInterface
public function get(string $url, array $headers = []): array;
public function post(string $url, array $data = [], array $headers = []): array;
public function isAvailable(): bool;
public function getTransportName(): string;

League\UniProt\Http\HttpClientFactory
public static function create(bool $forceCurl = false): HttpClientInterface
public static function getInstance(): HttpClientInterface
public static function reset(): void
public static function getAvailableTransports(): array

League\UniProt\Http\CurlClient
public function __construct()
public static function setVerifySSL(bool $verify): void
public function isAvailable(): bool
public function getTransportName(): string
public function get(string $url, array $headers = []): array
public function post(string $url, array $data = [], array $headers = []): array

League\UniProt\Http\StreamClient
public function __construct()
public function isAvailable(): bool
public function getTransportName(): string
public function get(string $url, array $headers = []): array
public function post(string $url, array $data = [], array $headers = []): array

League\UniProt\Exception\UniProtException
public function __construct(string $message = '', int $code = 0, ?\Throwable $previous = null)
public function setApiErrorCode(?string $code): self
public function getApiErrorCode(): ?string
public function setApiErrorMessage(?string $message): self
public function getApiErrorMessage(): ?string
public function setHttpStatus(int $status): self
public function getHttpStatus(): int
public function setApiResponse(?string $response): self
public function getApiResponse(): ?string
public function isClientError(): bool
public function isServerError(): bool
public function isTransportError(): bool
public function getDetailedMessage(): string

League\UniProt\UniProt\UniProtEntry
public function __construct(HttpClientInterface $httpClient)
public function get(string $accession, string $format = 'json'): array
public function getBatch(array $accessions, string $format = 'json'): array
public function exists(string $accession): bool
public function getWithFields(string $accession, array $fields = []): array

League\UniProt\UniProt\UniProtIdMapping
public function __construct(HttpClientInterface $httpClient)
public function submit(string $fromDb, string $toDb, array $ids, ?int $taxId = null): string
public function status(string $jobId): array
public function waitForCompletion(string $jobId, int $pollInterval = self::DEFAULT_POLL_INTERVAL, int $maxPolls = self::DEFAULT_MAX_POLLS): bool
public function getDetails(string $jobId): array
public function getResults(string $jobId, int $pageSize = 25, int $pageNumber = 0): array
public function streamResults(string $jobId, array $options = []): array
public function submitAndWait(string $fromDb, string $toDb, array $ids, ?int $taxId = null, int $pollInterval = self::DEFAULT_POLL_INTERVAL, int $maxPolls = self::DEFAULT_MAX_POLLS): string
public function getAvailableDatabases(): array

League\UniProt\UniProt\UniProtSearch
public function __construct(HttpClientInterface $httpClient)
public function search(string $query, array $options = []): SearchResults
public function getFirstPage(string $query, array $options = []): array
public function getCount(string $query): int
public function buildUrl(string $query, array $options = []): string
public function getTotalCount(string $query, array $options = []): int
public function getPaginatedResults(string $query, int $offset = 0, int $pageSize = 10, array $options = []): array

League\UniProt\UniProt\SearchResults
public function __construct(HttpClientInterface $httpClient, string $query, array $options = [])
public function extractNextLink(array $headers): ?string
public function current(): mixed
public function key(): int
public function next(): void
public function rewind(): void
public function valid(): bool