Przejdź do głównej treści

Pobierz dane o pliku

Ready_™ Developer TeamMniej niż 1 minuta

Pobierz dane o pliku

Definicja Funkcji

Array getFile(Int $fileid, Bool $return_json = false)

Pobiera informacje (metadane) o pliku.

Definicja parametrów

Metoda przyjmuje 2 argumenty.

Nazwa parametruTyp parametruOpis
fileidint (wymagany)Identyfikator pliku (files.fileid )
return_jsonboolFlaga określa w jakiej formie zostaną zwrócony wynik. (false - tablica, true - JSON). Domyślnie przyjmuje wartość false.

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $fileid = 1;
    $file = $api->getFile($fileid);
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca tablicę asocjacyjną z metadanymi pliku w przypadku sukcesu. Jeśli wystąpi błąd wtedy, zostanie zwrócony wyjątek.

Zwracane wyjątki w zależności od wywołania

  • SOAP - SoapFault
  • Lokalnie - Exception