Jump to content
bernhard

RockPdf - mPDF helper module

Recommended Posts

1 hour ago, dragan said:

Yeah... using inline SVGs works just fine... until you want to style fills or strokes via CSS.

Yeah, I also had this problem. I managed to style the icon using inline styles (doing that manually first), eg <path fill=red ... > but I couldn't find a way to control the size of the icon. I tried several approches. I even used the SVG as <img src=...> but then the coloring part didn't work any more. TTF now works find for both situations except for duotone icons (which would be nice but not necessary).

1 hour ago, dragan said:

I have the fonts both in site/templates/fonts/ as well as in site/assets/RockPDF/fonts/. I have now also placed them in site/modules/RockPdf/vendor/mpdf/mpdf/ttfonts, cleared modules cache, but the error persists.

Please follow the new readme exactly, I'm using the font https://www.fontsquirrel.com/fonts/rock-salt successfully in my PDF:

L8xga4w.png

This is my setup for this font + fontawesome pro:

    /** @var RockPdf $pdf */
    $pdf = $this->modules->get('RockPdf');
    $pdf->settings([
      'mode' => 'utf-8',
      'format' => 'A3-L',
      'dpi' => 300,
      'img_dpi' => 300,

      // fonts
      'fontdata' => (new \Mpdf\Config\FontVariables())->getDefaults()['fontdata'] + [
        'fancy' => [
          'R' => 'RockSalt.ttf',
          'I' => 'RockSalt.ttf',
        ],
        "fab" => [
          'R' => "fa-brands-400.ttf",
          'I' => "fa-brands-400.ttf",
        ],
        "fad" => [
          'R' => "fa-duotone-900.ttf",
          'I' => "fa-duotone-900.ttf",
        ],
        "fal" => [
          'R' => "fa-light-300.ttf",
          'I' => "fa-light-300.ttf",
        ],
        "far" => [
          'R' => "fa-regular-400.ttf",
          'I' => "fa-regular-400.ttf",
        ],
        "fas" => [
          'R' => "fa-solid-900.ttf",
          'I' => "fa-solid-900.ttf",
        ],
      ],
    ]);
    ...

Then I can just add the "fancy" class to get the RockSalt font. Don't forget to define the font in CSS:

.fancy { font-family: fancy; }

Does that help?

  • Like 1

Share this post


Link to post
Share on other sites

I have also recently used https://www.joypixels.com/ for converting emojis from UTF8 into something that works in a PDF. I use this to format messages created in a CkEditor field with the emoji plugin into a PDF summary of messages. It's not perfect, but seems to match almost all emojis from the CkEditor plugin.

Would be curious if anyone has any other suggestions on this front.

Share this post


Link to post
Share on other sites

@bernhard Thanks for the hints. I didn't notice I was uploading .otf files instead of .ttf - my 2nd facepalm moment yesterday...

As to the other issue I mentioned: I found out it's not related to RockPDF at all. I got some really weird issues with render() / wireRenderFile() - but only when I ran my code inside Tracy console. In a regular template everything works as expected. The issue was with matrix repeaters that are called with $child->render('offer_matrix') inside the template, where I use field template files* - suddenly PW wouldn't find these anymore.

* site/templates/fields/matrix.php
site/templates/fields/matrix/body.php
site/templates/fields/matrix/gallery.php
site/templates/fields/matrix/slideshow.php
etc.

Share this post


Link to post
Share on other sites

Did I already mention that I don't like repeaters? 😄 Glad you sorted it out 😉

Share this post


Link to post
Share on other sites
9 hours ago, dragan said:

but only when I ran my code inside Tracy console. In a regular template everyting works as expected.

I think you might have come up against this bug (https://github.com/processwire/processwire-issues/issues/511). If you think it is related, perhaps you could nudge Ryan on that issue as he seems to be ignoring my concerns on this, especially when it's a really easy fix.

  • Like 2

Share this post


Link to post
Share on other sites

Just updated the readme with an example of page cropping marks and bleed margins sometimes necessary for printing:

Page margins for print with cropmarks

// thx to https://stackoverflow.com/a/50245034/6370411
$pdf = $modules->get('RockPdf');
$pdf->settings([
  'mode' => 'utf-8',
  'format' => [214, 301],
  'img_dpi' => 300,
]);
$pdf->write('
<style>
  @page {
    /* regular A4 paper size is 210x297 */
    size: 211mm 298mm; /* trying some weird format to make sure it works */
    marks: crop;
  }
</style>
Content
');
d($pdf->save());

img

img

You see that the Trim Box shows our custom values 211x298 whereas the bounding box would show the paper size (214x301).

Real life example using RockPdf and RockLESS

// parts of RockPdfCalendar module

  public function init() {
    $this->w = $w = 420; // paper width in mm
    $this->h = $h = 297; // paper height in mm
    $this->b = $b = 2; // bleed in mm

    /** @var RockPdf $pdf */
    $pdf = $this->modules->get('RockPdf');
    $pdf->settings([
      'mode' => 'utf-8',
      'format' => [($w+2*$b), ($h+2*$b)],
      'dpi' => 300,
      'img_dpi' => 300,
    ]);
    $this->addBackground($pdf);
    $this->addStyles($pdf);

    $this->pdf = $pdf;
  }

  /**
   * Add Background PDF
   * @return void
   */
  public function addBackground($pdf) {
    $page = $this->pages->get("template=settings");
    $pdfs = $page->getUnformatted('calendarbackground');
    if(!$pdfs OR !$pdfs->count()) return; // no field or no file
    $pdf->set('SetDocTemplate', $pdfs->first()->filename);
  }

  /**
   * Add styles
   */
  public function addStyles($pdf) {
    /** @var RockLESS $less */
    $less = $this->modules->get('RockLESS');
    $less->vars = [
      'w' => $this->w."mm",
      'h' => $this->h."mm",
      'b' => $this->b."mm",
    ];
    $css = $less->getCSS(__DIR__ . "/style.less")->css;
    $pdf->write("<style>\n$css</style>");
  }

Then all you have to do is call $modules->get('RockPdfCalendar')->show() to render the pdf in the browser 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Just discovered a technique that can save you lots of time and headache!

Debugging can be a pain when creating PDFs, but it gets a lot simpler if you use this handy trick. I'm hooking into pageNotFoud to create the pdf:

$this->addHookBefore('ProcessPageView::pageNotFound', $this, 'renderCalendar');

If everything goes right, the calendar shows up in the browser:

xFg5SxG.png

But there's one problem: We don't know anything about errors, warnings, etc. Logging them into the pw logs is a pain compared to the Tracy Debugbar, so here's how you can have both - the generated HTML of the PDF and the debug bar:

We create the PDF BEFORE the 404 is thrown, but we create the HTML AFTER the 404:

$this->addHookBefore('ProcessPageView::pageNotFound', $this, 'renderCalendar');
$this->addHookAfter('ProcessPageView::pageNotFound', $this, 'renderCalendarDebug');

  /**
   * Render PDF calendar
   */
  public function renderCalendar(HookEvent $event) {
    $url = $event->arguments(1);
    $cal = $this->modules->get('RockPdfCalendar');

	// check url etc
    ...
    // generate the PDF
    $pdf = $cal->pdf; /** @var RockPdf $pdf */
    ...

    $title = 'Kaumberg Kalender ' . date("Y-m", $start);
    $pdf->set('setTitle', $title);
    $pdf->write($cal->render());

    // if html get parameter is set we return the html output
    $this->session->calHTML = null;
    if($this->user->isSuperuser() AND $this->input->get->html) {
      $this->session->calHTML = $pdf->html();
      return;
    }
    $pdf->show("$title.pdf");
    die();
  }

  /**
   * Output calendar for debugging
   * @return void
   */
  public function renderCalendarDebug(HookEvent $event) {
    if($this->session->calHTML) $event->return = $this->session->calHTML;
  }

D6vvaPD.png

😎

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for another great module @bernhard

Wanted to share my experiences changing from Pages2PDF to RockPdf. Wasn't quite as straightforward as I'd hoped. Such is life, but I got there. Pages2Pdf uses mPDFv5+ while RockPdf uses mPDFv7+ and I needed some of the newer features.

Things Iearned along the way:

1. If you need to use @page, you lose everything in the template 

$pdf->set('header', '...');

 settings. This has nothing to do with RockPdf but a 'feature' of mPDF

2. It's much easier to add custom fonts to RockPdf than Pages2PDF

3. You can display images in a circle using background-image but they don't print so that's not helpful, LOL

This is NOT a full tutorial but hopefully will give you some pointers on how I got RockPdf working for a fairly specific PDF design.

RockPdf template settings:

<?php

    $pdf = $modules->get('RockPdf');

    $pdf->settings([
        'fontdata' => (new \Mpdf\Config\FontVariables())->getDefaults()['fontdata'] + [
             "montserrat" => [
                'R' => "montserrat-regular.ttf",
                'B' => "montserrat-bold.ttf",
            ],
            "montserratlight" =>[
                'R' => "montserrat-light.ttf"
            ],
            "montserratthin" => [
                'R' => "montserrat-thin.ttf"
            ]
        ],

        'defaultheaderline' => 0,

        'font_size' => 9,
        'mode' => 'utf-8',
        'font' => 'montserrat',
        'page_format' => 'A4',
    ]);

    $css = wireRenderFile($config->paths->templates . 'RockPdf/styles-v3.css');
    $pdf->write("<style>" . $css . "</style>");

    $body = wireRenderFile($config->paths->templates . 'RockPdf/profile_pdf_cv-v3.php');
    $pdf->write($body);

    $pdfFile = $sanitizer->pageName($profile->title) . "-" . $profile->id . ".pdf";

    $pdf->show($pdfFile);
    die();

//    Remove old Pages2PDF settings
//    $mpdf->markupMain   = $config->paths->templates . 'RockPdf/profile_pdf_cv-v3.php';
//    $mpdf->markupHeader = $config->paths->templates . 'RockPdf/_header-v3.php';
//    $mpdf->markupFooter = $config->paths->templates . 'pages2pdf/_footer-v2.php';
//    $mpdf->cssFile = $config->paths->templates . 'RockPdf/styles-v3.css';
//    $mpdf->pageOrientation = 'P';
//    $mpdf->pageFormat = 'A4';
//    $mpdf->topMargin = 9.5;
//    $mpdf->rightMargin = 0;
//    $mpdf->bottomMargin = 9;
//    $mpdf->leftMargin = 0;
//    $mpdf->headerMargin = 0;
//    $mpdf->footerMargin = 0;
//    $mpdf->fontSize = 9;
//    $mpdf->mode = 's';
//    $mpdf->font = 'montserrat';

Header code:

    <div style="
        background-color: #007ee5;
        height: 10mm;
        margin: 0;
        top: 0;
        left: 0;
        right: 0;
        width: 100%;
">
    </div>

Page layout code:

<?php

// header is the same on all pages but need more spacing on all pages except the first
$header = wireRenderFile($config->paths->templates . 'RockPdf/_header-v3.php');
?>
<htmlpageheader name="myHeaderFirst" style="display:none">
    <?=$header?>
</htmlpageheader>

<htmlpageheader name="myHeader" style="display:none">
    <?=$header?>
</htmlpageheader>

<sethtmlpageheader name="myHeaderFirst" value="on" show-this-page="1" />
<sethtmlpageheader name="myHeader" value="on" />



<div class="user-dets">

CSS:

/*
Additional fonts added to:
site/assets/RockPdf/fonts

*/
@page {
    margin: 15mm 0 0 0; /* <any of the usual CSS values for margins> */
    /*(% of page-box width for LR, of height for TB) */
    margin-header: 0; /* <any of the usual CSS values for margins> */
    margin-footer: 9mm; /* <any of the usual CSS values for margins> */
    marks: none;/*crop | cross | none*/
    header: html_myHeader;
}

@page :first {
    margin: 9.5mm 0 0 0; /* <any of the usual CSS values for margins> */
    /*(% of page-box width for LR, of height for TB) */
    margin-header: 0; /* <any of the usual CSS values for margins> */
    margin-footer: 9mm; /* <any of the usual CSS values for margins> */
    marks: none;/*crop | cross | none*/
    header: html_myHeaderFirst;

}

Hope this is useful.

Cheers
psy

 

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Thx for sharing your experience @psy 🙂 

43 minutes ago, psy said:

Wasn't quite as straightforward as I'd hoped. Such is life, but I got there.

mPdf is unfortunately not really a pleasure to work with 😞 It feels a bit like designing websites 20 years ago with lots of custom table layouts, custom styles, paddings, margins etc... But as you said: I also got there almost everytime and I didn't find a better solution yet.

Writing your styles as LESS can be helpful because you can create simple custom classes for any element and to the complex styling in CSS. Using LESS ensures that your style stays easy to maintain because you can use class inheritance and variables. RockPdf plays really well together with RockLESS. I added an example to the readme:

Combine RockPdf and RockLESS

$pdf = $modules->get('RockPdf');
$less = $modules->get('RockLESS');
$style = "
@padding-s: 10pt;
.border { border: 1pt solid #afafaf; }
.hello { .border; color: blue; padding-top: @padding-s; }
.world { .border; color: red; padding-top: @padding-s * 2; }
";
$css = "\n".$less->parse($style);
$pdf->write("<style>$css</style>");
$pdf->write("<div class='hello'>hello</div>");
$pdf->write("<div class='world'>world</div>");
d($pdf->save());

img

img

This is the result of $pdf->html()

<style>
.border {
  border: 1pt solid #afafaf;
}
.hello {
  border: 1pt solid #afafaf;
  color: blue;
  padding-top: 10pt;
}
.world {
  border: 1pt solid #afafaf;
  color: red;
  padding-top: 20pt;
}
</style>
<div class='hello'>hello</div>
<div class='world'>world</div>

 

  • Like 3

Share this post


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

mPdf is unfortunately not really a pleasure to work with 😞 It feels a bit like designing websites 20 years ago with lots of custom table layouts, custom styles, paddings, margins etc...

@bernhard Oh so true! Pdf's can look different between browser views and Acrobat Reader too. 

  • Like 1

Share this post


Link to post
Share on other sites
On 4/22/2020 at 10:18 PM, bernhard said:

Writing your styles as LESS can be helpful because you can create simple custom classes for any element and to the complex styling in CSS.

Hi @bernhard

Yes, RockLESS, SCSS and other CSS preprocessors can be useful. One thing I learned the hard way however is that the header is loaded before any HTML or CSS. The only way I could style the header to look as intended was with inline styles. I certainly used classes with the limited CSS styling available from mPDF in the body. Maybe there's a better way, just didn't have the time or patience to explore.

Another limitation was with tables... I needed a centered heading and left aligned text within a table cell. Nope, if the <td> is left aligned, so is everything within the cell. Had to revert to divs which had an impact on the design. Told the graphic designer to live with it - it is what it is! LOL

Having said that, love your module and mPDF, even with its constraints, is still the best HTML to PDF converter.

 

  • Like 2

Share this post


Link to post
Share on other sites

Aligning things is tricky, but most things work using nested tables (that's what I meant when saying "like 20 years ago"). What about this?

$pdf = $modules->get('RockPdf');
$table = '
<style>
td { border: 1pt solid black; }
.center {text-align: center;}
</style>
<table>';
$table .= '<tr><td class="center">foo</td><td>bar</td></tr>';
$table .= '<tr><td>Donec vitae sapien ut libero</td><td>Donec vitae sapien ut libero</td></tr>';

$td = "<table><tr><td class='center'>sub-heading</td></tr><tr><td>Phasellus ullamcorper ipsum rutrum nunc</td></tr></table>";
$table .= "<tr><td>Donec vitae sapien ut libero</td><td>$td</td></tr>";

$table .= '</table>';
$pdf->write($table);
d($pdf->save()); // generate pdf

zEj9LUg.png

  • Like 2

Share this post


Link to post
Share on other sites

Yep, that's a solution - 20yrs ago HTML/CSS 😂 

In my particular case there are other factors. The user can choose to include/exclude bits which makes it an ugly, logistical nightmare.

34 minutes ago, psy said:

Told the graphic designer to live with it - it is what it is! LOL

 

  • Like 1

Share this post


Link to post
Share on other sites
On 10/17/2018 at 7:36 PM, charger said:

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

For anybody facing this problem which in my case invalid pdf will generate error  "one or more XREF chunks were not found".
Solved it by placing the rockpdf instance php code block on top of anything else.

Share this post


Link to post
Share on other sites
2 hours ago, pwfans said:

Solved it by placing the rockpdf instance php code block on top of anything else.

Thx for the report. Can you please give us some more details, I don't really understand what you mean 🙂 

Share this post


Link to post
Share on other sites

@bernhard sorry, i make you confuse by my bad english 😭

I mean, try to place this :

<?php
$pdf = $modules->get('RockPdf');
$pdf->write("pdf content");  
$pdf->show();
?>

before any html content, at first line if possible.

Share this post


Link to post
Share on other sites

Hi @bernhard,

thank you for the module, which is helpful in keeping the project structure clean.

I also use the MPDF barcode component to generate QR codes of the page URL.
For this it was necessary to add the MPDF QR Code library to the RockPDF module using following command inside the /site/modules/RockPdf directory:

$ composer require mpdf/qrcode

It would be great if this was already available in the basic version of the module so as not to jeopardize the upgradeability.
What do you think, is it interesting to add or rather an unusual special case?

Share this post


Link to post
Share on other sites

Thx @axelino and welcome to the forum 🙂 

I tried to test the library quickly but could not make it work. Could you please provide a PR and usage instructions for the readme so that I can check it quickly? Then I'm happy to add it to the module 🙂 

Share this post


Link to post
Share on other sites

Hi @bernhard, thanks for the welcome and your fast reply! 🙂
I'm happy you want to add it and try to prepare a PR with usage instructions tomorrow or monday.

  • Like 1

Share this post


Link to post
Share on other sites

I have the pdf render in a function to keep my template clean.

On top of the function I do

// maps
    $images = $page->flightplan_images;
    $image = "";
    foreach ($images as $i){
        $image .= '<img src="' . $i->url . '" uk-image>';
    }

 

Tried both $pdf->write() with some html with $image and

$mpdf->WriteHTML() with some html with $image.

 

All is there except for the images.

How do I output images in a pdf.

Share this post


Link to post
Share on other sites

Thanks @bernhard that works.

The image was also 2000+ pixels wide. That was also a reason it did not show. Not sure why.

Share this post


Link to post
Share on other sites

I use a textarea on the frontend that is saved in form. In that textarea on the frontpage paragraphs remain visible after save.

In the pdf all text is rendered after each other.

What is the best way to preserve paragraphs both on the page and the pdf?

Share this post


Link to post
Share on other sites

It's all about providing the correct HTML for mpdf. Just debug what is being sent to mpdf (eg using tracy bd() calls) and you should be able to resolve your problem.

Share this post


Link to post
Share on other sites

Hello all,

once again I have a problem how to integrate the PDF output into my page ...
(With a direct output I get it in the meantime, see here).

But now I use the standard template "Regular" (which is already included in the installation) and it uses the "Markup regions" method as output strategy.

Well, and this is where I get stuck. Because if I try it with the same method as in the link above, it wants to open a PDF in the browser, but there is ALWAYS an error message.

However, it can't be the code, a) I've already tried it only with the most necessary and b) any test code works wonderfully in "Tracy", whether I want to output it directly or save it, everything works.

Now I'm unfortunately a bit at the end of my ideas and hope to get some helpful tips from the community.

Would be happy, thank you and stay healthy
cu Ralf

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 robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...