Klient GrabzIt z PHP

Opis

Ta klasa obsługuje całą komunikację z usługami zrzutów ekranu GrabzIt.

Metody publiczne

GetResult($id)
URLToAnimation($url, $options = null)
URLToImage($url, $options = null)
HTMLToImage($html, $options = null)
FileToImage($path, $options = null)
URLToPDF($url, $options = null)
HTMLToPDF($html, $options = null)
FileToPDF($path, $options = null)
URLToDOCX($url, $options = null)
HTMLToDOCX($html, $options = null)
FileToDOCX($path, $options = null)
URLToTable($url, $options = null)
HTMLToTable($html, $options = null)
FileToTable($path, $options = null)
URLToRenderedHTML($url, $options = null)
HTMLToRenderedHTML($html, $options = null)
FileToRenderedHTML($path, $options = null)
Save($callBackURL = null)
SaveTo()
SaveTo($saveToFile)
GetStatus($id)
GetCookies($domain)
SetCookie($name, $domain, $value = "", $path = "/", $httponly = false, $expires = "")
DeleteCookie($name, $domain)
GetWaterMarks()
GetWaterMark($identifier)
AddWaterMark($identifier, $path, $xpos, $ypos)
DeleteWaterMark($identifier)
SetLocalProxy($proxyUrl)
UseSSL($value)
CreateEncryptionKey()
Decrypt($path, $key)
DecryptFile($path, $key)

GetResult($ id)

Ta metoda zwraca sam zrzut ekranu. Jeśli nic nie zostanie zwrócone, oznacza to, że coś poszło nie tak lub zrzut ekranu nie jest jeszcze gotowy.

parametry

id - unikalny identyfikator zrzutu ekranu
- Wymagane

Wartość zwracana

Schwytanie

URLToAnimation($ url, Opcje $ = null)

Określ adres URL wideo online, które należy przekonwertować into animowany GIF.

parametry

url - adres URL wideo online do konwersji into animowany GIF.
- Wymagane
- Akceptuje adresy URL wideo Vimeo i YouTube
  - Ostrzeżenie dotyczące animowania filmów Vimeo i YouTube zależy od strony trzeciej, dlatego może nie zapewniać spójnych wyników.
Opcje - instancja GrabzItAnimationOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia animowanego GIF-a.

Wartość zwracana

unieważnić

GrabzItAnimationOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia animowanego GIF-a.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do animowanej usługi internetowej GIF. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
setWidth($value) - szerokość wynikowego animowanego GIF-a w pikselach.
- Domyślnie: 180px
- Maksymalna: maksymalna szerokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że szerokość animowany GIF jest skalowany w stosunku do jego wysokości, jeśli szerokość jest automatycznie dopasowywana, wysokość nie może)
setHeight($value) - wysokość powstałego animowanego GIF-a w pikselach.
- Domyślnie: 120px
- Maksymalna: maksymalna wysokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że wysokość animowany GIF jest skalowany w stosunku do szerokości, jeśli wysokość jest automatycznie dopasowywana, szerokość nie może)
setStart($value) - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: 0 sekund
setDuration($value) - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: maksymalna długość paczki
setSpeed($value) - prędkość animowanego GIF-a.
- Domyślnie: 1
- Minimum: 0.2
- Maksymalna ilość znaków: 10
setFramesPerSecond($value) - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
- Domyślnie: 10
- Minimum: 0.2
- Maksymalna ilość znaków: 60
setRepeat($value) - ile razy zapętlono animowany GIF.
- Domyślnie: 0
- Pętla w sposób ciągły: 0
- Nigdy nie pętla: -1
setReverse($value) - jeśli to prawda, ramki animowanego GIF-a są odwrócone
- Domyślnie: false
setCustomWaterMarkId($value) - dodaj niestandardowe watermark do animowanego GIF-a
- Domyślnie: pusty
setQuality($value) - w jakość zwróconego obrazu, który ma domyślną kompresję 85%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
setCountry($value) - kraj animowany GIF powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

URLToImage($ url, Opcje $ = null)

Określa adres URL, który należy przekonwertować into zrzut ekranu obrazu.

parametry

url - adres URL, z którego należy wykonać zrzut ekranu
- Wymagane
Opcje - instancja GrabzItImageOptions klasa, która definiuje specjalne opcje do użycia podczas tworzenia zrzutu ekranu.

Wartość zwracana

unieważnić

HTMLToImage($ html, Opcje $ = null)

Określa kod HTML, który należy przekonwertować into obrazie.

parametry

HTML - kod HTML do konwersji into obrazie
- Wymagane
Opcje - instancja GrabzItImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

FileToImage($ path, Opcje $ = null)

Określa plik HTML, który należy przekonwertować into obrazie.

parametry

ścieżka - ścieżka pliku HTML do konwersji into obrazie
- Wymagane
Opcje - instancja GrabzItImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

GrabzItImageOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów obrazu.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do usługi zrzutów ekranu. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
setBrowserWidth($value) - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
setBrowserHeight($value) - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
- Pełna długość: -1 (przekazanie -1 oznacza, że wykonano sceenshot całej strony)
setWidth($value) - szerokość wynikowej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono wysokość wyjściową, szerokość wyjściowa będzie proporcjonalna do wysokości wyjściowej
- Maksymalna: maksymalna szerokość paczki
- Pełna szerokość: -1 (przekazanie -1 oznacza, że szerokość miniatury nie jest zmniejszona)
setHeight($value) - wysokość powstałej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono szerokość wyjściową, wysokość wyjściowa będzie proporcjonalna do szerokości wyjściowej
- Maksymalna: maksymalna wysokość paczki
- Pełna wysokość: -1 (przekazanie -1 oznacza, że wysokość miniatury nie jest zmniejszona)
setFormat($value) - format, w jakim powinien być zrzut ekranu.
- Domyślnie: „jpg”
- Opcje: „bmp8”, „bmp16”, „bmp24”, „bmp”, „tiff”, „webp”, „jpg”, „png”
setDelay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
setClickElement($value) - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
setTargetElement($value) - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into zrzut ekranu, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
setHideElement($value) - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
setWaitForElement($value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
setRequestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
setCustomWaterMarkId($value) - dodaj niestandardowy watermark do obrazu
- Domyślnie: pusty
setQuality($value) - w jakość zwróconego obrazu. Obecnie wpływa to tylko na obrazy JPG i WEBP, które mają domyślną kompresję 90%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
setTransparent($value) - jeśli to prawda przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
- Domyślnie: false
setHD($value) - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
- Domyślnie: 0
setCountry($value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setNoAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
setNoCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
setAddress($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Metody publiczne

AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post

URLToRenderedHTML($ url, Opcje $ = null)

Określa adres URL, który należy przekonwertować into renderowany HTML.

parametry

url - adres URL, z którego powinien być wykonany renderowany HTML
- Wymagane
Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

HTMLToRenderedHTML($ html, Opcje $ = null)

Określa kod HTML, który należy przekonwertować into renderowany HTML.

parametry

HTML - kod HTML do konwersji into renderowany HTML
- Wymagane
Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

FileToRenderedHTML($ path, Opcje $ = null)

Określa plik HTML, który należy przekonwertować into renderowany HTML.

parametry

ścieżka - ścieżka pliku HTML do konwersji into renderowany HTML
- Wymagane
Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

GrabzItHTMLOptions

Klasa reprezentuje wszystkie opcje dostępne, kiedy tworzenie renderowanych zrzutów HTML.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
setBrowserWidth($value) - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
setBrowserHeight($value) - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
setDelay($value) - liczba milisekund do poczekaj przed wykonaniem zdjęcia
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
setWaitForElement($value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
setRequestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
setCountry($value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setNoAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
setNoCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
setAddress($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Metody publiczne

AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post

URLToPDF($ url, Opcje $ = null)

Określa adres URL, który należy przekonwertować into PDF.

parametry

url - adres URL, który należy przekonwertować into PDF
- Wymagane
Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

HTMLToPDF($ html, Opcje $ = null)

Określa kod HTML, który należy przekonwertować into PDF.

parametry

HTML - kod HTML do konwersji into PDF
- Wymagane
Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

FileToPDF($ path, Opcje $ = null)

Określa plik HTML, który należy przekonwertować into PDF.

parametry

ścieżka - ścieżka pliku HTML do konwersji into PDF
- Wymagane
Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

GrabzItPDFOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów PDF.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
setIncludeBackground($value) - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
- Domyślnie: true

setPageSize($value) - rozmiar strony pliku PDF
- Domyślnie: „A4”
- Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
setOrientation($value) - orientacja dokumentu PDF
- Domyślnie: „Portret”
- Opcje: „Portret”, „Krajobraz”
setCSSMediaType($value) - w CSS Media Typ dokumentu PDF
- Ekran domyślny"
- Opcje: „Ekran”, „Parint"
setIncludeLinks($value) - prawda, jeśli linki powinny być zawarte w pliku PDF
- Domyślnie: true
setIncludeOutline($value) - prawda, jeśli Zakładki PDF powinno być dołączone
- Domyślnie: false
setTitle($value) - podać tytuł dokumentu PDF
- Domyślnie: pusty
setCoverURL($value) - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
- Domyślnie: pusty
setMarginTop($value) - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
- Domyślnie: 10
setMarginLeft($value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
- Domyślnie: 10
setMarginBottom($value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
- Domyślnie: 10
setMarginRight($value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
- Domyślnie: 10
setBrowserWidth($value) - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu PDF)
setPageWidth($value) - w niestandardowa szerokość wynikowego pliku PDF w mm
- Zaniedbanie: rozmiar strony szerokość
- Minimum: 15
setPageHeight($value) - w niestandardowa wysokość wynikowego pliku PDF w mm
- Zaniedbanie: rozmiar strony wysokość
- Minimum: 15
setDelay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
setRequestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
setTemplateId($value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
- Domyślnie: pusty
setClickElement($value) - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
setTargetElement($value) - w Selektor CSS jedyny Element HTML na docelowej stronie internetowej, która ma zostać odwrócona into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
setHideElement($value) - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
setWaitForElement($value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
setCustomWaterMarkId($value) - dodaj niestandardowy watermark na każdej stronie dokumentu PDF
- Domyślnie: pusty
setQuality($value) - w jakość zwróconego pliku PDF. Domyślnie używana jest zalecana jakość pliku PDF.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
setCountry($value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setNoAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
setNoCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
setAddress($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty
setMergeId($value) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
- Domyślnie: pusty
setPassword($value) - w hasło do ochrony dokumentu PDF z
- Domyślnie: pusty

Metody publiczne

AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
AddTemplateParameter ($ nazwa, $ wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
- name - nazwa parametru szablonu
- wartość - wartość parametru szablonu

URLToDOCX ($ url, Opcje $ = null)

Określa adres URL, który należy przekonwertować into DOCX.

parametry

url - adres URL, który należy przekonwertować into DOCX
- Wymagane
Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

HTMLToDOCX($ html, Opcje $ = null)

Określa kod HTML, który należy przekonwertować into DOCX.

parametry

HTML - kod HTML do konwersji into DOCX
- Wymagane
Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

FileToDOCX($ path, Opcje $ = null)

Określa plik HTML, który należy przekonwertować into DOCX.

parametry

ścieżka - ścieżka pliku HTML do konwersji into DOCX
- Wymagane
Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

GrabzItDOCXOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia przechwytywania DOCX.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
- Domyślnie: pusty
setIncludeBackground($value) - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
- Domyślnie: true
setPageSize($value) - rozmiar strony DOCX
- Domyślnie: „A4”
- Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
setOrientation($value) - orientacja dokumentu DOCX
- Domyślnie: „Portret”
- Opcje: „Portret”, „Krajobraz”
setIncludeLinks($value) - prawda, jeśli linki powinny być zawarte w DOCX
- Domyślnie: true
setIncludeImages($value) - prawda, jeśli obrazy strony internetowej powinny być zawarte w DOCX
- Domyślnie: true
setTitle($value) - podać tytuł dokumentu DOCX
- Domyślnie: pusty
setMarginTop($value) - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
- Domyślnie: 10
setMarginLeft($value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
- Domyślnie: 10
setMarginBottom($value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
- Domyślnie: 10
setMarginRight($value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
- Domyślnie: 10
setBrowserWidth($value) - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu DOCX)
setPageWidth($value) - w niestandardowa szerokość wynikowego DOCX w mm
- Zaniedbanie: rozmiar strony szerokość
- Minimum: 15
setPageHeight($value) - w niestandardowa wysokość wynikowego DOCX w mm
- Zaniedbanie: rozmiar strony wysokość
- Minimum: 15
setDelay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
setRequestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
setTemplateId($value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
- Domyślnie: pusty
setClickElement($value) - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
setTargetElement($value) - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into DOCX, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
- Domyślnie: pusty
setHideElement($value) - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
- Domyślnie: pusty
setWaitForElement($value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
- Domyślnie: pusty
setQuality($value) - w jakość zwróconego DOCX. Domyślnie używana jest zalecana jakość dla DOCX.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
setCountry($value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setNoAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: false
setNoCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: false
setAddress($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty
setMergeId($value) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
- Domyślnie: pusty
setPassword($value) - w hasło do ochrony dokumentu DOCX z
- Domyślnie: pusty

Metody publiczne

AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
AddTemplateParameter ($ nazwa, $ wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
- name - nazwa parametru szablonu
- wartość - wartość parametru szablonu

URLToTable($ url, Opcje $ = null)

Określa adres URL, z którego należy wyodrębnić tabele HTML.

parametry

url - adres URL do wyodrębnienia tabel HTML
- Wymagane
Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

HTMLToTable ($ html, Opcje $ = null)

Określa kod HTML, z którego należy wyodrębnić tabele HTML.

parametry

html - HTML, z którego można wyodrębnić tabele HTML.
- Wymagane
Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

FileToTable ($ path, Opcje $ = null)

Określa plik HTML, z którego należy wyodrębnić tabele HTML.

parametry

ścieżka - ścieżka pliku HTML, z którego można wyodrębnić tabele HTML.
- Wymagane
Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

GrabzItTableOptions

Klasa reprezentuje wszystkie opcje dostępne podczas konwersji tabel HTML na CSV, XLSX lub JSON.

Właściwości publiczne

setCustomId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego
- Domyślnie: pusty
setTableNumberToInclude($value) - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
- Domyślnie: 1
setFormat($value) - format, w jakim powinna być tabela
- Domyślnie: „csv”
- Opcje: „csv”, „json”, „xlsx”
setIncludeHeaderNames($value) - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
- Domyślnie: true
setIncludeAllTables($value) - jeśli to prawda, wszystkie tabele na stronie internetowej zostaną wyodrębnione, a każdy z nich pojawi się w osobnym arkuszu kalkulacyjnym. Dostępne tylko w formacie XLSX
- Domyślnie: false
setClickElement($value) - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
setTargetElement($value) - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
- Domyślnie: pusty
setRequestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
  - 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
  - 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
setCountry($value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
setExportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
- Domyślnie: pusty
setEncryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
- Domyślnie: pusty
setAddress($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
- Domyślnie: pusty
setProxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
- Domyślnie: pusty

Metody publiczne

AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post

Save($ callBackURL = null)

Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z GetResult Metoda.

parametry

callBackURL - treser usługa GrabzIt powinna zadzwonić po zakończeniu pracy

Wartość zwracana

Unikalny identyfikator zrzutu ekranu, w przeciwnym razie, jeśli wystąpi błąd, zgłoszony zostanie wyjątek. Można tego użyć, aby uzyskać zrzut ekranu z GetResult metoda

Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku

SaveTo()

Save wynik synchronicznie do zmiennej zawierającej dane bajtu zrzutu ekranu.

Wartość zwracana

zwraca dane bajtowe pliku, jeśli zakończy się powodzeniem, w przeciwnym razie zgłasza wyjątek.

Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku

SaveTo($saveToPlik)

Save wynik synchronicznie do pliku.

parametry

saveToPlik - ścieżka do pliku, który będzie przechwytywany saved po zakończeniu
- Wymagane

Wartość zwracana

zwraca prawdę, jeśli się powiedzie, w przeciwnym razie zgłasza wyjątek.

GetStatus ($ id)

Uzyskaj aktualny status zrzutu ekranu GrabzIt.

parametry

id - unikalny identyfikator zrzutu ekranu
- Wymagane

Wartość zwracana

GrabzItStatus przedmiot

GetCookies ($ domain)

Zdobądź wszystkie pliki cookie, których używa GrabzIt dla określonej domeny. Może to również obejmować pliki cookie zdefiniowane przez użytkownika.

parametry

domena - domena, dla której zwracane są pliki cookie
- Wymagane

Wartość zwracana

GrabzItCookie szyk

SetCookie ($ name, $ domain, $ value = "", $ path = "/", $ httponly = false, $ expires = "")

Ustawia nowy niestandardowy plik cookie w GrabzIt, jeśli niestandardowy plik cookie ma taką samą nazwę i domenę jak globalny plik cookie, globalny plik cookie zostanie zastąpiony.

Może to być przydatne, jeśli funkcjonalność strony internetowej jest kontrolowana przez pliki cookie.

parametry

nazwa - nazwa pliku cookie, który należy ustawić
- Wymagane
domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
- Wymagane
wartość - wartość pliku cookie
ścieżka - ścieżka do strony, której dotyczy plik cookie
httponly - jeśli to prawda, plik cookie może być używany tylko z protokołem HTTP
wygasa - określa, kiedy wygasa plik cookie. Podaj wartość zerową, jeśli plik cookie nie wygasa
- Powinien być w formacie rrrr-mm-dd gg: mm: ss

Wartość zwracana

Prawda, jeśli plik cookie został pomyślnie ustawiony, w przeciwnym razie fałsz

DeleteCookie ($ name, $ domain)

Usuń niestandardowy plik cookie lub zablokuj używanie globalnego pliku cookie

parametry

nazwa - nazwa pliku cookie do usunięcia
- Wymagane
domena - domena strony internetowej, dla której chcesz usunąć plik cookie
- Wymagane

parametry

dane - zaszyfrowane bajty
- Wymagane
klucz - klucz szyfrujący
- Wymagane

DecryptFile ($ path, $ key)

Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.

parametry

ścieżka - ścieżka zaszyfrowanego przechwytywania
- Wymagane
klucz - klucz szyfrujący
- Wymagane

Klasy wyników

GrabzItCookie

Właściwości publiczne

Imię i nazwisko
- Nazwa ciasteczka
wartość
- Wartość pliku cookie.
Domena
- Domena, dla której ustawiony jest plik cookie.
ścieżka
- Ścieżka do domeny, której dotyczy ten plik cookie.
HttpOnly
- Jeśli ten plik cookie jest ważny tylko wtedy, gdy witryna jest przeglądana za pomocą protokołu HTTP.
Wygasa
- Data wygaśnięcia tego pliku cookie
Typ
- Jest to rodzaj pliku cookie, który może być jednym z następujących:
  - Globalny - jest to globalny plik cookie ustawiony przez GrabzIt
  - Lokalny - to lokalny plik cookie ustawiony przez Ciebie
  - Zastąpione - globalne ciasteczko, które zostało przez Ciebie zastąpione

GrabzItStatus

Klasa reprezentująca bieżący status zrzutu ekranu.

Właściwości publiczne

Processing
- Jeśli true, zrzut ekranu jest nadal przetwarzany.
Cached
- Jeśli true, zrzut ekranu został przetworzony i jest obecnie buforowany.
Expired
- Jeśli to prawda, zrzut ekranu nie jest już dostępny w systemie GrabzIt.
Message
- Komunikat o błędzie zwrócony przez system.

GrabzItWaterMark

Ta klasa reprezentuje niestandardowe watermarks przechowywane w GrabzIt

Właściwości publiczne

identyfikator
- Identyfikator watermark
XPozycja
- Poziome położenie watermark
  - Lewy = 0
  - Centrum = 1
  - Prawo = 2
YPosition
- Pionowa pozycja watermark
  - Góra = 0
  - Middle = 1
  - Dół = 2
utworzony
- Format watermark