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:option.info [Shop Docs]

Dokumentacja techniczna

Jesteś tutaj: Dokumentacja Sklepu » webapi » option.info

Metoda option.info

Pobiera informacje o cesze

array call(string $session_id, "option.info", array($id, $translations = false, $values = false))
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

  1. id
  2. translations (boolean) - - czy zwrócić dodatkowo informacje o tłumaczeniach
  3. values (boolean) - - czy zwrócić dodatkowo informacje o wariantach cechy

Wartość zwracana

  1. (array) - tablica asocjacyjna z informacjami o cesze.
    Zwracana tablica ma strukturę:
    • ['option_id'] (int) - identyfikator cechy
    • ['group_id'] (int) - identyfikator grupy, do której dowiązana jest cecha
    • ['order'] (int) - priorytet brany pod uwagę przy szacowaniu kolejności wyświetlania cech
    • ['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
        • ['option_id'] (int) - identyfikator cechy
        • ['name'] (string) - nazwa cechy
        • ['lang_id'] (int) - identyfikator lokalizacji
    • ['values'] (array) - tablica (wektor) tablic z informacjami o wariantach, zwracana tylkow wtedy, kiedy parametr $values jest ustawiony na true. Tablice mają strukturę:
      • [0] (array) - przykładowa tablica z informacjami o wariancie
        • ['ovalue_id'] (int) - identyfikator wariantu
        • ['option_id'] (int) - identyfikator cechy, do której dowiązany jest wariant
        • ['order'] (int) - priorytet brany pod uwagę przy szacowaniu kolejności wyświetlania wariantów
        • ['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
            • ['ovalue_id'] (int) - identyfikator wariantu
            • ['value'] (string) - nazwa wariantu
            • ['lang_id'] (int) - identyfikator lokalizacji
    • –…

Rzucane wyjątki SoapFault

  • W przypadku próby pobrania informacji o nieistniejącej cesze, rzucany jest wyjątek z komunikatem Option 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, "option.info", 
                Array(1, true, true)
                    // id cechy, wartości cechy, 
            ) 
    );
 
    // 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 {
        echo "Id cechy: " . $result['option_id'] . "<br>";
 
        $translations = (Array)$result['translations'];
        $translPL = (Array)$translations['pl_PL'];
        echo "Nazwa opcji w języku polskim: " . $translPL['name'] . "<br>";
 
        $values = (Array)$result['values'];
        foreach ($values as $val) {
            $value = (Array)$val;
            echo "Id wartości: " . $value['ovalue_id'] . "<br>";
 
            $translations = (Array)$value['translations'];
            $translPL = (Array)$translations['pl_PL'];
            echo "Nazwa wartości w języku polskim: " . $translPL['value'] . "<br>";
 
            echo "<br>";
        }
 
        echo "<br>";
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>