Dokumentacja klasy ElibriAPI
ElibriAPI abstrahuje wykorzystanie API udostępniane przez Elibri. Więcej...
Metody publiczne | |
| __construct ($login, $password, $host=NULL) | |
| Kontruktor obiektu API. | |
| getPublishersList () | |
| Pobierz listę wydawnict obecnych w Elibri. | |
| getPublisherProducts ($publisherId) | |
| Pobierz listę produktów należących do wydawnictwa. Więcej... | |
| getQueues () | |
| pobierz listę kolejek danych Więcej... | |
| popQueue ($queue, $count=30, $testing=false) | |
| Pobierz dane z kolejki. Więcej... | |
| refillAll () | |
| zapełnij kolejki wszystkimi dostępnymi danymi | |
| lastPopQueue ($queue) | |
| Ponów pobieranie danych z kolejki. Metoda ta może zostać użyta, gdy podczas pobierania danych z kolejki wystąpił jakiś błąd. Więcej... | |
| getProduct ($reference) | |
| Pobierz metadane jednego produktu. Więcej... | |
Atrybuty publiczne | |
| $VERSION = "0.9" | |
| const | STOCKS_QUEUE = "stocks" |
| Nazwa kolejki z danymi o dostępności produktów. | |
| const | META_QUEUE = "meta" |
| Nazwa kolejki z metadanymi produktów. | |
Opis szczegółowy
ElibriAPI abstrahuje wykorzystanie API udostępniane przez Elibri.
Dokumentacja funkcji składowych
◆ getProduct()
| ElibriAPI::getProduct | ( | $reference | ) |
Pobierz metadane jednego produktu.
- Parametry
-
$reference - record_reference produktu, który ma zostać pobrany
- Zwraca
- instancja ElibriOnixMessage - w tablicy $products jest tylko jeden produkt
◆ getPublisherProducts()
| ElibriAPI::getPublisherProducts | ( | $publisherId | ) |
Pobierz listę produktów należących do wydawnictwa.
- Parametry
-
int $publisherId - ID wydawnictwa
- Zwraca
- lista instancji ElibriPublisherProduct
◆ getQueues()
| ElibriAPI::getQueues | ( | ) |
pobierz listę kolejek danych
- Zwraca
- lista instancji ElibriQueue
◆ lastPopQueue()
| ElibriAPI::lastPopQueue | ( | $queue | ) |
Ponów pobieranie danych z kolejki. Metoda ta może zostać użyta, gdy podczas pobierania danych z kolejki wystąpił jakiś błąd.
- Parametry
-
String $queue - nazwa kolejki
- Zwraca
- instancja ElibriOnixMessage
◆ popQueue()
| ElibriAPI::popQueue | ( | $queue, | |
$count = 30, |
|||
$testing = false |
|||
| ) |
Pobierz dane z kolejki.
- Parametry
-
String $queue - nazwa kolejki int $count - ilość produktów do pobrania, max. 100 (domyślnie 30) bool $testing - jeśli true, to dane nie są usuwane z kolejki (domyślnie false)
- Zwraca
- instancja ElibriOnixMessage albo NULL, jeśli kolejka danych jest pusta
