document-watermark's Introduction

Document Watermark

Generate text watermark on PDF and Word documents

Installation

Install document-watermark via composer

  $ composer require yasapurnama/document-watermark

Examples

Generate word document watermark. Using default section footer, text align right, font color 000000 and font size 10

$wordWatermark = WatermarkFactory::load(__DIR__ . '/files/word-sample.docx')
                            ->subDirectory('watermark')
                            ->setText('Last update on ' . date('m/d/Y'))
                            ->generate();

Generate PDF watermark with custom options

$pdfWatermark  = WatermarkFactory::load(__DIR__ . '/files/pdf-sample.pdf')
                            ->subDirectory('watermark')
                            ->setText('Last update on ' . date('m/d/Y'))
                            ->sectionHeader()
                            ->alignRight()
                            ->fontSize(9)
                            ->fontColor('ff0000')
                            ->generate();

Image watermark

Generate word document watermark using image at footer, with page margins x=1 y=1, align right, only in first page

$wordWatermark = WatermarkFactory::load(__DIR__ . '/files/word-sample.docx')
                            ->outputFile(__DIR__ . '/files/watermark/word-image-stamp-custom.docx')
                            ->setImage(__DIR__ . '/files/stamp.png')
                            ->sectionFooter(1, 1)
                            ->alignRight()
                            ->onlyFirstPage()
                            ->generate();

Generate pdf document watermark using image with default values

$pdfWatermark  = WatermarkFactory::load(__DIR__ . '/files/pdf-sample.pdf')
    ->outputFile(__DIR__ . '/files/watermark/pdf-image-stamp.pdf')
    ->setImage(__DIR__ . '/files/stamp.png')
    ->generate();

Contribute

Just submit pull request, your contributions are always welcomed!

Credits

This project was inspired by ajaxray's and using markpdf as depedencies.

document-watermark's People

Contributors

Stargazers

Watchers

document-watermark's Issues

PDF which name has space(s) would fail the command execution

Problem

Generating watermark on a PDF document which name has space(s) fails the command execution. I have not try this on a Word file.

Reproduce

$document = 'pdf doc with spaces.pdf';
WatermarkFactory::load($document)->setText('simple watermark')->generate();  // returns empty string instead

Temporary Solution

Using escapeshellarg() PHP function on getCommand() function on Yasapurnama\DocumentWatermark\PDFWatermark class.

// Yasapurnama\DocumentWatermark\PDFWatermark

...
        if ($this->image) {
            return sprintf(
                '%s %s %s %s %s %s',
                $this->getBinExecutable(),
                escapeshellarg($this->documentPath),  // escape the path as shell argument
                escapeshellarg($this->image),  // escape the path as shell argument
                escapeshellarg($this->outputFile),  // escape the path as shell argument
                $this->getPositionOption(),
                $this->getOpacityOption()
            );
        }

        return sprintf(
            '%s %s "%s" %s %s %s %s',
            $this->getBinExecutable(),
            escapeshellarg($this->documentPath),  // escape the path as shell argument
            $this->text,
            escapeshellarg($this->outputFile),  // escape the path as shell argument
            $this->getFontColorOption(),
            $this->getFontSizeOption(),
            $this->getPositionOption()
        );
...