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:producer.list.save [Shop Docs]

Dokumentacja techniczna

Metoda producer.list.save

Aktualizuje listę producentów

array call(string $session_id, "producer.list.save", array($list, $force = false))
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

  1. list (array) - - tablica, w której kluczem jest identyfikator producenta, a wartością tablica asocjacyjna z danymi producenta do aktualizacji:
    • ['gfx'] (array) - opcjonalna tablica asocjacyjna zawierająca informacje o pliku graficznym dowiązanym do producenta
      • ['file'] (string) - nazwa pliku graficznego
      • ['content'] (string) - zawartość pliku graficznego zakodowana w base64
    • ['name'] (string) - nazwa producenta
    • ['web'] (string) - opcjonalny, poprawny adres url strony producenta
  2. force (boolean) - - czy wymusić aktualizację obiektu mimo istniejącej blokady innego administratora

Wartość zwracana

  1. (array) - tablica zawierająca statusy operacji dla każdego obiektu:
    • 0 - operacja się nie udała
    • 1 - operacja się udała
    • 2 - operacja się nie udała - obiekt jest zablokowany przez innego administratora
    • -1 - podane dane są nieprawidłowe i nie spełniają wymagań walidacji
    • -2 - operacja się nie udała - zabrakło czasu na zrealizowanie operacji
Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość -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.

Rzucane wyjątki SoapFault

  • W przypadku nie podania danych producenta w formie tablicy, rzucany jest wyjątek Invalid data container
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) {
    $producer1 = Array(        
        "name" => "Aktualizacja producenta 1",
        "web" => "www.stronaproducenta1.pl",
        "gfx" => Array(
            "file" => "logo1.png",
            "content" => base64_encode("<zawartość pliku graficznego1>")
        ),
    );
 
    $producer2 = Array(        
        "name" => "Aktualizacja producenta 2",
        "web" => "www.stronaproducenta2.pl",
        "gfx" => Array(
            "file" => "logo2.png",
            "content" => base64_encode("<zawartość pliku graficznego2>")
        ),
    );
 
    $producers = Array(
        4 => $producer1, 
        5 => $producer2
    );
 
    $params = Array(
        "method" => "call",
        "params" => Array($session, "producer.list.save", Array($producers, true)) 
    );
 
    // 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 $r) {
            if ($r == -2) {
                echo "Operacja się nie udała - zabrakło czasu na zrealizowanie operacji<br>";
            } else if ($r == -1) {
                echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji<br>";
            } else if ($r == 0) {
                echo "Operacja się nie udała<br>";
            } else if ($r == 1) {
                echo "Operacja się udała<br>";
            } else if ($r == 2) {
                echo "Operacja się nie udała - obiekt jest zablokowany przez innego administratora<br>";
            }
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>