Strict Standards: Declaration of action_plugin_searchtext::register() should be compatible with DokuWiki_Action_Plugin::register($controller) in /lib/plugins/searchtext/action.php on line 14

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/auth.php on line 313

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/actions.php on line 163
webapi:category.tree [Shop Docs]

Dokumentacja techniczna

Metoda category.tree

Pobiera drzewo kategorii

array call(string $session_id, "category.tree", array())
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

brak

Wartość zwracana

  1. (array) - tablica (wektor) z informacjami o kategoriach głównych i ich podkategoriach.
    Tablice mają strukturę:
    • ['id'] (int) - identyfikator kategorii
    • ['children'] (array) - tablica (wektor) z informacjami o podkategoriach danej kategorii i ich podkategoriach. Zwracane tablice mają taką samą strukturę jak kategorie główne.
      • [0] (array) - przykładowa tablica z informacjami o podkategorii
        • ['id'] (int) - identyfikator kategorii
        • ['children'] (array) - tablica (wektor) z informacjami o podkategoriach…
      • [1] (array) - przykładowa tablica z informacjami o podkategorii
        • ['id'] (int) - identyfikator kategorii
        • ['children'] (array) - tablica (wektor) z informacjami o podkategoriach…
    • –…

Rzucane wyjątki SoapFault

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];
    }
}
 
/**
 * Wyświetlenie drzewa kategorii (rekurencyjnie)
 * 
 * @param Array $categories Rekurencyjna tablica kategorii z kluczami id i children
 */
function traverseCategories($categories, $level) {
    foreach ($categories as $item) {
        $category = (Array)$item;
        echo str_repeat("-", $level*4) . "Id: " . $category['id'] . "<br>";  
 
        if (!empty($category["children"])) {
            traverseCategories($category["children"], $level + 1);
        }
    }
}
 
$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.tree", Array())
    );
 
    // 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 {
        traverseCategories($result, 0);
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>