Descrição
Esta classe lida com toda a comunicação com os serviços da Web de captura de tela GrabzIt.
Métodos públicos
- GetResult($id)
- URLToAnimation($url, $options)
- URLToImage($url, $options)
- HTMLToImage($html, $options)
- FileToImage($path, $options)
- URLToPDF($url, $options)
- HTMLToPDF($html, $options)
- FileToPDF($path, $options)
- URLToDOCX($url, $options)
- HTMLToDOCX($html, $options)
- FileToDOCX($path, $options)
- URLToTable($url, $options)
- HTMLToTable($html, $options)
- FileToTable($path, $options)
- URLToRenderedHTML($url, $options)
- HTMLToRenderedHTML($html, $options)
- FileToRenderedHTML($path, $options)
- Save($callBackURL = '')
- SaveTo()
- SaveTo($saveToFile)
- GetStatus($id)
- GetCookies($domain)
- SetCookie($name, $domain, $value = '', $path = '/', $httponly = 0, $expires = '')
- DeleteCookie($name, $domain)
- GetWaterMarks()
- GetWaterMark($identifier)
- AddWaterMark($identifier, $path, $xpos, $ypos)
- DeleteWaterMark($identifier)
- UseSSL($value)
GetResult($ id)
Este método retorna a própria captura de tela. Se nada for retornado, algo deu errado ou a captura de tela ainda não está pronta.
parâmetros
-
id - o identificador exclusivo da captura de tela
Valor de retorno
A captura
URLToAnimation($ url, $ opções)
Especifique o URL do vídeo online que deve ser convertido intum GIF animado.
parâmetros
-
url - o URL do vídeo online a ser convertido into um GIF animado.
- Exigido
-
Aceita URLs de vídeo do Vimeo e do YouTube
- O aviso de animação de vídeos do Vimeo e do YouTube depende de terceiros e, portanto, pode não fornecer resultados consistentes.
- opções - uma instância do GrabzItAnimationOptions classe que define todas as opções especiais a serem usadas ao criar o GIF animado.
Valor de retorno
anular
GrabzItAnimationOptions
A classe representa todas as opções disponíveis ao criar um GIF animado.
Propriedades Públicas
-
customId($value) - identificador personalizado pelo qual você pode passar para o serviço da web GIF animado. Isso será retornado com o URL de retorno que você especificou.
-
width($value) - a largura do GIF animado resultante em pixels.
- Padrão: 180px
- Máximo: Largura máxima para o pacote
- Tamanho automático: -1 (passar -1 significa que a largura do GIF animado é redimensionado em relação à sua altura, se a largura estiver sendo dimensionada automaticamente, a altura não poderá)
-
height($value) - a altura do GIF animado resultante em pixels.
- Padrão: 120px
- Máximo: Altura máxima para o pacote
- Tamanho automático: -1 (passar -1 significa que a altura do GIF animado é redimensionado em relação à sua largura, se a altura estiver sendo dimensionada automaticamente, a largura não poderá)
-
start($value) - a posição inicial do vídeo que deve ser convertida intum GIF animado.
-
duration($value) - a duração em segundos do vídeo que deve ser convertido intum GIF animado.
- Padrão: comprimento máximo para o pacote
-
speed($value) - a velocidade do GIF animado.
- Padrão: 1
- Mínimo: 0.2
- Máximo: 10
-
framesPerSecond($value) - o número de quadros por segundo que devem ser capturados do vídeo.
- Padrão: 10
- Mínimo: 0.2
- Máximo: 60
-
repeat($value) - número de vezes para repetir o GIF animado.
- Padrão: 0
- Loop continuamente: 0
- Nunca Loop: -1
-
reverse($value) - se 1, os quadros do GIF animado são revertidos
-
customWaterMarkId($value) - adicionar personalizado watermark para o GIF animado
-
quality($value) - a qualidade da imagem retornada, que possui uma compactação padrão de 85%.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
-
country($value) - o país o GIF animado deve ser retirado.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Como o Perl possui instalações de criptografia nativa precárias, é necessário siga estas instruções descriptografar uma captura criptografada.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
URLToImage($ url, $ opções)
Especifica o URL que deve ser convertido intuma captura de tela da imagem.
parâmetros
-
url - o URL do qual a captura de tela deve ser feita
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar a captura de tela.
Valor de retorno
anular
HTMLToImage($ html, $ opções)
Especifica o HTML que deve ser convertido intuma imagem.
parâmetros
-
html - o HTML para converter intoa imagem
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.
Valor de retorno
anular
FileToImage($ caminho, $ opções)
Especifica um arquivo HTML que deve ser convertido intuma imagem.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa imagem
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.
Valor de retorno
anular
GrabzItImageOptions
A classe representa todas as opções disponíveis ao criar capturas de imagens.
Propriedades Públicas
-
customId($value) - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
-
browserWidth($value) - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
-
browserHeight($value) - a altura do navegador em pixels
- Padrão: 1170
- Máximo: 10000
- Comprimento total: -1 (passar -1 significa que é feita uma captura de tela de toda a página da web)
-
width($value) - a largura da miniatura resultante em pixels
- Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final, se a altura de saída for especificada, a largura de saída será proporcional à altura de saída
- Máximo: Largura máxima para o pacote
- Largura total: -1 (passar -1 significa que a largura da miniatura não é reduzida)
-
height($value) - a altura da miniatura resultante em pixels
- Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final; se a largura de saída for especificada, a altura de saída será proporcional à largura de saída
- Máximo: Altura máxima para o pacote
- Altura total: -1 (passar -1 significa que a altura da miniatura não é reduzida)
-
format($value) - o formato em que a captura de tela deve estar.
- Padrão: "jpg"
- Opções: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
-
delay($value) - o número de milissegundos a aguarde antes de tirar a captura de tela
-
clickElement($value) - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
targetElement($value) - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into uma captura de tela, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
-
hideElement($value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
-
waitForElement($value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
requestAs($value) - o tipo de agente do usuário que você deseja usar
- Padrão: 0
-
opções:
- 0 = indica que o agente do usuário de um navegador padrão deve ser usado
- 1 = indica que o agente do usuário de um navegador móvel deve ser usado
- 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
-
customWaterMarkId($value) - adicione um personalizado watermark para a imagem
-
quality($value) - a qualidade da imagem retornada. Atualmente, isso afeta apenas imagens JPG e WEBP, que têm uma compactação padrão de 90%.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
-
transparent($value) - se 1 o a captura de imagem deve ser transparente. Isso é compatível apenas com imagens png e tiff.
-
hd($value) - se 1 a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
-
country($value) - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Como o Perl possui instalações de criptografia nativa precárias, é necessário siga estas instruções descriptografar uma captura criptografada.
-
noAds($value) - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications($value) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
address($value) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usa URLs relativos a recursos como CSS e imagens.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
Métodos públicos
-
AddPostParameter ($ name, $ value) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
- name - o nome do parâmetro HTTP Post
- value - o valor do parâmetro HTTP Post
URLToRenderedHTML($ url, $ opções = nulo)
Especifica o URL que deve ser convertido into HTML renderizado.
parâmetros
-
url - a URL da qual o HTML renderizado deve ser feito
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar o HTML renderizado.
Valor de retorno
anular
HTMLToRenderedHTML($ html, $ opções = nulo)
Especifica o HTML que deve ser convertido into HTML renderizado.
parâmetros
-
html - o HTML para converter into HTML renderizado
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.
Valor de retorno
anular
FileToRenderedHTML($ caminho, $ opções = nulo)
Especifica um arquivo HTML que deve ser convertido into HTML renderizado.
parâmetros
-
path - o caminho do arquivo HTML para converter into HTML renderizado
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.
Valor de retorno
anular
GrabzItHTMLOptions
A classe representa todas as opções disponíveis quando criando capturas HTML renderizadas.
Propriedades Públicas
-
customId($value) - identificador personalizado que você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
-
browserWidth($value) - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
-
browserHeight($value) - a altura do navegador em pixels
- Padrão: 1170
- Máximo: 10000
-
delay($value) - o número de milissegundos a aguarde antes de fazer a captura
-
waitForElement($value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
requestAs($value) - o tipo de agente do usuário que você deseja usar
- Padrão: 0
-
opções:
- 0 = indica que o agente do usuário de um navegador padrão deve ser usado
- 1 = indica que o agente do usuário de um navegador móvel deve ser usado
- 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
-
country($value) - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
-
noAds($value) - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications($value) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
address($value) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
Métodos públicos
-
AddPostParameter ($ name, $ value) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
- name - o nome do parâmetro HTTP Post
- value - o valor do parâmetro HTTP Post
URLToPDF($ url, $ opções)
Especifica o URL que deve ser convertido intum PDF.
parâmetros
-
url - o URL que deve ser convertido intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
HTMLToPDF($ html, $ opções)
Especifica o HTML que deve ser convertido intum PDF.
parâmetros
-
html - o HTML para converter intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
FileToPDF($ caminho, $ opções)
Especifica um arquivo HTML que deve ser convertido intum PDF.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
GrabzItPDFOptions
A classe representa todas as opções disponíveis ao criar capturas de PDF.
Propriedades Públicas
-
customId($value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
-
includeBackground($value) - se o 1, o plano de fundo da página da web deve ser incluído no PDF
-
pagesize($value) - o tamanho da página do PDF
- Padrão: "A4"
- Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
-
orientation($value) - a orientação do documento PDF
- Padrão: "Retrato"
- Opções: "Retrato", "Paisagem"
-
cssMediaType($value) - a Tipo de mídia CSS do documento PDF
- Tela padrão"
- Opções: "Tela", "Print"
-
includeLinks($value) - 1 se os links devem ser incluídos no PDF
-
includeOutline($value) - 1 se Favoritos em PDF Deveria ser incluído
-
title($value) - forneça um título para o documento PDF
-
coverURL($value) - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
-
marginTop($value) - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
-
marginLeft($value) - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
-
marginBottom($value) - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
-
marginRight($value) - a margem em milímetros que deve aparecer à direita do documento PDF
-
browserWidth($value) - a largura do navegador em pixels
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
- Padrão: 1366
- Máximo: 10000
- Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento PDF)
-
pageWidth - a largura personalizada do PDF resultante em mm
-
pageHeight - a altura personalizada do PDF resultante em mm
-
delay($value) - o número de milissegundos a aguarde antes de tirar a captura de tela
-
requestAs($value) - o tipo de agente do usuário que você deseja usar
- Padrão: 0
-
opções:
- 0 = indica que o agente do usuário de um navegador padrão deve ser usado
- 1 = indica que o agente do usuário de um navegador móvel deve ser usado
- 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
-
templateId($value) - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
-
clickElement($value) - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
targetElement($value) - a Seletor CSS dos únicos Elemento HTML na página da web de destino a ser ativada intoa PDF, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
-
hideElement($value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
-
waitForElement($value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
customWaterMarkId($value) - adicione um personalizado watermark para cada página do documento PDF
-
quality($value) - a qualidade do PDF retornado. O padrão usa a qualidade recomendada para um PDF.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
-
country($value) - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Como o Perl possui instalações de criptografia nativa precárias, é necessário siga estas instruções descriptografar uma captura criptografada.
-
noAds($value) - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications($value) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
address($value) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usa URLs relativos a recursos como CSS e imagens.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
mergeId($value) - o ID de uma captura que deve ser mesclados no início do novo documento PDF
-
password($value) - a senha para proteger o documento PDF com
Métodos públicos
-
AddPostParameter ($ name, $ value) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
- name - o nome do parâmetro HTTP Post
- value - o valor do parâmetro HTTP Post
-
AddTemplateParameter ($ name, $ value) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
- nome - o nome do parâmetro do modelo
- valor - o valor do parâmetro do modelo
URLToDOCX ($ url, $ opções)
Especifica o URL que deve ser convertido into DOCX.
parâmetros
-
url - o URL que deve ser convertido into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
HTMLToDOCX($ html, $ opções)
Especifica o HTML que deve ser convertido into DOCX.
parâmetros
-
html - o HTML para converter into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
FileToDOCX($ caminho, $ opções)
Especifica um arquivo HTML que deve ser convertido into DOCX.
parâmetros
-
path - o caminho do arquivo HTML para converter into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
GrabzItDOCXOptions
A classe representa todas as opções disponíveis ao criar capturas de DOCX.
Propriedades Públicas
-
customId($value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
-
setIncludeBackground($value) - se 1, as imagens de plano de fundo da página da web devem ser incluídas na captura de tela
-
pagesize($value) - o tamanho da página do DOCX
- Padrão: "A4"
- Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
-
orientation($value) - a orientação do documento DOCX
- Padrão: "Retrato"
- Opções: "Retrato", "Paisagem"
-
includeLinks($value) - 1 se links devem ser incluídos no DOCX
-
includeImages($value) - se 1, as imagens de plano de fundo da página da web devem ser incluídas na captura de tela
-
title($value) - fornecer um título ao documento DOCX
-
marginTop($value) - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
-
marginLeft($value) - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
-
marginBottom($value) - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
-
marginRight($value) - a margem em milímetros que deve aparecer à direita do documento DOCX
-
browserWidth($value) - a largura do navegador em pixels
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
- Padrão: 1366
- Máximo: 10000
- Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento DOCX)
-
pageWidth - a largura personalizada do DOCX resultante em mm
-
pageHeight - a altura personalizada do DOCX resultante em mm
-
delay($value) - o número de milissegundos a aguarde antes de tirar a captura de tela
-
requestAs($value) - o tipo de agente do usuário que você deseja usar
- Padrão: 0
-
opções:
- 0 = indica que o agente do usuário de um navegador padrão deve ser usado
- 1 = indica que o agente do usuário de um navegador móvel deve ser usado
- 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
-
templateId($value) - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
-
clickElement($value) - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
targetElement($value) - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into DOCX, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
-
hideElement($value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
-
waitForElement($value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
quality($value) - a qualidade do DOCX devolvido. O padrão usa a qualidade recomendada para um DOCX.
- Reduzir a qualidade reduzirá o tamanho do arquivo e os tempos de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
-
country($value) - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Como o Perl possui instalações de criptografia nativa precárias, é necessário siga estas instruções descriptografar uma captura criptografada.
-
noAds($value) - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications($value) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
address($value) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usa URLs relativos a recursos como CSS e imagens.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
mergeId($value) - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
-
password($value) - a senha para proteger o documento DOCX com
Métodos públicos
-
AddPostParameter ($ name, $ value) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
- name - o nome do parâmetro HTTP Post
- value - o valor do parâmetro HTTP Post
-
AddTemplateParameter ($ name, $ value) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
- nome - o nome do parâmetro do modelo
- valor - o valor do parâmetro do modelo
URLToTable($ url, $ opções)
Especifica a URL da qual as tabelas HTML devem ser extraídas.
parâmetros
-
url - o URL para extrair tabelas HTML de
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
HTMLToTable ($ html, $ opções)
Especifica o HTML do qual as tabelas HTML devem ser extraídas.
parâmetros
-
html - o HTML para extrair tabelas HTML.
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
FileToTable ($ path, $ opções)
Especifica um arquivo HTML do qual as tabelas HTML devem ser extraídas.
parâmetros
-
path - o caminho do arquivo HTML para extrair as tabelas HTML.
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
GrabzItTableOptions
A classe representa todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.
Propriedades Públicas
-
customId($value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou
-
tableNumberToInclude($value) - o índice da tabela a ser convertida, onde todas as tabelas em uma página da web são ordenadas da parte superior da página para a parte inferior
-
format($value) - o formato em que a tabela deve estar
- Padrão: "csv"
- Opções: "csv", "json", "xlsx"
-
includeHeaderNames($value) - se os nomes de cabeçalho 1 serão incluídos na tabela
-
includeAllTables($value) - se 1 toda a tabela na página da Web for extraída, cada tabela sendo exibida em uma planilha separada. Disponível apenas no formato XLSX
-
targetElement($value) - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
-
requestAs($value) - o tipo de agente do usuário que você deseja usar
- Padrão: 0
-
opções:
- 0 = indica que o agente do usuário de um navegador padrão deve ser usado
- 1 = indica que o agente do usuário de um navegador móvel deve ser usado
- 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
-
country($value) - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
-
exportURL($value) - a URL de exportação que especifica onde a captura também deve ser exportada
-
encryptionKey($value) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Como o Perl possui instalações de criptografia nativa precárias, é necessário siga estas instruções descriptografar uma captura criptografada.
-
address($value) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usa URLs relativos a recursos como CSS e imagens.
-
proxy($value) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
Métodos públicos
-
AddPostParameter ($ name, $ value) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
- name - o nome do parâmetro HTTP Post
- value - o valor do parâmetro HTTP Post
Este é o método recomendado para salvar um arquivo
Save($ callBackURL = '')
Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o GetResult método.
parâmetros
-
callBackURL - o treinador o serviço GrabzIt deve ligar depois de concluir seu trabalho
Valor de retorno
O identificador exclusivo da captura de tela, caso contrário, se ocorrer um erro, uma exceção será lançada. Isso pode ser usado para obter a captura de tela com o GetResult método
Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado
SaveTo()
Save o resultado de forma síncrona com uma variável que contém os dados dos bytes da captura de tela.
Valor de retorno
retorna os dados de bytes do arquivo, se for bem-sucedido, caso contrário, lança uma exceção.
Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado
SaveTo($saveToArquivo)
Save o resultado de forma síncrona com um arquivo.
parâmetros
-
saveToArquivo - o caminho do arquivo que a captura será saved uma vez que tenha sido concluída
Valor de retorno
retorna o 1 se for bem-sucedido, caso contrário, lança uma exceção.
GetStatus ($ id)
Obtenha o status atual de uma captura de tela do GrabzIt.
parâmetros
-
id - o identificador exclusivo da captura de tela
Valor de retorno
GrabzItStatus objeto
GetCookies ($ domínio)
Obtenha todos os cookies que o GrabzIt está usando para um domínio específico. Isso também pode incluir cookies definidos pelo usuário.
parâmetros
-
domínio - o domínio para o qual retornar cookies para
Valor de retorno
GrabzItCookie ordem
SetCookie ($ nome, $ domínio, $ valor = '', $ caminho = '/', $ httponly = 0, $ expires = '')
Define um novo cookie personalizado no GrabzIt. Se o cookie personalizado tiver o mesmo nome e domínio que um cookie global, o cookie global será substituído.
Isso pode ser útil se a funcionalidade de um site for controlada por cookies.
parâmetros
-
nome - o nome do cookie a ser definido
-
domínio - o domínio do site para definir o cookie para
- valor - o valor do cookie
- path - o caminho do site ao qual o cookie está relacionado
- httponly - se 1, o cookie pode ser usado apenas com o protocolo HTTP
-
expira - define quando o cookie expira. Passe um valor nulo se o cookie não expirar
- Deve estar no formato aaaa-mm-dd hh: mm: ss
Valor de retorno
1 se o cookie for definido com êxito, caso contrário 0
DeleteCookie ($ nome, $ domínio)
Excluir um cookie personalizado ou impedir que um cookie global seja usado
parâmetros
-
nome - o nome do cookie a ser excluído
-
domínio - o domínio do site para excluir o cookie para
Valor de retorno
1 se o cookie for excluído com êxito, caso contrário, 0
GetWaterMarks()
Obtenha seu personalizado enviado watermarks
Valor de retorno
GrabzItWaterMark ordem
GetWaterMark(identificador $)
Devolva seu costume watermarks que corresponde ao identificador especificado
parâmetros
-
identificador - o identificador de um determinado costume watermark você quer ver
Valor de retorno
GrabzItWaterMark
AdicionarWaterMark($ identificador, $ caminho, $ xpos, $ ypos)
Adicionar um novo personalizado watermark
parâmetros
-
identificador - o identificador que você deseja fornecer ao watermark. É importante que esse identificador seja único.
-
caminho - o caminho absoluto do watermark no seu servidor. Por exemplo C: /watermark/1.png
-
xpos - a posição horizontal em que você deseja que a captura de tela apareça
- Exigido
-
opções:
- Esquerda = 0
- Centro = 1
- Direita = 2
-
ypos - posição vertical em que você deseja que a captura de tela apareça
- Exigido
-
opções:
- Topo = 0
- Médio = 1
- Parte inferior = 2
Valor de retorno
retorna 1 se o watermark foi definido com sucesso
DeleteWaterMark(identificador $)
Excluir um personalizado watermark
parâmetros
-
identificador - o identificador do costume watermark você quer deletar
Valor de retorno
retorna 1 se o watermark foi excluído com sucesso
UseSSL (valor $)
Especifica se as solicitações ao GrabzIt API deve usar SSL ou não
parâmetros
-
valor - se 1 todos os pedidos à API do GrabzIt usarem SSL
Classes de resultado
GrabzItCookie
Métodos públicos
-
getName ()
-
Obter valor()
-
getDomain ()
- O domínio para o qual o cookie está definido.
-
getPath ()
- O caminho no domínio ao qual este cookie se aplica.
-
getHttpOnly ()
- Se este cookie for válido apenas quando o site for visualizado com o protocolo HTTP.
-
getExpires ()
- A data em que esse cookie expira
-
getType ()
-
O tipo de cookie é esse, que pode ser um dos seguintes:
- Global - este é um cookie global definido por GrabzIt
- Local - este é um cookie local definido por você
- Substituído - um cookie global que foi substituído por você
GrabzItStatus
A classe que representa o status atual da captura de tela.
Métodos públicos
-
getProcessing ()
- Se 1, a captura de tela ainda está sendo processada.
-
getCached ()
- Se 1, a captura de tela for processada e atualmente está em cache.
-
getExpired ()
- Se o 1, a captura de tela não está mais no sistema GrabzIt.
-
getMessage ()
- Uma mensagem de erro retornada pelo sistema.
GrabzItWaterMark
Esta classe representa o costume watermarks armazenado no GrabzIt
Métodos públicos
-
getIdentifier ()
- O identificador do watermark
-
getXPosition ()
-
A posição horizontal do watermark
- Esquerda = 0
- Centro = 1
- Direita = 2
-
getYPosition ()
-
A posição vertical do watermark
- Topo = 0
- Médio = 1
- Parte inferior = 2
-
getFormat ()