Jump to content

RockPdf - mPDF helper module


bernhard

Recommended Posts

  • 2 weeks later...

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
Link to comment
Share on other sites

  • 1 month later...
  • 3 weeks later...

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
Link to comment
Share on other sites

  • 5 weeks later...
  • 3 weeks later...

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

Link to comment
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

Link to comment
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
Link to comment
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.

Link to comment
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

Link to comment
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
Link to comment
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).

Link to comment
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
Link to comment
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.

Link to comment
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.

Link to comment
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.

Link to comment
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 MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...