Metoda checkObjectLock
Sprawdza czy podany obiekt nie jest zablokowany do edycji przez innego użytkownika.
boolean checkObjectLock(string session_id, integer object_type, integer object_id)
Parametry wejściowe
- session_id (string) - identyfikator sesji użytkownika
- object_type (int) - typ obiektu do sprawdzenia (zobacz listę typów obiektów).
- object_id (int) - identyfikator obiektu do sprawdzenia
Nie można sprawdzić blokady obiektu typu CONFIG (object_type ⇒ 0)
Wartość zwracana
- unlocked (bool) - obiekt zablokowany (false) | obiekt niezablokowany (true).
Rzucane wyjątki SoapFault
- W przypadku nieprawidłowego identyfikatora sesji lub nagłego usunięcia użytkownika, rzucany jest wyjątek z komunikatem Permission denied i kodem błędu 2
- W przypadku blokady aplikacji przez innego użutkownika, rzucany jest wyjątek z komunikatem Application locked i kodem błędu 3
- W przypadku podania nieprawidłowego typu obiektu (zobacz listę typów obiektów), rzucany jest wyjątek z komunikatem Object is not instance of Logic_Abstract
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" => "checkObjectLock", "params" => Array($session, 26, 5) // id_sesji, typ obiektu (produkt), id produktu ); // 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 { if ($result[0] == 1) { echo "Obiekt jest zablokowany"; } else { echo "Obiekt nie jest zablokowany przez innego użytkownika"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>