| Package Data | |
|---|---|
| Maintainer Username: | anam |
| Maintainer Contact: | enam33@gmail.com (Anam hossain) |
| Package Create Date: | 2015-02-20 |
| Package Last Update: | 2023-10-26 |
| Home Page: | |
| Language: | PHP |
| License: | MIT |
| Last Refreshed: | 2024-12-19 03:22:40 |
| Package Statistics | |
|---|---|
| Total Downloads: | 409,665 |
| Monthly Downloads: | 3,094 |
| Daily Downloads: | 271 |
| Total Stars: | 163 |
| Total Watchers: | 14 |
| Total Forks: | 45 |
| Total Open Issues: | 45 |
PhantomMagick provides a simple API to ease the process of converting HTML to PDF or images. It's especially handy for things like generating invoices or capturing screenshots of websites. It's framework agnostic but it does provide a facade for simple use in Laravel 4/5.
PhantomMagick is available via Composer:
$ composer require anam/phantommagick
PhantomJS must be installed to use PhantomMagick.
There are few ways to install PhantomJS:
You can download the official PhantomJS binary from the following link:
http://phantomjs.org/download.html.
Simply pull in the anam/phantomjs-linux-x86-binary package to get the up-to-date PhantomJS binary for 64-bit Linux systems.
composer require anam/phantomjs-linux-x86-binary
Although PhantomMagick is framework agnostic, it does support Laravel out of the box and comes with a Service provider and Facade for easy integration.
After you have installed the PhantomMagick, open the config/app.php file which is included with Laravel and add the following lines.
In the $providers array add the following service provider.
'Anam\PhantomMagick\ConverterServiceProvider'
Add the facade of this package to the $aliases array.
'Converter' => 'Anam\PhantomMagick\Facades\Converter'
You can now use this facade in place of instantiating the converter yourself in the following examples.
$conv = new \Anam\PhantomMagick\Converter();
$conv->source('http://google.com')
->toPdf()
->save('/your/destination/path/google.pdf');
use Anam\PhantomMagick\Converter;
$conv = new Converter();
$conv->addPage('<html><body><h1>Welcome to PhantomMagick</h1></body></html>')
->addPage('http://facebook.com')
->addPage('/html/file/from/local/drive/example.html')
->save('/your/destination/path/multipage.pdf');
Please note with multipage PDFs:
PhantomMagick supports HTML to PNG/JPG/GIF conversion.
$conv = new \Anam\PhantomMagick\Converter();
$conv->source('http://google.com')
->toPng()
->save('/your/destination/path/google.png');
$conv->toPng()
$conv->toJpg()
$conv->toGif()
use Anam\PhantomMagick\Converter;
Converter::make('http://google.com')
->toPdf()
->download('google.pdf');
Converter::make('http://yahoo.com')
->toPng()
->download('yahoo.png');
To display in the browser instead of forcing the file to be download, you can pass a second parameter to the method.
$conv->download('google.pdf', true);
or just simply call:
$conv->serve();
PhantomMagick leverages Flysystem to save converted files in the cloud.
PhantomMagick currently supports:
First install the required S3 dependencies through Composer.
composer require aws/aws-sdk-php
composer require league/flysystem-aws-s3-v3
use Anam\PhantomMagick\Converter;
use Aws\S3\S3Client;
$client = S3Client::factory([
'credentials' => [
'key' => 'AWS_KEY',
'secret' => 'AWS_SECRET',
],
'region' => 'your-region',
'version' => 'latest',
]);
$conv = new Converter();
$conv->adapter($client, 'bucket-name', 'optional/path/prefix')
->acl('public')
->source('http://google.com')
->toPdf()
->save('google.pdf');
First install the required Dropbox dependencies through Composer.
composer require dropox/dropbox-sdk
composer require flysystem-dropbox
use Anam\PhantomMagick\Converter;
use Dropbox\Client;
$client = new Client('DROPBOX_TOKEN', 'DROPBOX_APP');
$conv = new Converter();
$conv->adapter($client)
->source('https://google.com')
->toPdf()
->save('dropbox_example.pdf');
First install the required Rackspace dependencies through Composer.
composer require rackspace/php-opencloud
composer require league/flysystem-rackspace
use Anam\PhantomMagick\Converter;
use OpenCloud\OpenStack;
use OpenCloud\Rackspace;
$client = new OpenStack(Rackspace::US_IDENTITY_ENDPOINT, array(
'username' => 'RACKSPACE_USERNAME',
'password' => 'RACKSPACE_PASSWORD'
));
$store = $client->objectStoreService('cloudFiles', 'SYD');
$container = $store->getContainer('phantom-magick');
$conv = new Converter();
$conv->adapter($container)
->source('https://google.com')
->toPdf()
->save('rackspace_example.pdf');
You can set the path of the phantomjs binary if you've installed it yourself manually, or the phantomjs command is not available in your shell. If you installed it through Composer (with the anam/phantomjs-linux-x86-binary package) PhantomMagick will be smart enough to find the file automatically.
$conv->setBinary('/phantomjs/binary/path/phantomjs');
PhantomMagick only supports HTML and data can be provided via an URL or from the local disk. If you need to use raw HTML data, you can use multipage PDF conversion. However raw data does have some limitations; it does not support relative paths and it only supports inline styles and internal CSS.
new Converter('/Path/to/file/example.html');
// or
Converter::make('/Path/to/file/example.html');
//or
$conv->source('/Path/to/file/example.html');
// or
$conv->source('http://google.com');
For raw HTML:
$conv->addPage('<html><body><h1>Raw HTML</h1></body></html>');
Format is optional. Supported formats are: 'A3', 'A4', 'A5', 'Legal', 'Letter', 'Tabloid'.
$conv->format('A4');
Margin is optional and defaults to 1cm.
array('margin' => '1cm')
Orientation ('portrait', 'landscape') is optional and defaults to 'portrait'.
$conv->portrait();
$conv->landscape();
zoomFactor is optional and defaults to 1 (where 1 is 100% zoom).
array('zoomfactor' => 1)
Custom dimension is optional. Supported formats are cm, px and in.
array('width' => '900px', height => '700px')
$options = [
'format' => 'A4',
'zoomfactor' => 1,
'orientation' => 'portrait',
'margin' => '1cm'
];
$conv->setPdfOptions($options);
// or
$conv->pdfOptions($options);
// or
$conv->toPdf($options);
Width is optional and defaults to 1280px (720p) and only intergers are accepted.
$conv->width(1280);
Height is optional and only integers are accepted.
$conv->height(1280);
Note: If only width is given full webpage will be rendered. However, if both width and height is given the image will be clipped to the given width and height.
Quality is optional and defaults to 80. The quality must be between 1-100.
$conv->quality(90);
#####Example
$options = [
'width' => 1280,
'quality' => 90
];
$conv->setImageOptions($options);
// or
$conv->imageOptions($options);
// or
$conv->toPng($options);
// or
$conv->toJpg($options);
// or
$conv->toGif($options);
The MIT License (MIT). Please see LICENSE for more information.