Metoda category.list
Pobiera listę kategorii
array call(string $session_id, "category.list", array($extended = false, $translations = false, $categories = ""))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- extended (bool) - - czy zwrócić tylko listę identyfikatorów kategorii (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
- translations (boolean) - - czy zwrócić dodatkowo informacje o tłumaczeniach
- categories
Wartość zwracana
- (array) - jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów.
- (array) - jeśli parametr extended ustawiony jest na true, zwracana jest tablica (wektor) o długości tablicy podanej jako trzeci parametr metody. Wektor składa się z tablic asocjacyjnych o strukturze:
- ['category_id'] (int) - identyfikator kategorii
- ['root'] (int[0/1]) - czy kategoria jest kategorią główną (1) czy podkategorią innej kategorii (0)
- ['order'] (int) - priorytet brany pod uwagę przy szacowaniu kolejności wyświetlania kategorii
- ['translations'] (array) - tablica asocjacyjna z istniejącymi tłumaczeniami obiektu, zwracana tylko wtedy, kiedy parametr $translations jest ustawiony na true. Kluczami tablicy są nazwy lokalizacji, a wartościami tablice asocjacyjne informacji o tłumaczeniach:
- ['pl_PL'] (array) - przykładowa tablica z informacjami o tłumaczeniu w lokalizacji pl_PL
- ['translation_id'] (int) - identyfikator tłumaczenia
- ['category_id'] (int) - identyfikator kategorii
- ['name'] (string) - nazwa kategorii
- ['description'] (string) - opis kategorii
- ['seo_title'] (string) - tytuł wyświetlany w tagu <title>
- ['seo_description'] (string) - opis wyświetlany w tagu meta description
- ['seo_keywords'] (string) - opis wyświetlany w tagu meta keywords
- ['active'] (int[0/1]) - czy kategoria jest aktywna (1) lub nie (0)
- ['isdefaults'] (int[0/1]) - czy kategoria została dodana podczas instalacji sklepu (1) lub nie (0)
- ['pres_id'] (int|null) - identyfikator prezentacji
- ['lang_id'] (int) - identyfikator lokalizacji
- ['items'] (int) - ilość aktywnych produktów w danym języku dowiązanych do tej kategorii
Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość array('error' ⇒ -2) - to oznacza, że skrypt po stronie serwera nie miał już czasu na wykonanie żądanych operacji na obiektach (poprzednie iteracje przekroczyły 80% całego dostępnego czasu na wykonanie skryptu). W celu zdobycia oczekiwanych informacji, należy ponowić zapytanie wysyłając tablicę pominiętych obiektów.
W celu zapewnienia kompatybilności typów zwracanych obiektów kod błędu jest sygnalizowany przez tablicę asocjacyjną zawierającą klucz 'error'
Rzucane wyjątki SoapFault
- W przypadku próby pobrania informacji o nieistniejąej kategorii, rzucany jest wyjątek z komunikatem category identified as id: {$id} does not exist
Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)
Przykład wywołania w PHP
<?php /** * Logowanie do API * * @param resource $c cURL resource handle * @param string $login Login użytkownika * @param string $password Hasło użytkownika * @return string Indentyfikatorr sesji użytkownika */ function login($c, $login, $password) { $params = Array( "method" => "login", "params" => Array($login, $password) ); curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params)); $result = (Array) json_decode(curl_exec($c)); if (isset($result['error'])) { return null; } else { return $result[0]; } } $c = curl_init(); curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/'); curl_setopt($c, CURLOPT_POST, true); curl_setopt($c, CURLOPT_RETURNTRANSFER, 1); // zalogowanie użytkownika i pobranie identyfikatora sesji $session = login($c, "api", "test"); if ($session != null) { $params = Array( "method" => "call", "params" => Array($session, "category.list", Array(true, true, true, true, true, Array(6, 7, 8) // id kategorii ) ) ); // zakodowanie parametrów dla metody POST $postParams = "json=" . json_encode($params); curl_setopt($c, CURLOPT_POSTFIELDS, $postParams); // dekodowanie rezultatu w formacie JSON do tablicy result $data = curl_exec($c); $result = (Array)json_decode($data); // sprawdzenie, czy wystąpił błąd if (isset($result['error'])) { echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code']; } else { foreach ($result as $item) { $category = (Array)$item; echo "Id: " . $category['category_id'] . "<br>"; $translations = (Array)$category['translations']; $translPL = (Array)$translations['pl_PL']; echo "Nazwa w języku polskim: " . $translPL['name'] . "<br>"; echo "<hr><br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>