Skip to content

Commit 465a490

Browse files
committed
Readme updated
1 parent d20a4db commit 465a490

File tree

1 file changed

+48
-6
lines changed

1 file changed

+48
-6
lines changed

README.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,59 @@ Add the service provider to the providers array in `config/app.php`.
3131
```
3232

3333
## Usage
34+
A basic usage example:
3435

3536
``` php
3637
use Webklex\PDFMerger\Facades\PDFMergerFacade as PDFMerger;
3738

38-
$oPDF = PDFMerger::init();
39+
$oMerger = PDFMerger::init();
3940

40-
$oPDF->setFileName('example.pdf');
41-
$oPDF->addPDF('first_pdf.pdf', '1');
42-
$oPDF->addPDF('second_pdf.pdf', 'all');
43-
$oPDF->merge();
44-
$oPDF->save('/somewhere/merged_result.pdf');
41+
$oMerger->addPDF('/path/to/project/vendors/webklex/PDFMerger/src/PDFMerger/examples/pdf_one.pdf', [2]);
42+
$oMerger->addPDF('/path/to/project/vendors/webklex/PDFMerger/src/PDFMerger/examples/pdf_two.pdf', 'all');
43+
44+
$oMerger->merge();
45+
$oMerger->save('merged_result.pdf');
46+
47+
```
48+
49+
...add raw content data:
50+
51+
``` php
52+
$oMerger->addString(file_get_contents('/path/to/project/vendors/webklex/PDFMerger/src/PDFMerger/examples/pdf_two.pdf'), [1]);
53+
54+
```
55+
56+
...select the pages you want to merge:
57+
58+
``` php
59+
$oMerger->addPDF($file, 'all'); //Add all pages
60+
$oMerger->addPDF($file, [1]); //Add page one only
61+
$oMerger->addPDF($file, [2]); //Add page two only
62+
$oMerger->addPDF($file, [1, 3]); //Add page one and three only
63+
64+
```
65+
66+
...stream the merged content:
67+
68+
``` php
69+
$oMerger->stream();
70+
71+
```
72+
...download the merged content:
73+
74+
``` php
75+
$oMerger->download();
76+
77+
```
78+
..get the raw content data:
79+
``` php
80+
echo $oMerger->output();
81+
82+
```
83+
...set the filename if you don't want to do it later:
84+
85+
``` php
86+
$oMerger->setFileName('example.pdf');
4587

4688
```
4789

0 commit comments

Comments
 (0)