Jump to content
adrian

PDF image generator

Recommended Posts

I have put together a very basic module for generating images from the pages of uploaded PDFs.

It requires imagemagick, ghostscript, and the imagick pecl extension. It could easily be adapted to work without the imagick extension, but I usually like having exec disabled.

At the moment it also requires a couple of specific custom fields: document_pdf (file) and document_thumb (image), both with "Maximum files allowed" set to "1". Obviously I will make these more generic, or add the fields on module install once this is closer to being released.

There is some commented code that facilitates image resizing before upload to PW if that is what is wanted. I should also make these configurable module options.

Currently I am using this for a searchable list of publications to generate a thumbnail of the cover to place with the description, PDF download link etc.

I am planning on extending this a fair bit as I want to use it to generate image previews for each page of the PDF so I can use them in a "look inside" modal lightbox. These would all be stored in a standard images field.

I think when I start generating images for all the pages I am going to run up against a speed problem. It could potentially take a few minutes to generate all the images for a large PDF. I was thinking of making use of lazycron, but I think I'd rather see some progress indicator. The other issue is if I use lazycron, then it is possible that someone may visit the site and go to use the look inside functionality before the images for all the pages are ready, so maybe this idea is out. Perhaps the best approach would be to hook into the PDF upload. Once the upload is complete, the module would start generating the images before the page is ever saved by the user. Would really appreciate any suggestions on how to set this up.

Off the topic a little, but one other minor consideration in all this is RGB vs CMYK colorspace. If the user uploads an RGB PDF then everything is fine, but if someone uploads CMYK PDFs the colors are often terrible, but there is a tweak that can be made to imagemagick to fix it. Here is a good description of the problem and how to fix it: http://www.lassosoft.com/CMYK-Colour-Matching-with-ImageMagick

 
Basically you need to add the command line option ''-dUseCIEColor'' to all of the GhostScript commands in the delegates.xml file, so that they now look like this:
<delegate decode="eps" encode="ps" mode="bi" command='"gs" -q -dBATCH 
      -dSAFER -dUseCIEColor -dMaxBitmap=500000000 -dNOPAUSE -dAlignToPixels=0
      -sDEVICE="pswrite" -sOutputFile="%o" -f"%i"' />
 

Would anyone else make use of this module?

Also, does anyone have any obvious suggestions for what I have so far. It's my first module, and I don't really have a handle on best practices yet.

Thanks!

PS I know convention is to attach module files, but this one is so short at the moment, it didn't seem worthwhile.

<?php

/**
 * ProcessWire ProcessPDFImageCreator
 *
 * Process PDF Image Creator creates images from PDFs.
 *
 * @copyright Copyright (c) 2013, Adrian Jones
 *
 */

class ProcessPDFImageCreator extends WireData implements Module {

    /**
     * Return information about this module (required)
     *
     * @return array
     *
     */
    static public function getModuleInfo() {
        return array(
            'title'    => 'PDF Image Creator',
            'summary'  => 'Creates images from PDFs.',
            'version'  => 001,
            'author'   => 'Adrian Jones',
            'singular' => true,
            'autoload' => true
        );
    }


    /**
     * Initialize the module and setup hook
     */
    public function init() {
        $this->pages->addHookAfter('save', $this, 'createPdfImage');
    }

    /**
     * If document_pdf field contains a PDF, generate an image from the first page.
     *
     *
     */
    public function createPdfImage($event) {

        $page = $event->arguments[0];

        if(count($page->document_pdf)>0){

            $src = $page->document_pdf->first()->url;

            if(count($page->document_thumb)==0){

                $pdf_filepath = $page->document_pdf->first()->filename . '[0]'; //the appended [0] refers to the first page of the PDF
                $jpg_filepath = str_replace('.pdf', '.jpg', $page->document_pdf->first()->filename);

                $resolution = 288;

                $im = new imagick();
                $im->setOption("pdf:use-cropbox","true");
                $im->setColorspace(Imagick::COLORSPACE_RGB);
                $im->setResolution($resolution,$resolution);
                $im->readImage($pdf_filepath);

                $geometry=$im->getImageGeometry();

                $width = ceil($geometry['width'] / ($resolution/72));
                $height = ceil($geometry['height'] / ($resolution/72));

                $im->setImageFormat("jpg");

                /*if($width>150){
                    $width = 150;
                    $height = 0;
                }
                $im->scaleImage($width, $height);*/

                $im->writeImage($jpg_filepath);

                $page->of(false);
                $page->document_thumb->add($jpg_filepath);
                $page->document_thumb->first()->description = $page->title . ' PDF thumbnail';
                $page->save();
            }

        }

    }

}
  • Like 7

Share this post


Link to post
Share on other sites

You could hook on save page instead. Just check if images already exist for the existing files, and if not, trigger the process for those that are missing.

Share this post


Link to post
Share on other sites

Hey diogo - thanks for your thoughts. So do you mean on save, rather than what I have which is after save? I changed it addHookAfter to just AddHook and it seems to work fine still. I already have a check to see if the document_thumb image field is populated. Anyway, I'll be sure to check for missing images from the full collection of pages images (in case something crashes, or the user kills the process), and just generate the missing ones on the next page save - good idea - thanks!

Once all the page images have been generated, subsequent saves of the page for other edits should be quick since it won't regenerate the images, although I should probably build in a check to see if the PDF has been changed from the original uploaded version so that new images are generated without the user needing to delete the old ones to trigger the function again. Any ideas how to check if the PDF has been replaced during the current edit?

Maybe the key thing is to add some JS loader when saving to ask them to be patient. Anyone have any better ideas?

Share this post


Link to post
Share on other sites

Ok, here is v2. It now uses a standard multi images field to store the images, and creates an image for each page of the PDF. I figure that way the template can just grab the first one where it needs to generate a cover thumbnail. Not relevant to the module, but I added a document_thumb_override field that allows a user to upload an image to use in place of the first page image if they'd prefer. Obviously the template checks to see if this is available before using the first page image.

I have several comments throughout the code on things I will add shortly:

  • Ability to see what images are missing (if any) and just generate those.
  • Check if the PDF was updated (so need to generate images again).
  • Add some loading spinner as this definitely takes a while
  • Ability to control set the required or max limit on the file dimensions - for a standard letter sized doc, the images are currently generated at 2448px x 3168px. The commented out scaleImage code needs to be activated, but tied to module config settings.

Also, should I have the module create any required fields, or just provide an explanation of how to adapt it to a user's particular scenario / field structure?

Thanks for any comments/suggestions.

<?php

/**
 * ProcessWire ProcessPDFImageCreator
 *
 * Process PDF Image Creator creates images from PDFs.
 *
 * @copyright Copyright (c) 2013, Adrian Jones
 *
 */

class ProcessPDFImageCreator extends WireData implements Module {

    /**
     * Return information about this module (required)
     *
     * @return array
     *
     */
    static public function getModuleInfo() {
        return array(
            'title'    => 'PDF Image Creator',
            'summary'  => 'Creates images from PDFs.',
            'version'  => 002,
            'author'   => 'Adrian Jones',
            'singular' => true,
            'autoload' => true
        );
    }


    /**
     * Initialize the module and setup hook
     */
    public function init() {
        $this->pages->addHook('save', $this, 'createPdfImages');
    }

    public function getNumPagesPdf($filepath){

        //The FPDI method is the best combination of accuracy and efficiency, but introduces yet another dependancy. There are also issues with the free version of FPDI and support for PDF > 1.4
        //If you have the paid version, I think this is the best option. It is available here: http://www.setasign.de/products/pdf-php-solutions/fpdi/

        /*require_once('/tcpdf/tcpdf.php');
        require_once('/fpdi/fpdi.php');

        $pdf =& new FPDI();

        $pagecount = $pdf->setSourceFile($filepath);
        return $pagecount;*/

        //If you have exec available, you can also try this option: http://stackoverflow.com/questions/14644353/finally-found-a-fast-easy-and-accurate-way-to-get-the-number-of-pages-in-a-pdf/14644354#14644354

        //The first of option here is because the imagick method is quite slow. It runs first and only resorts to the imagick option if it fails. Unfortunately, it often fails!
        $fp = @fopen(preg_replace("/\[(.*?)\]/i", "",$filepath),"r");
        $max=0;
        while(!feof($fp)) {
                $line = fgets($fp,255);
                if (preg_match('/\/Count [0-9]+/', $line, $matches)){
                        preg_match('/[0-9]+/',$matches[0], $matches2);
                        if ($max<$matches2[0]) $max=$matches2[0];
                }
        }
        fclose($fp);

        //If above failed ($max==0), then resort to imagick
        if($max==0){
            $im = new imagick($filepath);
            $max=$im->getNumberImages();
        }

        return $max;
    }


    /**
     * If document_pdf field contains a PDF, generate images for each page, stored in a standard multi images field.
     * Should maybe switch document_pdf field to a standard files field, or maybe get modules to install the field. Should the module check availability of required fields in general when installing?
     *
     */
    public function createPdfImages($event){
        $page = $event->arguments[0];

        if(count($page->document_pdf)>0){

            //Need to modify check with an OR to determine if PDF file was just updated from past uploaded version and also see if only some of the images exist and only generate the missing ones
            //Also need to store number of pages in document_pdf_num_pages field so don't have to run that check every time, unless the PDF changed.
            if(count($page->images)==0){
                $numPages = $this->getNumPagesPdf($page->document_pdf->first()->filename);

                for ($pn=0; $pn<$numPages; $pn++){
                    $this->createPdfImage($page, 'images', $pn);
                }
            }

        }
    }

    /**
     * Generate images.
     *
     */
    public function createPdfImage($page, $image_field, $pn) {

        $pdf_filepath = $page->document_pdf->first()->filename . '['.$pn.']';
        $jpg_filepath = str_replace('.pdf', '-'.$pn.'.jpg', $page->document_pdf->first()->filename);

        $resolution = 288; // Can't remember where I got 288 from - I think mostly trial and error many years ago, but seems to give best results

        $im = new imagick();
        $im->setOption("pdf:use-cropbox","true");
        $im->setColorspace(Imagick::COLORSPACE_RGB);
        $im->setResolution($resolution,$resolution);
        $im->readImage($pdf_filepath);

        $geometry=$im->getImageGeometry();

        $width = ceil($geometry['width'] / ($resolution/72));
        $height = ceil($geometry['height'] / ($resolution/72));

        $im->setImageFormat("jpg");

        /*if($width>150){
            $width = 150;
            $height = 0;
        }
        $im->scaleImage($width, $height);*/

        $im->writeImage($jpg_filepath);

        $page->of(false);
        $page->$image_field->add($jpg_filepath);
        $page->$image_field->last()->description = $page->title . ' Page ' . ($pn+1);
        $page->save();
    }

}

Share this post


Link to post
Share on other sites

Very cool Adrian! A few suggestions:

  • Make your version number 2 rather than 002. PHP might interpret that as Octal or something. 
  • Add an ___install() method that does a class_exists('imagick') and throws a WireException if it doesn't. 
  • Make the ___install() method add the document_pdf field, or make the module configurable so people can tell it what field to use. 
  • Put it on GitHub.
  • Add to the modules directory.
  • Profit! (as Adam would say)

Share this post


Link to post
Share on other sites

Thanks for all the great suggestions Ryan. I will definitely add those dependency checks and implement some config options, including the field, max image dimensions etc and make available on github / modules directory.

I didn't really have any time to work on this yesterday, but I took a quick look at using $page->isChanged("field") in an attempt to determine whether the user has uploaded a new version of the PDF during the current page editing session, so it knows to regenerate the images. It didn't seem to work as I expected. Looking at the docs and cheatsheet it seems like I don't need to turn on change tracking in this scenario, but maybe I not properly understanding how this works. This seems like it should be the most elegant way to check this.

The other thing I need to do is ensure Ghostscript is installed. I don't think there is a PHP way to do this without exec or system, so I am wondering what you think about having the module include a very small PDF file that the module install method can do a test readImage on. Would that be too hackish? I don't want to blemish PW :)

Share this post


Link to post
Share on other sites

This is still not really finished. It definitely works and has been tested on a couple of different sites for several months now, but I think it still needs some refining before being ready for prime time. 

It is now on GitHub: https://github.com/adrianbj/ProcessPDFImageCreator

Will wait for module directory submission until I get time to make some refinements though.

  • Like 2

Share this post


Link to post
Share on other sites

<ryan>

  • Make your version number 2 rather than 002. PHP might interpret that as Octal or something. 

</ryan>

Very good tip drove me mad a while ago !

  • Like 2

Share this post


Link to post
Share on other sites

Adrian

This should work for displaying the cover of a PDF in ListerPro?

I'm using ListerPro to list a virtual directory of PDFs. Essentially each PDF is a page with a Files field. I drop my PDF in there and then use ListerPro to display the following

post-1166-0-69540200-1433192390_thumb.pn

I'll try it tomorrow but thought I'd check first. Unfortunately, I already have my File and Images fields named so that may affect things?

Share this post


Link to post
Share on other sites

Hi Peter,

This was the first module I ever put together and I still haven't really finalized it - I have it working on a few sites, but it really needs some configuration options - what images field to use, what pages of the PDF to create images for, etc.

You might be better off with this module by Richard Jedlička: https://processwire.com/talk/topic/6426-pdf-fieldtypeinputfield/ although since it is a separate fieldtype you might have a little trouble migrating your content from your existing files field.

If that is an issue, perhaps just tweak the code in this module of mine to suit your needs, because it sounds like you don't want images for every page, just the cover.

Let me know if there is anything I can do to help.

Share this post


Link to post
Share on other sites

Just have to let at least my words here - the last months sadly i don't had much work with PW - but now i was in need of pdf thumbs....and there are two modules....first one doesn't work.

This one runs for me now on shared host, PHP 7.2 and PW 3.101 and i have to say thank you again to Adrian!

Even the small not polished modules from you work as a charm over years 😉

Best regards from a atm sparetime PW user.....(two daughters have taken over my time almost complete - best wishes to @Pete )

mr-fan

  • Like 3

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 tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • 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
×
×
  • Create New...