Download the PHP package ajaxray/php-watermark without Composer
On this page you can find all versions of the php package ajaxray/php-watermark. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ajaxray/php-watermark
More information about ajaxray/php-watermark
Files in ajaxray/php-watermark
Package php-watermark
Short Description Add text or image watermark on images.
License MIT
Homepage http://github.com/ajaxray/php-watermark
Informations about the package php-watermark
PHPWatermark
Add text or image Watermark on image and PDF using PHP and ImageMagick.
Pre-requisite
- PHP (version 5.6 or higher)
- ImageMagick
- ghostscript (only for PDF watermarking)
PHP ImageMagick extension is not required.
Installation
Add as a dependency with composer
Or download latest version as a Zip file.
For PHP versions >= 5.6
to <8
use v0.1.2
Also you should check older readme file for PHP version <8
How to use?
If output file name is skipped for Watermark::write()
function, the source file will be overridden.
Customization options
The table below shows customization options and their support matrix.
Listed functions should be called on an object of Ajaxray\PHPWatermark\Watermark
.
Checkmark column titles means the following -
- Txt-Img: Watermarking with text on Image (sample, sample-tiled)
- Img-Img: Watermarking with Image on Image (sample)
- Txt-PDF: Watermarking with text on PDF (sample)
- Img-PDF: Watermarking with Image on PDF (sample)
⌛ = coming soon!
Function | Value | Txt-Img | Img-Img | Txt-PDF | Img-PDF |
---|---|---|---|---|---|
setFont('Arial') |
string; Font Name | ✅ | ✅ | ||
setFontSize(36) |
int; Font size | ✅ | ✅ | ||
setOpacity(.4) |
float; between 0 (opaque) to 1 (transparent) | ✅ | ✅ | ✅ | ✅ |
setRotate(245) |
int; between 0 to 360 | ✅ | ✅ | ||
setPosition($position) |
int; One of Watermark::POSITION_* constants |
✅ | ✅ | ✅ | ✅ |
setOffset(50, 100) |
int, int; X and Y offset relative to position | ✅ | ✅ | ✅ | ✅ |
setStyle($style) |
int; One of Watermark::STYLE_* constants |
⌛ | ✅ | ⌛ | ⌛ |
setTiled() |
boolean; (default true ) |
✅ | ✅ | ⌛ | ⌛ |
setTileSize(200, 150) |
int, int; Width and Height of each tile | ✅ | ⌛ |
BTW, all the samples linked above are the results of these examples. You may generate them yourself just by running example scripts from command line -
Then you should get the result files in vendor/ajaxray/php-watermark/examples/img
and vendor/ajaxray/php-watermark/examples/pdf
directories.
Something unexpected? Debug! 🐞🔫
If anything unexpected happened, try to debug the issue.
-
First step is to check if PHP is configured to display errors. Alternatively you may add these lines at the top of your script.
- A common reason of not getting expected result is mistakes in filepaths. You may try logging / printing source and destination file paths.
- Check the permission of the parent directory of destination path. Destination directory indicates -
- The file path mentioned in the second argument of
Watermark::withText()
andWatermark::withImage()
methods. - Parent of the source file itself if no separate destination mentioned in above methods.
- The file path mentioned in the second argument of
- There is
Watermark::setDebug()
method which will makeWatermark
object to return imagemagick command instead of executing it. Then, you may run the output manually to check if there is any error in underlyingimagemagick
commands.
Notes:
- To see the list of supported font names in your system, run
convert -list font
on command prompt - Remember to set appropriate output file extension (e,g, .pdf for pdf files)
- If possible, use absolute path for files to avoid various mistakes.
STYLE_IMG_*
constants are for Image watermarks andWatermark::STYLE_TEXT_*
are for text.- Default text style (
Watermark::STYLE_TEXT_BEVEL
) is expected to be visible on any background. Use other text styles only on selective backgrounds. - UnitTest are executed and all green against PHP 5.6 and PHP 7.1 using PHPUnit 5.7.5
- I'v tested all intended functionality with ImageMagick 7.0.4-6 Q16 x86_64 and GPL Ghostscript 9.20 installed.
Important Update for PDF watermarking:
When using the imagemagick + ghostscript extraction and joining pdf pages, it has a few drawbacks including file-size issue. Many developers were asking for a solution about the file size and PDF quality since releasing of this library. So, I've created a command line tool for PDF watermarking that will work without converting pages into images. As a result, you'll get better PDF quality and dramatically smaller file size.
https://github.com/ajaxray/markpdf
Please note that, it's not a PHP library. So you've to use it using exec, shell_exec or Symfony Process Component.
"This is the Book about which there is no doubt, a guidance for those conscious of Allah" - Al-Quran