PHPackages                             daandesmedt/phpghostscript - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. daandesmedt/phpghostscript

ActiveLibrary[PDF & Document Generation](/categories/documents)

daandesmedt/phpghostscript
==========================

A PHP wrapper for Ghostscript (An interpreter for the PostScript language and for PDF). Export PDF / PS to PDF or various image types (jpeg / png). Easy to use and OOP interfaced.

v1.2.0(2y ago)31.0k↓50%2MITPHPPHP >= 7.0.0

Since Aug 6Pushed 2y ago1 watchersCompare

[ Source](https://github.com/DaanDeSmedt/PHPGhostscript)[ Packagist](https://packagist.org/packages/daandesmedt/phpghostscript)[ RSS](/packages/daandesmedt-phpghostscript/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (2)Versions (4)Used By (0)

PHPGhostscript
==============

[](#phpghostscript)

A PHP wrapper for [Ghostscript](https://www.ghostscript.com) ; an interpreter for PostScript™ and Portable Document Format (PDF) files.

Use `PHPGhostscript` for rendering PDF / PostScript™ files to various image types (jpeg / png) or export to PDF with page range (single page / multipage).

Setting multiple input files merge them.

Easy to use and OOP interfaced.

Installation
------------

[](#installation)

Install the package through [composer](http://getcomposer.org):

```
composer require daandesmedt/phpghostscript

```

Make sure, that you include the composer [autoloader](https://getcomposer.org/doc/01-basic-usage.md#autoloading) somewhere in your codebase.

Usage
-----

[](#usage)

Use `PHPGhostscript` for rendering PDF / PostScript™ files to various image types (jpeg / png) or export to PDF with page range (single page / multipage).

Working examples
----------------

[](#working-examples)

Working examples can be found in the `examples` folder.

Supported devices
-----------------

[](#supported-devices)

`PHPGhostscript` output devices implement `DeviceInterface`.

`PHPGhostscript` supports common output devices:

- **JPEG file format**
    - JPEG
    - JPEG Grey
- **PNG file format**
    - PNG
    - PNG 16
    - PNG 256
    - PNG 16M
    - PNG Alpha
    - PNG Grey
    - PNG Mono
    - PNG MonoD
- **PDF file format**

Specify a output device
-----------------------

[](#specify-a-output-device)

Set output decive through `DeviceTypes` constant.

```
use daandesmedt\PHPGhostscript\Devices\DeviceTypes;
use daandesmedt\PHPGhostscript\Devices\JPEG;

$ghostscript = new Ghostscript();
// JPEG
$ghostscript->setDevice(DeviceTypes::JPEG);
$ghostscript->setDevice(DeviceTypes::JPEG_GREY);
// PNG
$ghostscript->setDevice(DeviceTypes::PNG4);
$ghostscript->setDevice(DeviceTypes::PNG_256);
$ghostscript->setDevice(DeviceTypes::PNG_16M);
$ghostscript->setDevice(DeviceTypes::PNG_ALPHA);
$ghostscript->setDevice(DeviceTypes::PNG_GREY);
$ghostscript->setDevice(DeviceTypes::PNG_MONO);
$ghostscript->setDevice(DeviceTypes::PNG_MONO_D);
// PDF
$ghostscript->setDevice(DeviceTypes::PDF);
```

OR set with instanceof `DeviceInterface`

```
// or create device
$device  = new JPEG();

// set device
$ghostscript->setDevice($device);
```

Device specific parameters
--------------------------

[](#device-specific-parameters)

Device output typeFunctionJPEG / JPEG GREY`setQuality(int $quality)`PNG ALPHA`setBackgroundColor(string $color)``setDownScaleFactor(int $factor)`PNG MONO D`setMinFeatureSize(int $size)`PNG 16M`setDownScaleFactor(int $factor)`Example :

```
// Create JPEG device
$device  = new JPEG();
// set JPEG device specific quality
$device->setQuality(100);
```

PDF (single page) / PostScript™ to Image
----------------------------------------

[](#pdf-single-page--postscript-to-image)

```
require __DIR__ . '/../vendor/autoload.php';

use daandesmedt\PHPGhostscript\Ghostscript;
use daandesmedt\PHPGhostscript\Devices\JPEG;
use daandesmedt\PHPGhostscript\Devices\DeviceTypes;
use daandesmedt\PHPGhostscript\Devices\JPEGGrey;
use daandesmedt\PHPGhostscript\Devices\PNG;

$ghostscript = new Ghostscript();
$ghostscript
    // set Ghostscript binary path
    ->setBinaryPath('C:\Program Files\gs\gs9.27\bin\gswin64.exe')

    // set output device
    ->setDevice(DeviceTypes::JPEG)

    // set input & output file
    ->setInputFile(__DIR__ . DIRECTORY_SEPARATOR . 'assets' . DIRECTORY_SEPARATOR . 'SinglePageHorizontal.pdf')
    ->setOutputFile(__DIR__ . DIRECTORY_SEPARATOR . 'output' . DIRECTORY_SEPARATOR . 'SinglePageHorizontal.jpg');

// render
if (true === $ghostscript->render()) {
    echo 'success';
} else {
    echo 'error';
}
```

Single output file per page
---------------------------

[](#single-output-file-per-page)

Export multi-page PDF files to seperate image files using the `` Specifying a single output file works fine for printing and rasterizing figures, but sometimes you want images of each page of a multi-page document. You can tell `PHPGhostscript` to put each page of the input file in a series of similarly named files. To do this place a template `%d` in the `setOutputFile` setter (`%d` will be replaced by the matching page number).

```
// file produce output files as : 'export-1.jpg', ... 'export-10.jpg', ...
$ghostscript->setOutputFile(__DIR__ . DIRECTORY_SEPARATOR . 'output' . DIRECTORY_SEPARATOR . 'export-%01d.jpg');

// file produce output files as : 'export-001.jpg', ... 'export-010.jpg', ...
$ghostscript->setOutputFile(__DIR__ . DIRECTORY_SEPARATOR . 'output' . DIRECTORY_SEPARATOR . 'export-%03d.jpg');
```

Specify page range
------------------

[](#specify-page-range)

```
$ghostscript->setPages(int $startPage, int $endPage);
```

or set start and end explicitly

```
$ghostscript->setPageStart(int $page);
$ghostscript->setPageEnd(int $page);
```

Clear specified page range
--------------------------

[](#clear-specified-page-range)

```
$ghostscript->clearPageRange();
```

Subsample antialiasing
----------------------

[](#subsample-antialiasing)

These options control the use of subsample antialiasing. Their use is highly recommended for producing high quality rasterizations of the input files. Use `Ghostscript::ANTIALIASING_HIGH` for optimum output, user `Ghostscript::ANTIALIASING_LOW` or `Ghostscript::ANTIALIASING_NONE` for faster rendering. Antialiasing can be set separately for text and graphics content, but only for image type output devices.

```
$ghostscript->setAntiAliasing(
    Ghostscript::ANTIALIASING_HIGH ||
    Ghostscript::ANTIALIASING_LOW ||
    Ghostscript::ANTIALIASING_NONE
);
```

or set text and graphics antialiasing explicitly

```
$ghostscript->setTextAntiAliasing(
    Ghostscript::ANTIALIASING_HIGH ||
    Ghostscript::ANTIALIASING_LOW  ||
    Ghostscript::ANTIALIASING_NONE
);

$ghostscript->setGraphicsAntiAliasing(
    Ghostscript::ANTIALIASING_HIGH ||
    Ghostscript::ANTIALIASING_LOW  ||
    Ghostscript::ANTIALIASING_NONE
);
```

Output resolution
-----------------

[](#output-resolution)

This option sets the resolution of the output file in dots per inch. The default value if you don't specify this options is 72 dpi. Support for specifying horizontal and vertical resolution.

```
$ghostscript->setResolution(int $hdpi, int $vdpi = null);
```

Setting CIE Color
-----------------

[](#setting-cie-color)

Set UseCIEColor in the page device dictionary, remapping device-dependent color values through a Postscript defined CIE color space. Document DeviceGray, DeviceRGB and DeviceCMYK source colors will be substituted respectively by Postscript CIEA, CIEABC and CIEDEFG color spaces. Only for image type output devices.

```
$ghostscript->setUseCie(bool $useCie);
```

Setting page content region
---------------------------

[](#setting-page-content-region)

Sets the page size to one of the following :

- **BleedBox** (`Ghostscript::BOX_BLEED`) : defines the region to which the contents of the page should be clipped when output in a production environment. This may include any extra bleed area needed to accommodate the physical limitations of cutting, folding, and trimming equipment. The actual printed page may include printing marks that fall outside the bleed box.
- **TrimBox** (`Ghostscript::BOX_TRIM`) : defines the intended dimensions of the finished page after trimming. Some files have a TrimBox that is smaller than the MediaBox and may include white space, registration or cutting marks outside the CropBox. Using this option simulates appearance of the finished printed page.
- **ArtBox** (`Ghostscript::BOX_ART`) : defines the extent of the page's meaningful content (including potential white space) as intended by the page's creator. The art box is likely to be the smallest box. It can be useful when one wants to crop the page as much as possible without losing the content.
- **CropBox** (`Ghostscript::BOX_CROP`) : Unlike the other "page boundary" boxes, CropBox does not have a defined meaning, it simply provides a rectangle to which the page contents will be clipped (cropped). By convention, it is often, but not exclusively, used to aid the positioning of content on the (usually larger, in these cases) media.
- **NONE** (`Ghostscript::BOX_NONE`)

```
$ghostscript->setBox(
    Ghostscript::BOX_BLEED,
    Ghostscript::BOX_TRIM,
    Ghostscript::BOX_ART,
    Ghostscript::BOX_CROP,
    Ghostscript::BOX_NONE
);
```

Handling exceptions
-------------------

[](#handling-exceptions)

`PHPGhostscript` will throw following exceptions :

- `InvalidArgumentException` : thrown if an argument is not of the expected type.
- `GhostscriptException` : thrown if Ghostscript was unable to transcode.

```
$ghostscript = new Ghostscript();
try {
    $ghostscript
        ->setBinaryPath('C:\Program Files\gs\gs9.27\bin\gswin64.exe')
        ->setDevice(DeviceTypes::JPEG)
        // Force excetion - invalid file ; supports only for PDF & PS
        ->setInputFile(__DIR__ . DIRECTORY_SEPARATOR . 'assets' . DIRECTORY_SEPARATOR . 'invalidfile.docx')
        ->setOutputFile(__DIR__ . DIRECTORY_SEPARATOR . 'output' . DIRECTORY_SEPARATOR . 'export.jpg');
    if (true === $ghostscript->render()) {
        echo 'success';
    } else {
        echo 'error';
    }
} catch (InvalidArgumentException $e) {
    var_dump($e->getMessage());
} catch (GhostscriptException $e) {
    var_dump($e->getMessage());
}
```

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 60% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~743 days

Total

3

Last Release

991d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/337b3f5307c36abe8e7ff54e0404793e1e602866da4bb80256c723b1aeeaccd8?d=identicon)[DaanDeSmedt](/maintainers/DaanDeSmedt)

---

Top Contributors

[![DaanDeSmedt](https://avatars.githubusercontent.com/u/1093123?v=4)](https://github.com/DaanDeSmedt "DaanDeSmedt (6 commits)")[![llforns](https://avatars.githubusercontent.com/u/202604600?v=4)](https://github.com/llforns "llforns (4 commits)")

---

Tags

ghostscriptghostscript-wrapperpdfphppostscriptphppdfhtmlwrapperpngjpgghostscriptpostscript

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/daandesmedt-phpghostscript/health.svg)

```
[![Health](https://phpackages.com/badges/daandesmedt-phpghostscript/health.svg)](https://phpackages.com/packages/daandesmedt-phpghostscript)
```

###  Alternatives

[daandesmedt/phpheadlesschrome

A PHP wrapper for using Google Chrome Headless mode. Convert URL or HTML to a PDF / screenshot. Easy to use and OOP interfaced.

92233.1k](/packages/daandesmedt-phpheadlesschrome)[spiritix/php-chrome-html2pdf

A PHP library for converting HTML to PDF using Google Chrome

153472.0k3](/packages/spiritix-php-chrome-html2pdf)[aspose-cloud/aspose-words-cloud

Open, generate, edit, split, merge, compare and convert Word documents. Integrate Cloud API into your solutions to manipulate documents. Convert PDF to Word (DOC, DOCX, ODT, RTF and HTML) and in the opposite direction.

32157.4k](/packages/aspose-cloud-aspose-words-cloud)[mostafaznv/pdf-optimizer

PDF optimization tool for PHP and Laravel applications

170125.8k](/packages/mostafaznv-pdf-optimizer)[imal-h/pdf-box

The most advanced, driver-based PDF manipulation library for PHP v3.0. Supports Ghostscript, Chrome Headless (HTML to PDF), OpenSSL/FPDI (Signing), and PDFtk (Forms).

60403.9k](/packages/imal-h-pdf-box)[nilgems/laravel-textract

A Laravel package to extract text from files like DOC, XL, Image, Pdf and more. I've developed this package by inspiring "npm textract".

195.2k](/packages/nilgems-laravel-textract)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)