|Ratings|| ||Unique User Downloads|| ||Download Rankings|
| 73%||Total: 2,825 ||All time: 1,335 This week: 126|
This class can capture Web page as image using ScreenshotLayer API.
It can send a HTTP request to the ScreenshotLayer API to request the capture of an image in PNG, JPG or GIF formats from a given URL.
It can capture an image for the full page or only the visible viewport at a given size.
A given CSS may be injected in the captured page. A custom user agent string may be sent to the page Web server to emulate certain device browsers. The API may delay the capture for a given period of time.
The captured image can be resized to a given width and height. The capture results may be cached for a given period of time.
The class can return the captured image as HTML image tags, save the image to file or serve for display. The API may serve a custom placeholder image while the capture is not fully ready.
screenShot ver 1.0
//include screenShot class
//instantiate the class with the webpage url to capture
$screenShot = new screenShot('http://www.website.com');
//display html image tag for captured webpage
The following demonstrates the download and display from captured binary
of the webpage. To use, uncomment the capturePage method to capture
the binary and then uncomment either the downloadCapture or displayCapture
methods, depending on which you wish to preform.
Version: 1.0 12/7/2015
Copyright 2015 Wagon Trader, All Rights Reserved
Capture image of webpage using the screenshotLayer API from
screenshot.class.php - main class
example.php - basic usage
Upload files to a web accessible location on your server (eg. public_html)
You can change the following settings in the class to meet your specific needs...
apiKey = Your personal API Key, get a free key at https://screenshotlayer.com/product
endpoint = The API endpoint, you will only need to change this if the API
secretKey = If you have defined and activated the secret keyword feature from you
screenshotlayer dashboard, add your secret keyword here.
refer to example.php file for class instantiation and basic usage.
refer to screenshot.class.php for instructions on using methods.
The screenshotlayer API will first attempt to retreive the image from the cache,
if not found it will then produce a new image. Images returned from the cache
will not be charged against your monthly usage.
Customizing the captured image:
In addition to the url, you can set the following params to further customize the
returned image. You can use the setParam method to add/change any param.
fullpage - set to 1, to capture entire webpage
width - specify width in pixels to resize capture
viewport - the width and height in pixels for fit to a device viewport
format - returned image format of PNG (default), JPG or GIF
css_url - url of css to inject into page before capture
delay - delay time in seconds before capture starts
ttl - seconds to hold image in cache
Default/Max: ttl=2592000 (30 days)
force - set to 1 to force new capture
placeholder - url to placeholder image while capture is running or 1 to use default
user_agent - custom user agent string. Use to send this string as the user agent to
the website in conjuction with the viewport to emulate the desired device.
accept_lang - custom accept language header.
Some premium accounts also have access to the following params.
export - export the capture image to a specified location
export=s3://[bucket api key]:[bucket secret key]@[bucket] will export to AWS S3 bucket
export=ftp://[user]:[password]@[ftp server][/path/to/folder] will upload to folder using FTP
||Applications that use this package
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.