You are here

Home » API reference » PhantomJS Capture 7

README.txt in PhantomJS Capture 7

Same filename and directory in other branches
  1. 8 README.txt
The module comes with an integration to PhantomJS which allows you to take
screenshots of homepages as images and use them on your site.

The module comes with an administration interface to allows you to configure the
location of PhantomJS and a default destination folder. It also has a test
function to, well test if your configuration works. PhantomJS works by giving
phantom an JavaScript file that tells phantom what to do and this module comes
with a default JavaScript file that renders full HD size screenshots.

For more information about PhantomJS possibilities you should look at the wiki
pages at https://github.com/ariya/phantomjs/wiki and the examples that comes
with PhantomJS.

# Usages
The module comes with a simple field that allows users to enter a absolute URL
to a page they want to capture and the field provides a display of the captured
site which can be displayed using image style and the image may link to the site
captured.

To use this module in your code the phantomjs_capture_screen can be called after
you have saved its configuration.

The $url is the page to capture and the $dest is an URI to where the image
should be stored and the $filename to store it under.

<?php
  phantomjs_capture_screen($url, $dest, $filename)
?>

# Requirements
The module requires that PhantomJS is installed on your server. See the PhatomJS
download page at http://phantomjs.org/download.html.

# Installation
Simply download and enable the module(s) as any other modules goto your content
type (or entity) and add the PhantomJS field to your entity.

File

README.txt
View source 
  1. The module comes with an integration to PhantomJS which allows you to take

  2. screenshots of homepages as images and use them on your site.

  3. 

  4. The module comes with an administration interface to allows you to configure the

  5. location of PhantomJS and a default destination folder. It also has a test

  6. function to, well test if your configuration works. PhantomJS works by giving

  7. phantom an JavaScript file that tells phantom what to do and this module comes

  8. with a default JavaScript file that renders full HD size screenshots.

  9. 

  10. For more information about PhantomJS possibilities you should look at the wiki

  11. pages at https://github.com/ariya/phantomjs/wiki and the examples that comes

  12. with PhantomJS.

  13. 

  14. # Usages

  15. The module comes with a simple field that allows users to enter a absolute URL

  16. to a page they want to capture and the field provides a display of the captured

  17. site which can be displayed using image style and the image may link to the site

  18. captured.

  19. 

  20. To use this module in your code the phantomjs_capture_screen can be called after

  21. you have saved its configuration.

  22. 

  23. The $url is the page to capture and the $dest is an URI to where the image

  24. should be stored and the $filename to store it under.

  25. 

  27.   phantomjs_capture_screen($url, $dest, $filename)

  28. ?>

  29. 

  30. # Requirements

  31. The module requires that PhantomJS is installed on your server. See the PhatomJS

  32. download page at http://phantomjs.org/download.html.

  33. 

  34. # Installation

  35. Simply download and enable the module(s) as any other modules goto your content

  36. type (or entity) and add the PhantomJS field to your entity.