Описание

Этот класс обрабатывает все коммуникации с веб-сервисами GrabzIt.

Публичные методы

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

Этот метод возвращает сам скриншот. Если ничего не возвращено, значит что-то пошло не так или скриншот еще не готов.

параметры

• id - уникальный идентификатор скриншота
  • необходимые

Возвращаемое значение

Захват

---

URLToAnimation($ URL, $ варианты = ноль)

Укажите URL-адрес онлайн-видео, которое необходимо преобразовать intанимированный GIF.

параметры

• url - URL видео онлайн для конвертации intо анимированный GIF.
  • необходимые
  • Принимает Vimeo и YouTube видео URL
    • Предупреждение о анимации видео Vimeo и YouTube зависит от третьей стороны и, следовательно, может не дать согласованных результатов
• опционы - экземпляр GrabzItAnimationOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании анимированного GIF.

Возвращаемое значение

аннулировать

GrabzItAnimationOptions

Класс представляет все параметры, доступные при создании анимированного GIF.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать через анимированный GIF веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setWidth($value) - ширина получаемого анимированного GIF в пикселях.
  • По умолчанию: 180px
  • Максимум: максимальная ширина для упаковки
  • Авто-размер: -1 (передача -1 означает, что ширина анимированный GIF масштабируется по отношению к его высоте, если ширина автоматически измеряется, высота не может)
• setHeight($value) - высота получаемого анимированного GIF в пикселях.
  • По умолчанию: 120px
  • Максимум: максимальная высота упаковки
  • Авто-размер: -1 (передача -1 означает, что высота анимированный GIF масштабируется по отношению к его ширине, если высота автоматически измеряется, ширина не может)
• setStart($value) - начальная позиция видео, которое должно быть преобразовано intанимированный GIF.
  • По умолчанию: секунды 0
• setDuration($value) - продолжительность видео в секундах, которое должно быть конвертировано intанимированный GIF.
  • По умолчанию: максимальная длина пакета
• setSpeed($value) - скорость анимированного GIF.
  • По умолчанию: 1
  • Минимум: 0.2
  • Максимум: 10
• setFramesPerSecond($value) - количество кадров в секунду, которое должно быть снято с видео.
  • По умолчанию: 10
  • Минимум: 0.2
  • Максимум: 60
• setRepeat($value) - количество циклов анимированного GIF.
  • По умолчанию: 0
  • Цикл непрерывно: 0
  • Никогда не зацикливаться: -1
• setReverse($value) - если true, кадры анимированного GIF меняются местами
  • По умолчанию: false
• setCustomWaterMarkId($value) - добавить кастом watermark в анимированный GIF
  • По умолчанию: пусто
• setQuality($value) - качество возвращаемого изображения, который имеет сжатие по умолчанию 85%.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry($value) - страна анимированный GIF должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

---

URLToImage($ URL, $ варианты = ноль)

Определяет URL, который должен быть преобразован intскриншот изображения.

параметры

• url - URL, из которого должен быть сделан снимок экрана
  • необходимые
• опционы - экземпляр GrabzItImageOptions класс, который определяет любые специальные опции, которые будут использоваться при создании скриншота.

Возвращаемое значение

аннулировать

HTMLToImage($ HTML, $ варианты = ноль)

Определяет HTML, который должен быть преобразован intoa изображение.

параметры

• HTML - HTML для преобразования intизображение
  • необходимые
• опционы - экземпляр GrabzItImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.

Возвращаемое значение

аннулировать

FileToImage($ Путь, $ варианты = ноль)

Определяет файл HTML, который должен быть преобразован intoa изображение.

параметры

• путь - путь к файлу HTML-файла для преобразования intизображение
  • необходимые
• опционы - экземпляр GrabzItImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.

Возвращаемое значение

аннулировать

GrabzItImageOptions

Класс представляет все параметры, доступные при создании снимков изображения.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать на веб-сервис скриншотов. Он будет возвращен с указанным вами обратным URL-адресом.
  • По умолчанию: пусто
• setBrowserWidth($value) - ширина браузера в пикселях
  • По умолчанию: 1366
  • Максимум: 10000
• setBrowserHeight($value) - высота браузера в пикселях
  • По умолчанию: 1170
  • Максимум: 10000
  • Полная длина: -1 (пропуск -1 означает, что взят снимок всей веб-страницы)
• setWidth($value) - ширина получаемого эскиза в пикселях
  • По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если высота вывода указана, ширина вывода будет пропорциональна высоте вывода.
  • Максимум: максимальная ширина для упаковки
  • Полная ширина: -1 (пропуск -1 означает, что ширина эскиза не уменьшается)
• setHeight($value) - высота получаемого миниатюры в пикселях
  • По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если ширина вывода указана, высота вывода будет пропорциональна ширине вывода
  • Максимум: максимальная высота упаковки
  • Полная высота: -1 (пропуск -1 означает, что высота эскиза не уменьшается)
• setFormat($value) - формат скриншота должен быть в.
  • По умолчанию: "JPG"
  • Опции: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
• setDelay($value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setClickElement($value) - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement($value) - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into Скриншот, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement($value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement($value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setRequestAs($value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: 0
  • Опции:
    • 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
    • 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
    • 2 = указывает, что должен использоваться пользовательский агент поисковой системы
• setCustomWaterMarkId($value) - добавить кастом watermark к изображению
  • По умолчанию: пусто
• setQuality($value) - качество возвращаемого изображения. В настоящее время это влияет только на изображения JPG и WEBP, сжатие которых по умолчанию составляет 90%.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setTransparent($value) - если правда захват изображения должен быть прозрачным, Это совместимо только с изображениями PNG и TIFF.
  • По умолчанию: false
• setHD($value) - если верно изображение захват будет в высоком разрешении это удваивает размер изображения.
  • По умолчанию: 0
• setCountry($value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds($value) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications($value) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress($value) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter ($ name, $ value) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

---

URLToRenderedHTML($ URL, $ варианты = ноль)

Определяет URL, который должен быть преобразован intо рендеринга HTML.

параметры

• url - URL-адрес, из которого должен быть выполнен визуализированный HTML
  • необходимые
• опционы - экземпляр GrabzItHTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

HTMLToRenderedHTML($ HTML, $ варианты = ноль)

Определяет HTML, который должен быть преобразован intо рендеринга HTML.

параметры

• HTML - HTML для преобразования intо рендеринг HTML
  • необходимые
• опционы - экземпляр GrabzItHTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

FileToRenderedHTML($ Путь, $ варианты = ноль)

Определяет файл HTML, который должен быть преобразован intо рендеринга HTML.

параметры

• путь - путь к файлу HTML-файла для преобразования intо рендеринг HTML
  • необходимые
• опционы - экземпляр GrabzItHTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

GrabzItHTMLOptions

Класс представляет все параметры, доступные при создание визуализированных захватов HTML.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setBrowserWidth($value) - ширина браузера в пикселях
  • По умолчанию: 1366
  • Максимум: 10000
• setBrowserHeight($value) - высота браузера в пикселях
  • По умолчанию: 1170
  • Максимум: 10000
• setDelay($value) - количество миллисекунд до подождите, прежде чем взять захват
  • По умолчанию: 0
  • Максимум: 30000
• setWaitForElement($value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setRequestAs($value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: 0
  • Опции:
    • 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
    • 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
    • 2 = указывает, что должен использоваться пользовательский агент поисковой системы
• setCountry($value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds($value) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications($value) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress($value) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter ($ name, $ value) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

---

URLToPDF($ URL, $ варианты = ноль)

Определяет URL, который должен быть преобразован intoa PDF.

параметры

• URL - URL, который должен быть преобразован intoa PDF
  • необходимые
• опционы - экземпляр класса GrabzItPDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

HTMLToPDF($ HTML, $ варианты = ноль)

Определяет HTML, который должен быть преобразован intoa PDF.

параметры

• HTML - HTML для преобразования intoa PDF
  • необходимые
• опционы - экземпляр класса GrabzItPDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

FileToPDF($ Путь, $ варианты = ноль)

Определяет файл HTML, который должен быть преобразован intoa PDF.

параметры

• путь - путь к файлу HTML-файла для преобразования intoa PDF
  • необходимые
• опционы - экземпляр класса GrabzItPDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

GrabzItPDFOptions

Класс представляет все параметры, доступные при создании снимков PDF.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setIncludeBackground($value) - если true, фон веб-страницы должен быть включен в скриншот
  • По умолчанию: правда
• setPageSize($value) - размер страницы PDF
  • По умолчанию: "A4"
  • Опции: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
• setOrientation($value) - ориентация PDF документа
  • По умолчанию: «Портрет»
  • Опции: «Портрет», «Пейзаж»
• setCSSMediaType($value) - CSS Media Тип документа PDF
  • По умолчанию: «Экран»
  • Опции: «Экран», «Прint"
• setIncludeLinks($value) - true, если ссылки должны быть включены в PDF
  • По умолчанию: правда
• setIncludeOutline($value) - правда, если PDF закладки должны быть включены
  • По умолчанию: false
• setTitle($value) - укажите название документа PDF
  • По умолчанию: пусто
• setCoverURL($value) - URL веб-страницы, которая должна использоваться в качестве обложки для PDF
  • По умолчанию: пусто
• setMarginTop($value) - поле в миллиметрах, которое должно отображаться в верхней части страницы документа PDF
  • По умолчанию: 10
• setMarginLeft($value) - поле в миллиметрах, которое должно появиться слева от страницы документа PDF
  • По умолчанию: 10
• setMarginBottom($value) - поле в миллиметрах, которое должно отображаться внизу страницы документа PDF
  • По умолчанию: 10
• setMarginRight($value) - поле в миллиметрах, которое должно отображаться справа от документа PDF
  • По умолчанию: 10
• setBrowserWidth($value) - ширина браузера в пикселях
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
  • По умолчанию: 1366
  • Максимум: 10000
  • Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине PDF-документа)
• setPageWidth($value) - пользовательская ширина полученного PDF в мм
  • По умолчанию: размер страницы ширина
  • Минимум: 15
• setPageHeight($value) - пользовательская высота получаемого PDF в мм
  • По умолчанию: размер страницы высота
  • Минимум: 15
• setDelay($value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setRequestAs($value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: 0
  • Опции:
    • 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
    • 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
    • 2 = указывает, что должен использоваться пользовательский агент поисковой системы
• setTemplateId($value) - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа PDF
  • По умолчанию: пусто
• setClickElement($value) - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement($value) - CSS селектор из единственного HTML-элемент на целевой веб-странице, которую нужно перевернуть intoa PDFвсе остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement($value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement($value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setCustomWaterMarkId($value) - добавить кастом watermark на каждую страницу PDF-документа
  • По умолчанию: пусто
• setQuality($value) - качество возвращаемого PDF, По умолчанию используется рекомендуемое качество для PDF.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry($value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds($value) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications($value) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress($value) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто
• setMergeId($value) - идентификатор захвата, который должен быть объединены в начале нового документа PDF
  • По умолчанию: пусто
• setPassword($value) - пароль для защиты PDF документа с
  • По умолчанию: пусто

Публичные методы

• AddPostParameter ($ name, $ value) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post
• AddTemplateParameter ($ name, $ value) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
  • name - имя параметра шаблона
  • value - значение параметра шаблона

---

URLToDOCX ($ URL, $ варианты = ноль)

Определяет URL, который должен быть преобразован intооо

параметры

• URL - URL, который должен быть преобразован intoa DOCX
  • необходимые
• опционы - экземпляр GrabzItDOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

HTMLToDOCX($ HTML, $ варианты = ноль)

Определяет HTML, который должен быть преобразован intооо

параметры

• HTML - HTML для преобразования intoa DOCX
  • необходимые
• опционы - экземпляр GrabzItDOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

FileToDOCX($ Путь, $ варианты = ноль)

Определяет файл HTML, который должен быть преобразован intооо

параметры

• путь - путь к файлу HTML-файла для преобразования intoa DOCX
  • необходимые
• опционы - экземпляр GrabzItDOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

GrabzItDOCXOptions

Класс представляет все параметры, доступные при создании захватов DOCX.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setIncludeBackground($value) - если true, фоновые изображения веб-страницы должны быть включены в DOCX
  • По умолчанию: правда
• setPageSize($value) - размер страницы DOCX
  • По умолчанию: "A4"
  • Опции: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
• setOrientation($value) - ориентация документа DOCX
  • По умолчанию: «Портрет»
  • Опции: «Портрет», «Пейзаж»
• setIncludeLinks($value) - true, если ссылки должны быть включены в DOCX
  • По умолчанию: правда
• setIncludeImages($value) - true, если изображения веб-страницы должны быть включены в DOCX
  • По умолчанию: правда
• setTitle($value) - предоставить заголовок документа DOCX
  • По умолчанию: пусто
• setMarginTop($value) - поле в миллиметрах, которое должно отображаться в верхней части страницы документа DOCX
  • По умолчанию: 10
• setMarginLeft($value) - поле в миллиметрах, которое должно появиться слева от страницы документа DOCX
  • По умолчанию: 10
• setMarginBottom($value) - поле в миллиметрах, которое должно отображаться внизу страницы документа DOCX
  • По умолчанию: 10
• setMarginRight($value) - поле в миллиметрах, которое должно отображаться справа от документа DOCX
  • По умолчанию: 10
• setBrowserWidth($value) - ширина браузера в пикселях
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
  • По умолчанию: 1366
  • Максимум: 10000
  • Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине документа DOCX)
• setPageWidth($value) - пользовательская ширина результирующего DOCX в мм
  • По умолчанию: размер страницы ширина
  • Минимум: 15
• setPageHeight($value) - Пользовательская высота результирующего DOCX в мм
  • По умолчанию: размер страницы высота
  • Минимум: 15
• setDelay($value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setRequestAs($value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: 0
  • Опции:
    • 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
    • 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
    • 2 = указывает, что должен использоваться пользовательский агент поисковой системы
• setTemplateId($value) - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа DOCX
  • По умолчанию: пусто
• setClickElement($value) - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement($value) - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into DOCX, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement($value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement($value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setQuality($value) - качество возвращаемого DOCX, По умолчанию используется рекомендуемое качество для DOCX.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry($value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds($value) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications($value) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress($value) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто
• setMergeId($value) - идентификатор захвата, который должен быть объединены в начале нового документа DOCX
  • По умолчанию: пусто
• setPassword($value) - пароль для защиты документа DOCX с
  • По умолчанию: пусто

Публичные методы

• AddPostParameter ($ name, $ value) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post
• AddTemplateParameter ($ name, $ value) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
  • name - имя параметра шаблона
  • value - значение параметра шаблона

---

URLToTable($ URL, $ варианты = ноль)

Определяет URL, из которого должны быть извлечены таблицы HTML.

параметры

• url - URL для извлечения HTML-таблиц из
  • необходимые
• опционы - экземпляр GrabzItTableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

HTMLToTable ($ HTML, $ варианты = ноль)

Определяет HTML, из которого должны быть извлечены таблицы HTML.

параметры

• html - HTML-код для извлечения HTML-таблиц.
  • необходимые
• опционы - экземпляр GrabzItTableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

FileToTable ($ путь, $ варианты = ноль)

Указывает файл HTML, из которого должны быть извлечены таблицы HTML.

параметры

• путь - путь к файлу HTML, из которого извлекаются таблицы HTML.
  • необходимые
• опционы - экземпляр GrabzItTableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

GrabzItTableOptions

Класс представляет все параметры, доступные при преобразовании таблиц HTML в CSV, XLSX или JSON.

Публичная недвижимость

• setCustomId($value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали
  • По умолчанию: пусто
• setTableNumberToInclude($value) - индекс таблицы, которую нужно преобразовать, если все таблицы на веб-странице упорядочены сверху вниз по веб-странице
  • По умолчанию: 1
• setFormat($value) - формат таблицы должен быть в
  • По умолчанию: "CSV"
  • Опции: "CSV", "JSON", "XLSX"
• setIncludeHeaderNames($value) - если в таблицу будут включены истинные имена заголовков
  • По умолчанию: правда
• setIncludeAllTables($value) - если true, вся таблица на веб-странице будет извлечена, и каждая таблица появится в отдельном листе электронной таблицы. Доступно только с форматом XLSX
  • По умолчанию: false
• setClickElement($value) - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement($value) - идентификатор единственного HTML-элемента на веб-странице, который должен использоваться для извлечения таблиц из
  • По умолчанию: пусто
• setRequestAs($value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: 0
  • Опции:
    • 0 = указывает, что должен использоваться пользовательский агент стандартного браузера
    • 1 = указывает, что должен использоваться пользовательский агент мобильного браузера
    • 2 = указывает, что должен использоваться пользовательский агент поисковой системы
• setCountry($value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Варианты: «SG», «UK», «US»
• setExportURL($value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey($value) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setAddress($value) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy($value) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter ($ name, $ value) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

---

Save($ callBackURL = null)

Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с GetResult метод.

параметры

• callBackURL - обработчик Служба GrabzIt должна позвонить после завершения своей работы

Возвращаемое значение

Уникальный идентификатор скриншота, в противном случае, если произошла ошибка, генерируется исключение. Это можно использовать для получения скриншота с GetResult метод

---

SaveTo()

Save результат синхронно с переменной, содержащей данные байта снимка экрана.

Возвращаемое значение

в случае успеха возвращает байтовые данные файла, в противном случае выдается исключение.

---

SaveTo($saveToФайл)

Save результат синхронно в файл.

параметры

• saveToФайл - путь к файлу, который будет захвачен. saved, когда он будет завершен
  • необходимые

Возвращаемое значение

возвращает true, если он успешен, в противном случае выдается исключение.

---

GetStatus ($ ID)

Получить текущий статус скриншота GrabzIt.

параметры

• id - уникальный идентификатор скриншота
  • необходимые

Возвращаемое значение

GrabzItStatus объект

---

GetCookies ($ домен)

Получить все куки, которые GrabzIt использует для определенного домена. Это может также включать определенные пользователем файлы cookie.

параметры

• домен - домен для возврата куки
  • необходимые

Возвращаемое значение

GrabzItCookie массив

---

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

Устанавливает новый пользовательский файл cookie для GrabzIt, если пользовательский файл cookie имеет то же имя и домен, что и глобальный файл cookie, глобальный файл cookie переопределяется.

Это может быть полезно, если функциональность веб-сайта контролируется куки-файлами.

параметры

• name - имя куки для установки
  • необходимые
• домен - домен веб-сайта, для которого устанавливается файл cookie
  • необходимые
• value - значение куки
• путь - путь к сайту, к которому относится cookie
• httponly - если true, cookie может использоваться только с протоколом HTTP
• expires - определяет, когда истекает срок действия cookie. Передайте нулевое значение, если срок действия файла cookie не истек
  • Должен быть в формате гггг-мм-дд чч: мм: сс

Возвращаемое значение

True, если cookie успешно установлен, иначе false

---

DeleteCookie ($ name, $ domain)

Удалить пользовательский файл cookie или заблокировать использование глобального файла cookie

параметры

• name - имя куки для удаления
  • необходимые
• домен - домен сайта для удаления куки
  • необходимые

Возвращаемое значение

True, если cookie успешно удален, иначе false

---

ПолучитьWaterMarks()

Получите свой загруженный заказ watermarks

Возвращаемое значение

GrabzItWaterMark массив

---

ПолучитьWaterMark($ Идентификатор)

Верните свой заказ watermarks который соответствует указанному идентификатору

параметры

• идентификатор - идентификатор конкретного кастома watermark ты хочешь посмотреть
  • необходимые

Возвращаемое значение

GrabzItWaterMark

---

ДобавитьWaterMark($ идентификатор, $ путь, $ xpos, $ ypos)

Добавить новый обычай watermark

параметры

• идентификатор - идентификатор, который вы хотите присвоить пользовательскому watermark. Важно, чтобы этот идентификатор был уникальным.
  • необходимые
• path - абсолютный путь watermark на вашем сервере. Например, C: /watermark/1.png
  • необходимые
• xpos - горизонтальная позиция, в которой вы хотите, чтобы скриншот появлялся в
  • необходимые
  • Опции:
    • Слева = 0
    • Центр = 1
    • Право = 2
• ypos - вертикальная позиция, в которой вы хотите, чтобы скриншот появлялся в
  • необходимые
  • Опции:
    • Top = 0
    • Средний = 1
    • Низ = 2

Возвращаемое значение

возвращает истину, если watermark был успешно установлен

---

DeleteWaterMark($ Идентификатор)

Удалить кастом watermark

параметры

• идентификатор - идентификатор кастомного watermark ты хочешь удалить
  • необходимые

Возвращаемое значение

возвращает истину, если watermark был успешно удален

---

SetLocalProxy ($ proxyUrl)

Этот метод позволяет локальный прокси-сервер использоваться для всех запросов.

параметры

• proxyUrl - URL-адрес, который может включать порт прокси-сервера при необходимости. Предоставление нулевого значения удалит любой ранее установленный прокси
  • необходимые

---

UseSSL ($ значение)

Определяет, если запросы к GrabzIt's API должен использовать SSL или нет

параметры

• значение - если true, все запросы к API GrabzIt будут использовать SSL
  • необходимые

---

CreateEncryptionKey ()

Создайте криптографически безопасный базовый ключ шифрования 64 длиной 44.

---

Расшифровать ($ data, $ key)

Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.

параметры

• данные - зашифрованные байты
  • необходимые
• ключ - ключ шифрования
  • необходимые

---

DecryptFile ($ path, $ key)

Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.

параметры

• путь - путь зашифрованного захвата
  • необходимые
• ключ - ключ шифрования
  • необходимые

---

Классы результатов

GrabzItCookie

Публичная недвижимость

• Имя и фамилия
  • Название куки.
• Значение
  • Значение cookie.
• Домен
  • Домен, для которого установлен файл cookie.
• Path
  • Путь в домене, к которому применяется этот файл cookie.
• HttpOnly
  • Если этот файл cookie действителен только при просмотре веб-сайта по протоколу HTTP.
• Истекает
  • Дата истечения срока действия этого cookie
• Тип
  • Тип cookie это может быть одним из следующих:
    • Global - это глобальный файл cookie, созданный GrabzIt
    • Local - это локальный файл cookie, установленный вами
    • Переопределено - глобальный файл cookie, который был переопределен вами

GrabzItStatus

Класс, представляющий текущий статус скриншота.

Публичная недвижимость

• Processing
  • Если это правда, скриншот все еще обрабатывается.
• Cached
  • Если true, снимок экрана был обработан и в настоящее время кэширован.
• Expired
  • Если это правда, скриншот больше не находится в системе GrabzIt.
• Message
  • Сообщение об ошибке, возвращенное системой.

GrabzItWaterMark

Этот класс представляет собой обычай watermarks хранится в GrabzIt

Публичная недвижимость

• идентификатор
  • Идентификатор watermark
• XPosition
  • Горизонтальное положение watermark
    • Слева = 0
    • Центр = 1
    • Право = 2
• YPosition
  • Вертикальное положение watermark
    • Top = 0
    • Средний = 1
    • Низ = 2
• Формат
  • Формат watermark