Descrizione
Questa classe gestisce tutte le comunicazioni con i servizi web di screenshot di GrabzIt.
Metodi pubblici
- 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)
Questo metodo restituisce lo screenshot stesso. Se non viene restituito nulla, qualcosa è andato storto o lo screenshot non è ancora pronto.
parametri
-
id - l'identificatore univoco dello screenshot
Valore di ritorno
La cattura
URLToAnimation($ Url, $ options = null)
Specifica l'URL del video online che dovrebbe essere convertito into GIF animata.
parametri
-
url: l'URL del video online da convertire into una GIF animata.
- Obbligatorio
-
Accetta URL video di Vimeo e YouTube
- L'avvertimento dell'animazione di video Vimeo e YouTube dipende da una terza parte e pertanto potrebbe non fornire risultati coerenti.
- Opzioni - un'istanza del GrabzItAnimationOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione della GIF animata.
Valore di ritorno
nulla
GrabzItAnimationOptions
La classe rappresenta tutte le opzioni disponibili durante la creazione di una GIF animata.
Proprietà pubbliche
-
setCustomId($value) - identificativo personalizzato che è possibile passare al servizio web GIF animato. Questo verrà restituito con l'URL di callback che hai specificato.
-
setWidth($value) - la larghezza della GIF animata risultante in pixel.
- Predefinito: 180px
- Massima: larghezza massima per pacchetto
- Dimensione automatica: -1 (passando -1 significa che la larghezza di la GIF animata viene ridimensionata in relazione alla sua altezza, se la larghezza viene ridimensionata automaticamente, l'altezza non può)
-
setHeight($value) - l'altezza della GIF animata risultante in pixel.
- Predefinito: 120px
- Massimo: altezza massima per pacchetto
- Dimensione automatica: -1 (passando -1 significa che l'altezza di la GIF animata viene ridimensionata in relazione alla sua larghezza, se l'altezza viene ridimensionata automaticamente la larghezza non può)
-
setStart($value) - la posizione iniziale del video che dovrebbe essere convertito into GIF animata.
-
setDuration($value) - la lunghezza in secondi del video che dovrebbe essere convertito into GIF animata.
- Predefinito: lunghezza massima per il pacchetto
-
setSpeed($value) - la velocità della GIF animata.
- Predefinito: 1
- Minimo: 0.2
- Massimo: 10
-
setFramesPerSecond($value) - il numero di fotogrammi al secondo che devono essere acquisiti dal video.
- Predefinito: 10
- Minimo: 0.2
- Massimo: 60
-
setRepeat($value) - numero di volte per eseguire il ciclo della GIF animata.
- Predefinito: 0
- Ciclo continuo: 0
- Non ripetere mai: -1
-
setReverse($value) - se vero, i frame della GIF animata sono invertiti
-
setCustomWaterMarkId($value) - aggiungere un costume watermark or la nostra speciale watermark alla GIF animata
-
setQuality($value) - il qualità dell'immagine restituita, che ha una compressione predefinita di 85%.
- Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
- Predefinito: -1
- Minimo: -1
- Massimo: 100
-
setCountry($value) - Paese la GIF animata dovrebbe essere presa da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
URLToImage($ Url, $ options = null)
Specifica l'URL che dovrebbe essere convertito into uno screenshot di immagine.
parametri
-
url: l'URL di cui dovrebbe essere fatto lo screenshot
- Opzioni - un'istanza del GrabzItImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dello screenshot.
Valore di ritorno
nulla
HTMLToImage($ Html, $ options = null)
Specifica l'HTML che dovrebbe essere convertito into immagine.
parametri
-
html - l'HTML da convertire into immagine
- Opzioni - un'istanza del GrabzItImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un'immagine.
Valore di ritorno
nulla
FileToImage($ Path, $ options = null)
Specifica un file HTML che dovrebbe essere convertito into immagine.
parametri
-
percorso: il percorso del file di un file HTML da convertire into immagine
- Opzioni - un'istanza del GrabzItImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un'immagine.
Valore di ritorno
nulla
GrabzItImageOptions
La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni di immagini.
Proprietà pubbliche
-
setCustomId($value) - identificativo personalizzato che è possibile passare al servizio web screenshot. Questo verrà restituito con l'URL di callback che hai specificato.
-
setBrowserWidth($value) - la larghezza del browser in pixel
- Predefinito: 1366
- Massimo: 10000
-
setBrowserHeight($value) - l'altezza del browser in pixel
- Predefinito: 1170
- Massimo: 10000
- Lunghezza totale: -1 (passando -1 significa che viene presa una sequenza dell'intera pagina Web)
-
setWidth($value) - la larghezza della miniatura risultante in pixel
- Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se l'altezza dell'output è specificata, la larghezza dell'output sarà proporzionale all'altezza dell'output
- Massima: larghezza massima per pacchetto
- Larghezza intera: -1 (passando -1 significa che la larghezza della miniatura non viene ridotta)
-
setHeight($value) - l'altezza della miniatura risultante in pixel
- Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se la larghezza dell'output è specificata l'altezza dell'output sarà proporzionale alla larghezza dell'output
- Massimo: altezza massima per pacchetto
- Altezza totale: -1 (passando -1 significa che l'altezza della miniatura non viene ridotta)
-
setFormat($value) - il formato in cui dovrebbe essere lo screenshot.
- Predefinito: "jpg"
- Opzioni: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
-
setDelay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
- Predefinito: 0
- Massimo: 30000
-
setClickElement($value) - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
-
setTargetElement($value) - il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into screenshot, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
-
setHideElement($value) - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
-
setWaitForElement($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
-
setRequestAs($value) - il tipo di agente utente che si desidera utilizzare
- Predefinito: 0
-
Opzioni:
- 0 = indica che deve essere utilizzato l'agente utente di un browser standard
- 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
- 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
-
setCustomWaterMarkId($value) - aggiungere un costume watermark or la nostra speciale watermark all'immagine
-
setQuality($value) - il qualità dell'immagine restituita. Questo attualmente ha effetto solo sulle immagini JPG e WEBP, che hanno una compressione predefinita del 90%.
- Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
- Predefinito: -1
- Minimo: -1
- Massimo: 100
-
setTransparent($value) - se vero il l'acquisizione delle immagini dovrebbe essere trasparente. Questo è compatibile solo con immagini png e tiff.
-
setHD($value) - se vera l'immagine la cattura sarà in alta definizione questo raddoppia la dimensione delle dimensioni dell'immagine.
-
setCountry($value) - Paese lo screenshot dovrebbe essere preso da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setNoAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
-
setNoCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
-
setAddress($value) - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
Metodi pubblici
-
AddPostParameter ($ name, $ value) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
- name - il nome del parametro HTTP Post
- valore - il valore del parametro HTTP Post
URLToRenderedHTML($ Url, $ options = null)
Specifica l'URL che dovrebbe essere convertito into rendering HTML.
parametri
-
url: l'URL di cui deve essere composto l'HTML renderizzato
- Opzioni - un'istanza del GrabzItHTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dell'HTML renderizzato.
Valore di ritorno
nulla
HTMLToRenderedHTML($ Html, $ options = null)
Specifica l'HTML che dovrebbe essere convertito into rendering HTML.
parametri
-
html - l'HTML da convertire into rendering HTML
- Opzioni - un'istanza del GrabzItHTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di HTML renderizzato.
Valore di ritorno
nulla
FileToRenderedHTML($ Path, $ options = null)
Specifica un file HTML che dovrebbe essere convertito into rendering HTML.
parametri
-
percorso: il percorso del file di un file HTML da convertire into rendering HTML
- Opzioni - un'istanza del GrabzItHTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di HTML renderizzato.
Valore di ritorno
nulla
GrabzItHTMLOptions
La classe rappresenta tutte le opzioni disponibili quando creazione di acquisizioni HTML renderizzate.
Proprietà pubbliche
-
setCustomId($value) - identificativo personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
-
setBrowserWidth($value) - la larghezza del browser in pixel
- Predefinito: 1366
- Massimo: 10000
-
setBrowserHeight($value) - l'altezza del browser in pixel
- Predefinito: 1170
- Massimo: 10000
-
setDelay($value) - il numero di millisecondi a attendere prima di effettuare la cattura
- Predefinito: 0
- Massimo: 30000
-
setWaitForElement($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
-
setRequestAs($value) - il tipo di agente utente che si desidera utilizzare
- Predefinito: 0
-
Opzioni:
- 0 = indica che deve essere utilizzato l'agente utente di un browser standard
- 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
- 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
-
setCountry($value) - Paese lo screenshot dovrebbe essere preso da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setNoAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
-
setNoCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
-
setAddress($value) - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
Metodi pubblici
-
AddPostParameter ($ name, $ value) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
- name - il nome del parametro HTTP Post
- valore - il valore del parametro HTTP Post
URLToPDF($ Url, $ options = null)
Specifica l'URL che dovrebbe essere convertito into PDF.
parametri
-
url: l'URL che deve essere convertito into PDF
- Opzioni - un'istanza della classe GrabzItPDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.
Valore di ritorno
nulla
HTMLToPDF($ Html, $ options = null)
Specifica l'HTML che dovrebbe essere convertito into PDF.
parametri
-
html - l'HTML da convertire into PDF
- Opzioni - un'istanza della classe GrabzItPDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.
Valore di ritorno
nulla
FileToPDF($ Path, $ options = null)
Specifica un file HTML che dovrebbe essere convertito into PDF.
parametri
-
percorso: il percorso del file di un file HTML da convertire into PDF
- Opzioni - un'istanza della classe GrabzItPDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.
Valore di ritorno
nulla
GrabzItPDFOptions
La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni PDF.
Proprietà pubbliche
-
setCustomId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
-
setIncludeBackground($value) - se vero, lo sfondo della pagina Web deve essere incluso nello screenshot
-
setPageSize($value) - le dimensioni della pagina del PDF
- Predefinito: "A4"
- Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
-
setOrientation($value) - l'orientamento del documento PDF
- Predefinito: "Ritratto"
- Opzioni: "Ritratto", "Paesaggio"
-
setCSSMediaType($value) - il Tipo di supporto CSS del documento PDF
- Predefinito: "Schermo"
- Opzioni: "Schermo", "Print"
-
setIncludeLinks($value) - vero se i collegamenti devono essere inclusi nel PDF
-
setIncludeOutline($value) - vero se Segnalibri PDF dovrebbe essere incluso
-
setTitle($value) - fornire un titolo al documento PDF
-
setCoverURL($value) - l'URL di una pagina Web che dovrebbe essere utilizzata come copertina per il PDF
-
setMarginTop($value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento PDF
-
setMarginLeft($value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento PDF
-
setMarginBottom($value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento PDF
-
setMarginRight($value) - il margine in millimetri che dovrebbe apparire alla destra del documento PDF
-
setBrowserWidth($value) - il larghezza del browser in pixel
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
- Predefinito: 1366
- Massimo: 10000
- Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento PDF)
-
setPageWidth($value) - il larghezza personalizzata del PDF risultante in mm
-
setPageHeight($value) - il altezza personalizzata del PDF risultante in mm
-
setDelay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
- Predefinito: 0
- Massimo: 30000
-
setRequestAs($value) - il tipo di agente utente che si desidera utilizzare
- Predefinito: 0
-
Opzioni:
- 0 = indica che deve essere utilizzato l'agente utente di un browser standard
- 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
- 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
-
setTemplateId($value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento PDF
-
setClickElement($value) - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
-
setTargetElement($value) - il Selettore CSS dell'unico Elemento HTML sulla pagina Web di destinazione che deve essere trasformato into PDF, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
-
setHideElement($value) - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
-
setWaitForElement($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
-
setCustomWaterMarkId($value) - aggiungere un costume watermark or la nostra speciale watermark a ciascuna pagina del documento PDF
-
setQuality($value) - il qualità del PDF restituito. L'impostazione predefinita utilizza la qualità consigliata per un PDF.
- Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
- Predefinito: -1
- Minimo: -1
- Massimo: 100
-
setCountry($value) - Paese lo screenshot dovrebbe essere preso da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setNoAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
-
setNoCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
-
setAddress($value) - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
-
setMergeId($value) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento PDF
-
setPassword($value) - il password per proteggere il documento PDF con
Metodi pubblici
-
AddPostParameter ($ name, $ value) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
- name - il nome del parametro HTTP Post
- valore - il valore del parametro HTTP Post
-
AddTemplateParameter ($ name, $ value) - definire a modello personalizzato parametro e valore, questo metodo può essere chiamato più volte per aggiungere più parametri.
- name - il nome del parametro template
- value - il valore del parametro template
URLToDOCX ($ url, $ options = null)
Specifica l'URL che dovrebbe essere convertito into DOCX.
parametri
-
url: l'URL che deve essere convertito into DOCX
- Opzioni - un'istanza del GrabzItDOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.
Valore di ritorno
nulla
HTMLToDOCX($ Html, $ options = null)
Specifica l'HTML che dovrebbe essere convertito into DOCX.
parametri
-
html - l'HTML da convertire into DOCX
- Opzioni - un'istanza del GrabzItDOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.
Valore di ritorno
nulla
FileToDOCX($ Path, $ options = null)
Specifica un file HTML che dovrebbe essere convertito into DOCX.
parametri
-
percorso: il percorso del file di un file HTML da convertire into DOCX
- Opzioni - un'istanza del GrabzItDOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.
Valore di ritorno
nulla
GrabzItDOCXOptions
La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni DOCX.
Proprietà pubbliche
-
setCustomId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
-
setIncludeBackground($value) - se vero, le immagini di sfondo della pagina Web devono essere incluse nel DOCX
-
setPageSize($value) - le dimensioni della pagina del DOCX
- Predefinito: "A4"
- Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
-
setOrientation($value) - l'orientamento del documento DOCX
- Predefinito: "Ritratto"
- Opzioni: "Ritratto", "Paesaggio"
-
setIncludeLinks($value) - true se i collegamenti devono essere inclusi nel DOCX
-
setIncludeImages($value) - true se le immagini della pagina Web devono essere incluse nel DOCX
-
setTitle($value) - fornire un titolo al documento DOCX
-
setMarginTop($value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento DOCX
-
setMarginLeft($value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento DOCX
-
setMarginBottom($value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento DOCX
-
setMarginRight($value) - il margine in millimetri che dovrebbe apparire alla destra del documento DOCX
-
setBrowserWidth($value) - il larghezza del browser in pixel
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
- Predefinito: 1366
- Massimo: 10000
- Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento DOCX)
-
setPageWidth($value) - il larghezza personalizzata del DOCX risultante in mm
-
setPageHeight($value) - il altezza personalizzata del DOCX risultante in mm
-
setDelay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
- Predefinito: 0
- Massimo: 30000
-
setRequestAs($value) - il tipo di agente utente che si desidera utilizzare
- Predefinito: 0
-
Opzioni:
- 0 = indica che deve essere utilizzato l'agente utente di un browser standard
- 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
- 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
-
setTemplateId($value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento DOCX
-
setClickElement($value) - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
-
setTargetElement($value) - il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into DOCX, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
-
setHideElement($value) - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
-
setWaitForElement($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
-
setQuality($value) - il qualità del DOCX restituito. L'impostazione predefinita utilizza la qualità consigliata per un DOCX.
- Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
- Predefinito: -1
- Minimo: -1
- Massimo: 100
-
setCountry($value) - Paese lo screenshot dovrebbe essere preso da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setNoAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
-
setNoCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
-
setAddress($value) - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
-
setMergeId($value) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento DOCX
-
setPassword($value) - il password per proteggere il documento DOCX con
Metodi pubblici
-
AddPostParameter ($ name, $ value) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
- name - il nome del parametro HTTP Post
- valore - il valore del parametro HTTP Post
-
AddTemplateParameter ($ name, $ value) - definire a modello personalizzato parametro e valore, questo metodo può essere chiamato più volte per aggiungere più parametri.
- name - il nome del parametro template
- value - il valore del parametro template
URLToTable($ Url, $ options = null)
Specifica l'URL da cui devono essere estratte le tabelle HTML.
parametri
-
url - l'URL da cui estrarre le tabelle HTML
- Opzioni - un'istanza del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.
Valore di ritorno
nulla
HTMLToTable ($ html, $ options = null)
Specifica l'HTML da cui devono essere estratte le tabelle HTML.
parametri
-
html - l'HTML da cui estrarre le tabelle HTML.
- Opzioni - un'istanza del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.
Valore di ritorno
nulla
FileToTable ($ path, $ options = null)
Specifica un file HTML da cui estrarre le tabelle HTML.
parametri
-
percorso: il percorso del file di un file HTML da cui estrarre le tabelle HTML.
- Opzioni - un'istanza del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.
Valore di ritorno
nulla
GrabzItTableOptions
La classe rappresenta tutte le opzioni disponibili durante la conversione di tabelle HTML in CSV, XLSX o JSON.
Proprietà pubbliche
-
setCustomId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato
-
setTableNumberToInclude($value) - l'indice della tabella da convertire, dove tutte le tabelle di una pagina Web sono ordinate dalla parte superiore della pagina Web verso il basso
-
setFormat($value) - il formato in cui deve essere la tabella
- Predefinito: "csv"
- Opzioni: "csv", "json", "xlsx"
-
setIncludeHeaderNames($value) - se nella tabella saranno inclusi i nomi di intestazioni vere
-
setIncludeAllTables($value) - se vero, tutta la tabella della pagina Web verrà estratta con ciascuna tabella visualizzata in un foglio di calcolo separato. Disponibile solo con il formato XLSX
-
setClickElement($value) - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
- Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
-
setTargetElement($value) - l'id dell'unico elemento HTML nella pagina Web da cui utilizzare per estrarre le tabelle
-
setRequestAs($value) - il tipo di agente utente che si desidera utilizzare
- Predefinito: 0
-
Opzioni:
- 0 = indica che deve essere utilizzato l'agente utente di un browser standard
- 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
- 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
-
setCountry($value) - Paese lo screenshot dovrebbe essere preso da.
- Predefinito: la posizione più veloce corrente
- Opzioni: "SG", "UK", "US"
-
setExportURL($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
-
setEncryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
-
setAddress($value) - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
-
setProxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
Metodi pubblici
-
AddPostParameter ($ name, $ value) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
- name - il nome del parametro HTTP Post
- valore - il valore del parametro HTTP Post
Save($ callBackURL = null)
Save il risultato in modo asincrono e restituisce un identificatore univoco, che può essere utilizzato per ottenere lo screenshot con il GetResult metodo.
parametri
-
callBackURL - il Handler il servizio GrabzIt dovrebbe chiamare dopo aver completato il suo lavoro
Valore di ritorno
L'identificatore univoco dello screenshot, altrimenti in caso di errore viene generata un'eccezione. Questo può essere usato per ottenere lo screenshot con il GetResult metodo
Avvertendo questo metodo è sincrono, quindi l'applicazione verrà messa in pausa mentre il risultato viene elaborato
SaveTo()
Save il risultato in modo sincrono con una variabile contenente i dati del byte dello screenshot.
Valore di ritorno
restituisce i dati byte del file in caso di successo, altrimenti genera un'eccezione.
Avvertendo questo metodo è sincrono, quindi l'applicazione verrà messa in pausa mentre il risultato viene elaborato
SaveTo($saveToFare la fila)
Save il risultato in modo sincrono in un file.
parametri
-
saveToFile: il percorso del file che verrà acquisito sarà saveda una volta che è stato completato
Valore di ritorno
restituisce il vero se ha esito positivo, altrimenti genera un'eccezione.
GetStatus ($ id)
Ottieni lo stato corrente di uno screenshot di GrabzIt.
parametri
-
id - l'identificatore univoco dello screenshot
Valore di ritorno
GrabzItStatus oggetto
GetCookies ($ dominio)
Ricevi tutti i cookie che GrabzIt utilizza per un determinato dominio. Ciò può includere anche i cookie definiti dall'utente.
parametri
-
dominio - il dominio per cui restituire i cookie
Valore di ritorno
GrabzItCookie schieramento
SetCookie ($ name, $ domain, $ value = "", $ path = "/", $ httponly = false, $ expires = "")
Imposta un nuovo cookie personalizzato su GrabzIt, se il cookie personalizzato ha lo stesso nome e dominio di un cookie globale, il cookie globale viene sovrascritto.
Ciò può essere utile se la funzionalità di un sito Web è controllata dai cookie.
parametri
-
nome: il nome del cookie da impostare
-
dominio - il dominio del sito Web per cui impostare il cookie
- valore - il valore del cookie
- percorso: il percorso del sito Web a cui si riferisce il cookie
- httponly - se vero, il cookie può essere utilizzato solo con il protocollo HTTP
-
scade: definisce quando scade il cookie. Passa un valore nullo se il cookie non deve scadere
- Dovrebbe essere nel formato aaaa-mm-gg hh: mm: ss
Valore di ritorno
Vero se il cookie è impostato correttamente, altrimenti falso
DeleteCookie ($ name, $ domain)
Elimina un cookie personalizzato o blocca l'utilizzo di un cookie globale
parametri
-
nome: il nome del cookie da eliminare
-
dominio - il dominio del sito Web per cui eliminare il cookie
Valore di ritorno
Vero se il cookie viene eliminato correttamente, altrimenti falso
OttieniWaterMarks()
Ottieni il tuo personalizzato caricato watermarks
Valore di ritorno
GrabzItWaterMark schieramento
OttieniWaterMark($ Identificatore)
Restituisci la tua abitudine watermarks che corrisponde all'identificatore specificato
parametri
-
identificatore: l'identificatore di una particolare consuetudine watermark si desidera visualizzare
Valore di ritorno
GrabzItWaterMark
AggiungiWaterMark($ identificatore, $ percorso, $ xpos, $ ypos)
Aggiungi una nuova personalizzazione watermark
parametri
-
identificatore: l'identificatore che desideri assegnare alla personalizzazione watermark. È importante che questo identificatore sia univoco.
-
path - il percorso assoluto di watermark sul tuo server. Ad esempio C: /watermark/1.png
-
xpos - la posizione orizzontale in cui vuoi che appaia lo screenshot
- Obbligatorio
-
Opzioni:
- Sinistra = 0
- Centro = 1
- Destra = 2
-
ypos - posizione verticale in cui vuoi che appaia lo screenshot
- Obbligatorio
-
Opzioni:
- Superiore = 0
- Medio = 1
- In basso = 2
Valore di ritorno
restituisce vero se il watermark è stato impostato con successo
DeleteWaterMark($ Identificatore)
Elimina un'abitudine watermark
parametri
-
identificatore: l'identificatore dell'abitudine watermark si desidera eliminare
Valore di ritorno
restituisce vero se il watermark è stato cancellato con successo
SetLocalProxy ($ proxyurl)
Questo metodo consente a server proxy locale da utilizzare per tutte le richieste.
parametri
-
proxyUrl: l'URL, che può includere una porta, se necessario, del proxy. Fornire un valore null rimuoverà qualsiasi proxy precedentemente impostato
UseSSL ($ value)
Specifica se le richieste a GrabzIt's L'API dovrebbe usare SSL o no
parametri
-
valore - se vero tutte le richieste all'API di GrabzIt utilizzeranno SSL
CreateEncryptionKey ()
Crea una chiave di crittografia 64 di base crittograficamente sicura, lunga 44 caratteri.
Decifrare ($ data, $ chiave)
Decifrare un'acquisizione crittografata utilizzando la chiave di crittografia fornita.
parametri
DecryptFile ($ percorso, $ chiave)
Decifrare un'acquisizione crittografata utilizzando la chiave di crittografia fornita.
parametri
Classi di risultati
GrabzItCookie
Proprietà pubbliche
-
Nome
-
Valore
-
Dominio
- Il dominio per cui è impostato il cookie.
-
sentiero
- Il percorso sul dominio a cui si applica questo cookie.
-
HttpOnly
- Se questo cookie è valido solo quando il sito Web viene visualizzato con il protocollo HTTP.
-
Scade
- La data di scadenza di questo cookie
-
Tipologia
-
Questo è il tipo di cookie, che può essere uno dei seguenti:
- Globale: questo è un cookie globale impostato da GrabzIt
- Locale: questo è un cookie locale impostato da te
- Sostituito: un cookie globale che è stato sovrascritto da te
GrabzItStatus
La classe che rappresenta lo stato corrente dello screenshot.
Proprietà pubbliche
-
Processing
- Se vero, lo screenshot è ancora in fase di elaborazione.
-
Cached
- Se vero, lo screenshot è stato elaborato ed è attualmente memorizzato nella cache.
-
Expired
- Se vero, lo screenshot non è più sul sistema GrabzIt.
-
Message
- Un messaggio di errore restituito dal sistema.
GrabzItWaterMark
Questa classe rappresenta l'usanza watermarks archiviato in GrabzIt
Proprietà pubbliche
-
Identifier
- L'identificatore del file watermark
-
XPOSITION
-
La posizione orizzontale del watermark
- Sinistra = 0
- Centro = 1
- Destra = 2
-
YPosition
-
La posizione verticale del watermark
- Superiore = 0
- Medio = 1
- In basso = 2
-
Formato
- Il formato del file watermark