GrabzIt Client avec PHP

Description

Cette classe gère toutes les communications avec les services Web de capture d’écran GrabzIt.

Méthodes publiques

• 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)

Cette méthode renvoie la capture d'écran elle-même. Si rien n'est renvoyé, alors quelque chose s'est mal passé ou la capture d'écran n'est pas encore prête.

Paramètres

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

La capture

URLToAnimation($ url, $ options = null)

Spécifiez l'URL de la vidéo en ligne à convertir into un GIF animé.

Paramètres

• url - l'URL de la vidéo en ligne à convertir into un GIF animé.
  • Requis
  • Accepte les URL de vidéos Vimeo et YouTube
    • Avertissement L'animation de vidéos Vimeo et YouTube dépend d'un tiers et peut donc ne pas fournir des résultats cohérents.
• Options - une instance de GrabzItAnimationOptions classe qui définit les options spéciales à utiliser lors de la création du fichier GIF animé.

Valeur de retour

annuler

GrabzItAnimationOptions

La classe représente toutes les options disponibles lors de la création d'un fichier GIF animé.

Propriétés publiques

• setCustomId($value) - identificateur personnalisé que vous pouvez transmettre au service Web GIF animé. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setWidth($value) - la largeur du GIF animé obtenu en pixels.
  • Par défaut: 180px
  • Maximum: Largeur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la largeur de la le GIF animé est mis à l'échelle par rapport à sa hauteur, si la largeur est auto-dimensionnée, la hauteur ne peut pas)
• setHeight($value) - la hauteur du GIF animé obtenu en pixels.
  • Par défaut: 120px
  • Maximum: hauteur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la hauteur de la le GIF animé est mis à l'échelle par rapport à sa largeur, si la hauteur est automatiquement dimensionnée, la largeur ne peut pas)
• setStart($value) - la position de départ de la vidéo à convertir into un GIF animé.
  • Par défaut: secondes 0
• setDuration($value) - la durée en secondes de la vidéo à convertir into un GIF animé.
  • Valeur par défaut: longueur maximale du paquet
• setSpeed($value) - la vitesse du GIF animé.
  • Par défaut: 1
  • Minimum: 0.2
  • Maximum: 10
• setFramesPerSecond($value) - le nombre d'images par seconde devant être capturées à partir de la vidéo.
  • Par défaut: 10
  • Minimum: 0.2
  • Maximum: 60
• setRepeat($value) - nombre de fois pour boucler le GIF animé.
  • Par défaut: 0
  • Boucle en continu: 0
• setReverse($value) - si vrai, les images du GIF animé sont inversées
  • Par défaut: false
• setCustomWaterMarkId($value) - ajouter personnalisé watermark au GIF animé
  • Par défaut: vide
• setQuality($value) - la qualité de l'image retournée, qui a une compression par défaut de 85%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry($value) - le pays le GIF animé doit provenir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

URLToImage($ url, $ options = null)

Spécifie l'URL à convertir into une image capture d'écran.

Paramètres

• url - l'URL de la capture d'écran
  • Requis
• Options - une instance de GrabzItImageOptions classe qui définit les options spéciales à utiliser lors de la création de la capture d'écran.

Valeur de retour

annuler

HTMLToImage($ html, $ options = null)

Spécifie le HTML à convertir into une image.

Paramètres

• html - le HTML à convertir into une image
  • Requis
• Options - une instance de GrabzItImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.

Valeur de retour

annuler

FileToImage($ path, $ options = null)

Spécifie un fichier HTML à convertir into une image.

Paramètres

• chemin - le chemin du fichier HTML à convertir into une image
  • Requis
• Options - une instance de GrabzItImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.

Valeur de retour

annuler

GrabzItImageOptions

La classe représente toutes les options disponibles lors de la création de captures d'image.

Propriétés publiques

• setCustomId($value) - identifiant personnalisé que vous pouvez transmettre au service Web de capture d'écran. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setBrowserWidth($value) - la largeur du navigateur en pixels
  • Par défaut: 1024
  • Maximum: 10000
• setBrowserHeight($value) - la hauteur du navigateur en pixels
  • Par défaut: 768
  • Maximum: 10000
  • Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
• setWidth($value) - la largeur de la vignette obtenue en pixels
  • Valeur par défaut: le rapport le plus élevé possible entre la largeur du navigateur et la largeur maximale autorisée pour le package des utilisateurs.
  • Maximum: Largeur maximale pour le colis
  • Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
• setHeight($value) - la hauteur de la vignette obtenue en pixels
  • Valeur par défaut: le ratio le plus élevé possible entre la hauteur du navigateur et celle qui convient à l'utilisateur.
  • Maximum: hauteur maximale pour le colis
  • Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
• setFormat($value) - le format de la capture d'écran doit être.
  • Par défaut: "jpg"
  • Options: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
• setDelay($value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setTargetElement($value) - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une capture d’écran, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement($value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement($value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setRequestAs($value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
    • 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
    • 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
• setCustomWaterMarkId($value) - ajouter une personnalisation watermark à l'image
  • Par défaut: vide
• setQuality($value) - la qualité de l'image retournée. Actuellement, cela affecte uniquement les images JPG et WEBP, qui ont une compression par défaut de 90%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setTransparent($value) - si c'est vrai le la capture d'image doit être transparente. Ceci est uniquement compatible avec les images png et tiff.
  • Par défaut: false
• setHD($value) - si vrai l'image capture sera en haute définition cela double la taille des dimensions de l'image.
  • Par défaut: 0
• setCountry($value) - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds($value) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications($value) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress($value) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter ($ name, $ value) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

URLToRenderedHTML($ url, $ options = null)

Spécifie l'URL à convertir into rendu HTML.

Paramètres

• url - l'URL dont le HTML rendu devrait être composé
  • Requis
• Options - une instance de GrabzItHTMLOptions classe qui définit les options spéciales à utiliser lors de la création du code HTML rendu.

Valeur de retour

annuler

HTMLToRenderedHTML($ html, $ options = null)

Spécifie le HTML à convertir into rendu HTML.

Paramètres

• html - le HTML à convertir into rendu HTML
  • Requis
• Options - une instance de GrabzItHTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.

Valeur de retour

annuler

FileToRenderedHTML($ path, $ options = null)

Spécifie un fichier HTML à convertir into rendu HTML.

Paramètres

• chemin - le chemin du fichier HTML à convertir into rendu HTML
  • Requis
• Options - une instance de GrabzItHTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.

Valeur de retour

annuler

GrabzItHTMLOptions

La classe représente toutes les options disponibles lorsque création de captures HTML rendues.

Propriétés publiques

• setCustomId($value) - identifiant personnalisé que vous pouvez transmettre au service Web. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setBrowserWidth($value) - la largeur du navigateur en pixels
  • Par défaut: 1024
  • Maximum: 10000
• setBrowserHeight($value) - la hauteur du navigateur en pixels
  • Par défaut: 768
  • Maximum: 10000
• setDelay($value) - le nombre de millisecondes à attendez avant de prendre la capture
  • Par défaut: 0
  • Maximum: 30000
• setWaitForElement($value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setRequestAs($value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
    • 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
    • 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
• setCountry($value) - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds($value) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications($value) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress($value) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter ($ name, $ value) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

URLToPDF($ url, $ options = null)

Spécifie l'URL à convertir into un PDF.

Paramètres

• url - l'URL à convertir into un PDF
  • Requis
• Options - une instance de la classe GrabzItPDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

HTMLToPDF($ html, $ options = null)

Spécifie le HTML à convertir into un PDF.

Paramètres

• html - le HTML à convertir into un PDF
  • Requis
• Options - une instance de la classe GrabzItPDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

FileToPDF($ path, $ options = null)

Spécifie un fichier HTML à convertir into un PDF.

Paramètres

• chemin - le chemin du fichier HTML à convertir into un PDF
  • Requis
• Options - une instance de la classe GrabzItPDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

GrabzItPDFOptions

La classe représente toutes les options disponibles lors de la création de captures PDF.

Propriétés publiques

• setCustomId($value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setIncludeBackground($value) - si vrai, l'arrière-plan de la page Web devrait être inclus dans la capture d'écran
  • Par défaut: true
• setPageSize($value) - la taille de la page du PDF
  • Par défaut: "A4"
  • Options: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Juridique", "Lettre"
• setOrientation($value) - l'orientation du document PDF
  • Par défaut: "Portrait"
  • Options: "Portrait", "Paysage"
• setCSSMediaType($value) - la Type de média CSS du document PDF
  • Écran par défaut"
  • Options: "Écran", "Print"
• setIncludeLinks($value) - vrai si les liens doivent être inclus dans le PDF
  • Par défaut: true
• setIncludeOutline($value) - vrai si Signets PDF devrait être inclus
  • Par défaut: false
• setTitle($value) - donner un titre au document PDF
  • Par défaut: vide
• setCoverURL($value) - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
  • Par défaut: vide
• setMarginTop($value) - la marge en millimètres devant apparaître en haut de la page du document PDF
  • Par défaut: 10
• setMarginLeft($value) - la marge en millimètres devant apparaître à gauche de la page du document PDF
  • Par défaut: 10
• setMarginBottom($value) - la marge en millimètres qui devrait apparaître au bas de la page du document PDF
  • Par défaut: 10
• setMarginRight($value) - la marge en millimètres devant apparaître à droite du document PDF
  • Par défaut: 10
• setBrowserWidth($value) - la largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1024
  • Maximum: 10000
  • Largeur automatique: -1 (passant -1 signifie que la largeur du navigateur correspond à la largeur du document PDF)
• setPageWidth($value) - la largeur personnalisée du PDF résultant en mm
  • Valeur par défaut: taille de la page largeur
  • Minimum: 15
• setPageHeight($value) - la hauteur personnalisée du PDF résultant en mm
  • Valeur par défaut: taille de la page la taille
  • Minimum: 15
• setDelay($value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setRequestAs($value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
    • 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
    • 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
• setTemplateId($value) - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document PDF
  • Par défaut: vide
• setTargetElement($value) - la Sélecteur CSS du seul Élément HTML sur la page Web cible à tourner into un PDF, toutes les autres parties de la page Web sont ignorées. S'il y a plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement($value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement($value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setCustomWaterMarkId($value) - ajouter une personnalisation watermark à chaque page du document PDF
  • Par défaut: vide
• setQuality($value) - la qualité du PDF retourné. La valeur par défaut utilise la qualité recommandée pour un PDF.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry($value) - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds($value) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications($value) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress($value) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• setMergeId($value) - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document PDF
  • Par défaut: vide
• setPassword($value) - la mot de passe pour protéger le document PDF grâce à
  • Par défaut: vide

Méthodes publiques

• AddPostParameter ($ name, $ value) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter ($ name, $ value) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

URLToDOCX ($ url, $ options = null)

Spécifie l'URL à convertir into un DOCX.

Paramètres

• url - l'URL à convertir into un DOCX
  • Requis
• Options - une instance de GrabzItDOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

HTMLToDOCX($ html, $ options = null)

Spécifie le HTML à convertir into un DOCX.

Paramètres

• html - le HTML à convertir into un DOCX
  • Requis
• Options - une instance de GrabzItDOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

FileToDOCX($ path, $ options = null)

Spécifie un fichier HTML à convertir into un DOCX.

Paramètres

• chemin - le chemin du fichier HTML à convertir into un DOCX
  • Requis
• Options - une instance de GrabzItDOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

GrabzItDOCXOptions

La classe représente toutes les options disponibles lors de la création de captures DOCX.

Propriétés publiques

• setCustomId($value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setIncludeBackground($value) - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• setPageSize($value) - la taille de la page du DOCX
  • Par défaut: "A4"
  • Options: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Juridique", "Lettre"
• setOrientation($value) - l'orientation du document DOCX
  • Par défaut: "Portrait"
  • Options: "Portrait", "Paysage"
• setIncludeLinks($value) - vrai si les liens doivent être inclus dans le DOCX
  • Par défaut: true
• setIncludeImages($value) - true si les images de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• setTitle($value) - donner un titre au document DOCX
  • Par défaut: vide
• setMarginTop($value) - la marge en millimètres devant apparaître en haut de la page du document DOCX
  • Par défaut: 10
• setMarginLeft($value) - la marge en millimètres devant apparaître à gauche de la page du document DOCX
  • Par défaut: 10
• setMarginBottom($value) - la marge en millimètres devant apparaître au bas de la page du document DOCX
  • Par défaut: 10
• setMarginRight($value) - la marge en millimètres devant figurer à droite du document DOCX
  • Par défaut: 10
• setBrowserWidth($value) - la largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1024
  • Maximum: 10000
  • Largeur automatique: -1 (passer -1 signifie que la largeur du navigateur correspond à la largeur du document DOCX)
• setPageWidth($value) - la largeur personnalisée du DOCX résultant en mm
  • Valeur par défaut: taille de la page largeur
  • Minimum: 15
• setPageHeight($value) - la hauteur personnalisée du DOCX résultant en mm
  • Valeur par défaut: taille de la page la taille
  • Minimum: 15
• setDelay($value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setRequestAs($value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
    • 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
    • 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
• setTemplateId($value) - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document DOCX
  • Par défaut: vide
• setTargetElement($value) - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into DOCX, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement($value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement($value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setQuality($value) - la qualité du DOCX retourné. La valeur par défaut utilise la qualité recommandée pour un fichier DOCX.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry($value) - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds($value) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications($value) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress($value) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• setMergeId($value) - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document DOCX
  • Par défaut: vide
• setPassword($value) - la mot de passe pour protéger le document DOCX grâce à
  • Par défaut: vide

Méthodes publiques

• AddPostParameter ($ name, $ value) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter ($ name, $ value) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

URLToTable($ url, $ options = null)

Spécifie l'URL à partir de laquelle les tables HTML doivent être extraites.

Paramètres

• url - l'URL à partir de laquelle extraire les tables HTML
  • Requis
• Options - une instance de GrabzItTableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

HTMLToTable ($ html, $ options = null)

Spécifie le HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

• html - HTML pour extraire les tables HTML.
  • Requis
• Options - une instance de GrabzItTableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

FileToTable ($ path, $ options = null)

Spécifie un fichier HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

• chemin - le chemin du fichier HTML à partir duquel extraire les tableaux HTML.
  • Requis
• Options - une instance de GrabzItTableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

GrabzItTableOptions

La classe représente toutes les options disponibles lors de la conversion de tableaux HTML en fichiers CSV, XLSX ou JSON.

Propriétés publiques

• setCustomId($value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée
  • Par défaut: vide
• setTableNumberToInclude($value) - l'index de la table à convertir, si toutes les tables d'une page Web sont ordonnées du haut de la page Web vers le bas
  • Par défaut: 1
• setFormat($value) - le format dans lequel le tableau doit être
  • Par défaut: "csv"
  • Options: "csv", "json", "xlsx"
• setIncludeHeaderNames($value) - si de vrais noms d'en-tête seront inclus dans la table
  • Par défaut: true
• setIncludeAllTables($value) - Si vrai, tous les tableaux de la page Web seront extraits, chaque tableau apparaissant dans une feuille de calcul distincte. Disponible uniquement avec le format XLSX
  • Par défaut: false
• setTargetElement($value) - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
  • Par défaut: vide
• setRequestAs($value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
    • 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
    • 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
• setCountry($value) - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• setExportURL($value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey($value) - si la clé de chiffrement AES codée en 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setAddress($value) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy($value) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter ($ name, $ value) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

Save($ callBackURL = null)

Save le résultat de manière asynchrone et renvoie un identifiant unique, qui peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode.

Paramètres

• callBackURL - le maître le service GrabzIt doit appeler après avoir terminé son travail

Valeur de retour

L'identifiant unique de la capture d'écran sinon, si une erreur survient, une exception est levée. Ceci peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode

SaveTo()

Save le résultat de manière synchrone à une variable contenant les données d'octet de capture d'écran.

Valeur de retour

renvoie les données d'octet du fichier en cas de succès, sinon une exception est levée.

SaveTo($saveToFichier)

Save le résultat de manière synchrone à un fichier.

Paramètres

• saveToFichier - le chemin du fichier qui sera capturé saved à une fois qu'il a été complété
  • Requis

Valeur de retour

retourne le vrai s'il réussit, sinon il lève une exception.

GetStatus ($ id)

Obtenir le statut actuel d'une capture d'écran GrabzIt.

Paramètres

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

GrabzItStatus objet

GetCookies ($ domain)

Obtenez tous les cookies que GrabzIt utilise pour un domaine particulier. Cela peut également inclure les cookies définis par l'utilisateur.

Paramètres

• domain - le domaine pour lequel les cookies sont renvoyés
  • Requis

Valeur de retour

GrabzItCookie tableau

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

Définit un nouveau cookie personnalisé sur GrabzIt. Si le cookie personnalisé porte le même nom et le même domaine qu'un cookie global, le cookie global est remplacé.

Cela peut être utile si une fonctionnalité de site Web est contrôlée par des cookies.

Paramètres

• name - le nom du cookie à définir
  • Requis
• domain - le domaine du site Web pour définir le cookie pour
  • Requis
• valeur - la valeur du cookie
• chemin - le chemin du site auquel le cookie se rapporte
• httponly - si vrai, le cookie ne peut être utilisé qu'avec le protocole HTTP
• expires - définit quand le cookie expire. Passer une valeur nulle si le cookie ne doit pas expirer
  • Devrait être au format aaaa-mm-jj hh: mm: ss

Valeur de retour

Vrai si le cookie est installé avec succès, sinon faux

DeleteCookie ($ name, $ domain)

Supprimer un cookie personnalisé ou bloquer l'utilisation d'un cookie global

Paramètres

• name - le nom du cookie à supprimer
  • Requis
• domain - le domaine du site Web pour supprimer le cookie pour
  • Requis

Valeur de retour

Vrai si le cookie est supprimé avec succès, sinon faux

CommencezWaterMarks()

Obtenez votre personnalisé téléchargé watermarks

Valeur de retour

GrabzItWaterMark tableau

CommencezWaterMark($ identifiant)

Renvoyez votre coutume watermarks qui correspond à l'identifiant spécifié

Paramètres

• identifier - l'identifiant d'une coutume particulière watermark tu veux voir
  • Requis

Valeur de retour

GrabzItWaterMark

AddWaterMark($ identifiant, $ chemin, $ xpos, $ ypos)

Ajouter une nouvelle personnalisation watermark

Paramètres

• identifiant - l'identifiant que vous souhaitez donner à la personnalisation watermark. Il est important que cet identifiant soit unique.
  • Requis
• chemin - le chemin absolu du watermark sur votre serveur. Par exemple C: /watermark/1.png
  • Requis
• xpos - la position horizontale dans laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options:
    • Gauche = 0
    • Centre = 1
    • Droite = 2
• ypos - position verticale sur laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options:
    • Top = 0
    • Milieu = 1
    • Bas = 2

Valeur de retour

renvoie vrai si le watermark a été défini avec succès

DeleteWaterMark($ identifiant)

Supprimer une personnalisation watermark

Paramètres

• identifier - l'identifiant de la coutume watermark tu veux supprimer
  • Requis

Valeur de retour

renvoie vrai si le watermark a été supprimé avec succès

SetLocalProxy ($ proxyUrl)

Cette méthode permet une serveur proxy local à utiliser pour toutes les demandes.

Paramètres

• proxyUrl - l'URL, qui peut inclure un port si nécessaire, du proxy. Fournir une valeur nulle supprimera tout proxy précédemment défini
  • Requis

UseSSL ($ value)

Spécifie si les demandes à GrabzIt API devrait utiliser SSL ou pas

Paramètres

• valeur - si vrai, toutes les demandes adressées à l'API de GrabzIt utiliseront SSL
  • Requis

CreateEncryptionKey ()

Créez une clé de chiffrement 64 de base sécurisée sur le plan cryptographique, longue de caractères 44.

Déchiffrer ($ data, $ key)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

• data - les octets cryptés
  • Requis
• clé - la clé de chiffrement
  • Requis

DecryptFile ($ path, $ key)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

• chemin - le chemin de la capture cryptée
  • Requis
• clé - la clé de chiffrement
  • Requis

Classes de résultat

GrabzItCookie

Propriétés publiques

• Nom
  • Le nom du cookie.
• Valeur
  • La valeur du cookie.
• Domaine
  • Le domaine pour lequel le cookie est défini.
• Chemin
  • Le chemin d'accès au domaine auquel ce cookie s'applique.
• HttpOnly
  • Si ce cookie n'est valide que lorsque le site Web est visualisé avec le protocole HTTP.
• Expire le
  • La date d'expiration de ce cookie
• Type
  • Il s'agit du type de cookie, qui peut être l'un des suivants:
    • Global - il s'agit d'un cookie global défini par GrabzIt
    • Local - il s'agit d'un cookie local défini par vous
    • Overridden - un cookie global que vous avez remplacé

GrabzItStatus

La classe représentant le statut actuel de la capture d'écran.

Propriétés publiques

• Processing
  • Si vrai, la capture d'écran est toujours en cours de traitement.
• Cached
  • Si la valeur est true, la capture d'écran a été traitée et est actuellement mise en cache.
• Expired
  • Si vrai, la capture d'écran n'est plus sur le système GrabzIt.
• Message
  • Un message d'erreur renvoyé par le système.

GrabzItWaterMark

Cette classe représente la coutume watermarks stocké dans GrabzIt

Propriétés publiques

• Identificateur
  • L'identifiant du watermark
• XPosition
  • La position horizontale du watermark
    • Gauche = 0
    • Centre = 1
    • Droite = 2
• YPosition
  • La position verticale du watermark
    • Top = 0
    • Milieu = 1
    • Bas = 2
• Format
  • Le format du watermark