Wyszukaj jeden lub wiele dokumentów

Definicja Funkcji

Array searchDocuments(Array $data, String $fields = NULL)

Szuka dokumentów i zwraca listę pól tych dokumentów wg. zadanych kryteriów.

Definicja parametrów

Nazwa parametru	Typ parametru	Opis
data	array (Wymagany)	Tablica z parametrami w formie klucz => wartość, gdzie klucz to nazwa pola z bazy z tabeli documents. Możliwe jest określenie operatora porównania (=, !=, ~, ~*) pola z podanym tekstem/wartością. Operator należy dokleić do klucza po nazwie kolumny. Przykład: ['pprosm=' => '2016/AA/0001'] wyszuka dokumenty, których numer jest 2016/AA/0001 wygenerowany na tej podstawie SQL: (pprosm = '2016/AA/0001')
fields	string	Nazwy pól z tabli documents. Domyślnie NULL, wtedy zostaną zwrócone wszystkie rekordy

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    // znajdź dokument o numerze SZJ-12, w wyniku zwróć ID oraz opis dokumentu
    $documents = $api->searchDocuments(['pprosm=' => 'SZJ-12'], 'doc_id, dscrpt');
    
    // znajdź dokument w którego opisie znajduje się tekst "pismo", w wyniku zwróć ID oraz nazwe użytkownika, który stworzył dokument
    $documents = $api->searchDocuments(['dscrpt' => 'pismo'], 'doc_id, adutxt');
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca tablicę podanych pól dokumentów 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