bernhard

RockPdf - mPDF helper module

Recommended Posts

@Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.

Description from PW Weekly:

Quote

Now, in a nutshell RockPdf is a wrapper for the mpdf library. Mpdf, as you may already know, is a commonly used PHP library that turns HTML content into PDF, complete with (at least basic) CSS styling, embedded images, and so on. While you could include the mpdf library directly in your code, accessing it through a module has some benefits:

First of all you have access to an instance of mpdf anywhere in your template or module files simply by calling $modules->get('RockPdf') – no need to include any additional files or anything like that.

RockPdf makes debugging layout issues notably easier by embedding parameters passed to its functions as HTML comments into the generated markup, and also by giving you an easy method to fetch the generated markup as-is.

While mpdf by default includes a massive blob of fonts, with RockPdf you get only the ones you really need – and you can still add more if needed, just by dropping the font files into specific directory.

Perhaps the most notable benefit from using RockPdf instead of directly including mpdf is related to the first bullet point above: by using RockPdf you get to keep your template and module files clean, and the API usage is always consistent. As an added bonus you also don't have to worry about keeping the mpdf library manually up to date.

 

Modules Directory: https://modules.processwire.com/modules/rock-pdf/

Download & Docs: https://gitlab.com/baumrock/RockPdf

 

You can combine it easily with RockReplacer: 

See also a little showcase of the RockPdf module in this thread:

 

  • Like 12
  • Thanks 4

Share this post


Link to post
Share on other sites

Thanks Benhard for this module, small modification i've updated the save() function to allow various output types as stated:

https://mpdf.github.io/reference/mpdf-functions/output.html

 

/* ########## output ########## */

  /**
   * save output to:
    local file ($dest = "FILE")
    download ($dest = "DOWNLOAD")
    inline to browser (default - $dest = "INLINE")
   */
    
  public function save($filename = 'output.pdf', $dest = "INLINE") {
    if(!$filename) $filename = 'output.pdf';
    if($dest == "FILE") $filename = $this->getAbsolute($filename);  // save to disk
    $this->mpdf->Output($filename, constant('\Mpdf\Output\Destination::'.$dest));
  }

// stream to browser
$pdf->save();
$pdf->save('filename.pdf')
$pdf->save('filename.pdf,'INLINE);

// force download
$pdf->save('myfile.pdf','DOWNLOAD'); 

// save locally
$pdf->save('myfileserver.pdf','FILE'); 

 

  • Like 3

Share this post


Link to post
Share on other sites

You should add this module to the modules directory , it rocks 👍

  • Like 3

Share this post


Link to post
Share on other sites

Thx @Mackski I've done a slightly different approach: You now have the option between three methods:

  • save()
  • show()
  • download()

The save() method will return the resulting file urls and paths on success:

save.png

output.png

@flydev thx I've added it to the modules directory 😉

  • Like 7

Share this post


Link to post
Share on other sites

bernhard,

I've been working on a project with mPDF and there are lots of variants to the PDF content and how they are saved/downloaded, etc...

It got me thinking about making a PW helper module to make things a little more sane to deal with. I decided to see how others were dealing with PDF creation within ProcessWire, and whaddya know — what I was imagining already exists.

Just wanted to say thank you!

  • Like 5

Share this post


Link to post
Share on other sites

Thank you! Happy to hear that and glad I could give something back to you, Reno - thanks for all your great contributions 🙂 

  • Like 4

Share this post


Link to post
Share on other sites

Updated the module to make sure the filepath exists. I also added an example in the readme how to set a background:

rrZC01M.png 

WQj8PTG.png 

  • Like 4

Share this post


Link to post
Share on other sites

I have problems printing images embedded into a textarea if the config.php has this setting: $config->pagefileSecure=true

ERROR: Could not find image file (.............. /site/assets/files/2922/unterschrift.jpg)

The file actually is stored under this path: ............... /site/assets/files/-2922/unterschrift.jpg

Share this post


Link to post
Share on other sites

Thx for reporting! I can have a look next week or maybe you can do a pr or share your investigations until then?

Share this post


Link to post
Share on other sites

Did anyone else encounter problems with `show()` and `download()`? If I use them, all I get is blank pages resulting in an invalid PDF. The `save()` function works as expected though.

I’m running PW 3.0.98 with PHP 7.1.12 and RockPdf 1.0.1

Share this post


Link to post
Share on other sites

No problems here. Which Browser? Can you try whether using the original mpdf code works (without using my shortcuts)?

Share this post


Link to post
Share on other sites

Latest Chrome/Safari/Firefox on macOS 10.14 show all the same problem. The weird thing is it creates the correct amount of pages in the PDF, they’re just blank.

Calling `$mpdf->Output($filename, \Mpdf\Output\Destination::DOWNLOAD);` directly results in the same error.

  • Thanks 1

Share this post


Link to post
Share on other sites

Hey @charger, thx for that info. Could you please check if that is the same in a non-pw setup? I mean creating a php file only for that purpose, importing mpdf, creating the pdf and trying the show() and download() equivalents of mpdf?

Share this post


Link to post
Share on other sites

Interesting. I got some mime-type errors in the console from time to time. Maybe that could be the reason? No idea how I should track that down since everything is working fine on my side 😐 

Share this post


Link to post
Share on other sites

What kind of mime-type errors? And how could that be related to PW only but not the webserver or PHP in general?

I also just checked it on the webserver (was on localhost before): same problem there. It’s weird that one option would work while the other two wouldn’t. I can’t make sense of it atm.

Share this post


Link to post
Share on other sites
Quote

JqueryCore.js?v=1539002242:2 Resource interpreted as Document but transferred with MIME type application/pdf: "http://www.rockcrm.test/site/assets/files/1156/hn2018-029.pdf?modal=panel&pw_panel=1".

PW can set the mime type, so I guess it could be related to it. But I've never used this feature, so I don't really have an idea. I also don't have time to look into that atm. Maybe someone is more experienced in this area and can help...

Edit-Template--basic-page-•.png

Share this post


Link to post
Share on other sites

Just a note if anybody gets in trouble when creating complex PDFs... It seems that there is some bug related to the tempdir that is created for the pdf. If the PDF takes long to render it can happen that this folder is deleted automatically before the PDF is done. Then you'll get an error. In my case this solved it:

$pdf = $modules->get('RockPdf');
$pdf->settings([
  'tempDir' => $this->config->paths->root . 'site/assets/cache/WireTempDir/.RockPdf/test/',
]);

For sure just a quickfix, but I'm busy...

  • Like 2

Share this post


Link to post
Share on other sites
22 hours ago, bernhard said:

Just a note if anybody gets in trouble when creating complex PDFs... It seems that there is some bug related to the tempdir that is created for the pdf. If the PDF takes long to render it can happen that this folder is deleted automatically before the PDF is done. Then you'll get an error. In my case this solved it:


$pdf = $modules->get('RockPdf');
$pdf->settings([
  'tempDir' => $this->config->paths->root . 'site/assets/cache/WireTempDir/.RockPdf/test/',
]);

For sure just a quickfix, but I'm busy...

Hmm, that didn’t help on my side. I still see the "Unable to remove" errors in the wire-temp-dir logfile, now they’re just referring to the newly set directory. And yes, these are more complex PDFs, but not overly complex (~3MB).

Share this post


Link to post
Share on other sites
22 hours ago, bernhard said:

If the PDF takes long to render it can happen that this folder is deleted automatically before the PDF is done.

FYI, you can set the age the temp directory lives for with the maxAge option:

$files->tempDir('RockPdf', ['maxAge' => 600]);
// or
$files->tempDir('RockPdf', 600);

 

  • Like 1

Share this post


Link to post
Share on other sites
23 hours ago, bernhard said:

PW can set the mime type, so I guess it could be related to it. But I've never used this feature, so I don't really have an idea.

 

This will not work for me as I generate the PDF if there’s a "pdf" GET parameter found (this is e.g. how https://github.com/wanze/Pages2Pdf handles it as well). That’s why I was pursuing another way meanwhile: the wireSendFile() function (https://github.com/processwire/processwire/blob/master/wire/core/Functions.php#L257https://github.com/wanze/Pages2Pdf/blob/master/Pages2Pdf.module#L312).

Here’s the relevant code from my template file:

$inputPdf = $input->get('pdf');
$inputPdfSan = $sanitizer->int($inputPdf);

if ($inputPdfSan == 1) {
    $pdf = $modules->get('RockPdf');
    $pdf->settings([
        'tempDir' => $this->config->paths->root . 'site/assets/cache/WireTempDir/.RockPdf/test/',
        ],
        'mode' => 's',
        'mirrorMargins' => 1,
    ]);
    $mpdf = $pdf->mpdf;

	$mpdf->WriteHTML('Hello World ' . date('H:i:s'));
	$filename = $page->name . '-pdf-' . $page->id . '.pdf';
	$response = $pdf->save($filename);
    wireSendFile($response->path, array('forceDownload' => true));
}

However, the problem remains: the PDFs do get saved correctly, but when trying to download them (either via wireSendFile() or RockPDF’s download()), they are blank or corrupted.

Share this post


Link to post
Share on other sites
20 minutes ago, Robin S said:

FYI, you can set the age the temp directory lives for with the maxAge option:


$files->tempDir('RockPdf', ['maxAge' => 600]);
// or
$files->tempDir('RockPdf', 600);

  

Thanks for the hint, wasn’t aware of that. But if the default age for a temp folder is 120 seconds, then that should be plenty of time already. The PDF generation maybe takes around 3 seconds.

Share this post


Link to post
Share on other sites
52 minutes ago, Robin S said:

YI, you can set the age the temp directory lives for with the maxAge option:

Thx robin I know about that but somehow it didn't work. I need to see why and when that happens, but setting the maxage didn't solve it unfortunately.

Share this post


Link to post
Share on other sites

The following line in RockPdf.module.php returns a wrong URL if the PW installation lives in a subdirectory (subdirectory is applied twice):

'httpUrl' => rtrim($this->pages->get(1)->httpUrl, '/') . $url,

 

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By cosmicsafari
      Hi all,
      Just wondering if someone with a bit more PW knowledge than me could give a run down of what this method actually does and how its achieved.
      I get that it rebuilds image variations but based on what settings?
      If I wanted to rebuild all the websites image variations but at say a reduced image quality can this be set somewhere globally that this method would take into account?
      For some context I have built a fairly simple module to delete all the image variations connected to any FieldtypeImage which is being used on the website, for the most part this works quite well. As I was quite happy with how that turned out I figured I would give the module another option to rebuild the images also. So there would be a 'Remove' and 'Rebuild' button on the modules config page.
      The idea being that I could use this tool to delete all the image variations, update some global settings then regenerate them all but currently it doesn't appear to do that.
      I assume this is either because my codes borked or im misunderstanding something fundamental about how rebuildVariations() works.
    • By adrian
      Tracy Debugger for ProcessWire
      The ultimate “swiss army knife” debugging and development tool for the ProcessWire CMF/CMS

       
      Integrates and extends Nette's Tracy debugging tool and adds 30+ custom tools designed for effective ProcessWire debugging and lightning fast development
      The most comprehensive set of instructions and examples is available at: https://adrianbj.github.io/TracyDebugger
      Modules Directory: http://modules.processwire.com/modules/tracy-debugger/
      Github: https://github.com/adrianbj/TracyDebugger
      A big thanks to @tpr for introducing me to Tracy and for the idea for this module and for significant feedback, testing, and feature suggestions.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.51
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 
    • By anderson
      Hi all,
      I'm a new to website building. Learned some CRASH course of js,jquery,php. Then I found CMS. Still learning around forum, youtube....
      Anyway, please help me with some beginer questions:
      1, About template - please correct me if I understand wrong : every page should be (or recommended) built on a template. So if in total I'll have 10 pages, 2 of them have same layout, I'll need 9 templates.  And, what fields a page includes, is not defined in page, but defined in the template that page uses. 
      2,  Where to see what modules I've installed? is it in "Modules - Site"? 
      3, I installed "PageTable Extended", then what?  As in a youtube tutorial, it should appear in Setup tab, but it doesn't.  What's in there: templates,fields,logs,comments. (I installed "Uikit 3 site_blog profile".)
      4, I did a search in Processwire website for the famous "repeater matrix" module, and can not find it, there's a Repeater, as well as a Matrix. Is it not a module?
      5, I watched this youtube tuts: https://www.youtube.com/watch?v=IHqnLQy9R1A
      Anybody familiar with this tuts please help: 
      After he analysed a target webpage layout he wanted to mimic, he created some fields, some template, then based on those he created a page and input some "content" in there, then clicked "view", it's just some text. So, here comes my question, he copied a folder "assets" (subfolders are: css,fonts,js,img) over, then the page have the appearance/layout he wanted to mimic. Where does that assets folder come from?
      Appreciate any help.