Jump to content
Wanze

Pages2Pdf

Recommended Posts

Hi,

I'm working on the pdf layout and do not get it managed to have several images of PW pages in line on one pdf page.

I have only pages with images so the pdf file includes the images of the selected pages of the session, but they are all listed among each other.

EDIT:

It was a stupid question from me ...

-> table layout and a simple php for loop does the job.

:-[

Share this post


Link to post
Share on other sites

Great work Wanze, thanks for this module!!

Everything works fine after figuring out what works in pdf files and what not^^

One thing I noticed, is that the "page orientation" in the module settings is getting saved but the value in the field switchs back to P so I have to reset this everytime when I change some values.

Cheers Can

Thanks Can, glad it works for you :)

I'm currently rewriting the module and will switch the pdf engine behind to mpdf which seems to have much better support for html.

@Bacelo

There are no stupid questions  ^_^

  • Like 4

Share this post


Link to post
Share on other sites

Great to hear Wanze. I'll await this with joy  :)

Do you already have a possible release date?  :-[

Cheers

hmm..it's working quite okay as I said, but seems to only work for pages under a specific parent

got one other page where I want to prove PDF version..it uses the same template and I'm not checking for this parent or something so there shouldn't be any exclusion

the PDF is getting created but only with header and footer without content..hmm :/

strange..I'm just posting this because maybe someone else could need the hint

solved pdf not working for certain page by duplicating the page via core page clone module and voila it's working without any other changes or creating the page from scratch again :)

Edited by Can

Share this post


Link to post
Share on other sites

Thanks Can, glad it works for you :)

I'm currently rewriting the module and will switch the pdf engine behind to mpdf which seems to have much better support for html.

Would be great to have the option to specify a page. So generate the pdf link for given page instead of the current page?

So it gets more flexible :)

  • Like 2

Share this post


Link to post
Share on other sites

Would be great to have the option to specify a page. So generate the pdf link for given page instead of the current page?

So it gets more flexible :)

You can do this directly in your template pwFoo.

I have this in the template I want to generate the PDF from

if($sanitizer->text($input->get->pdf) === '1') $modules->get('Pages2Pdf')->render();

And in the template where I´m linking to the page I just add ?pdf=1 at the end of the link.

like <a href="{$chlid->url}?pdf=1">PDF Version</a>

You probably need to create a PDF template in /site/templates/pages2pdf folder

That's it.

Share this post


Link to post
Share on other sites

Thanks Can, I'll try it again that way. Maybe it would work the second time. First time it loads the page instead to generate and download a pdf.

Would be great to set a page/ id and get a pdf download link without load the page itself.

  • Like 1

Share this post


Link to post
Share on other sites

yeah pdf generation seems to be kind of 1980. it probably get's better after wanze's update

do you created a page specific template under /templates/pages2pdf/ ?
it was important for me and and hat to tweak a lot

I'm outputting only via heredoc to keep all "double quotes" instead of 'single quotes' (you could escape them of course)

  • Like 1

Share this post


Link to post
Share on other sites

Yes, I'll build a simple pdf template which works fine so long linked and used at current page.

But don't get it work as a download link from another page.

But for now your way would be fine to get it work. After the module update maybe it's easier to do ;)

  • Like 1

Share this post


Link to post
Share on other sites
@Bacelo

There are no stupid questions  ^_^

O0  Thank you Wanze

Hi,

I'm working on the pdf layout and do not get it managed to have several images of PW pages in line on one pdf page.

I have only pages with images so the pdf file includes the images of the selected pages of the session, but they are all listed among each other.

EDIT:

It was a stupid question from me ...

-> table layout and a simple php for loop does the job.

:-[

I'm still optimizing the layout of the generated pdf file.

I got it managed to have one table for each 5 pages (pictures).

I tried everything with the table width, but I can't get it done to have the tables / cells  always fit to their content (pictures only) with no space left in the cells.

The tables always seams to have the full page width. I have no width set for any table attribute so actually it should be fine.

Any clue? :wacko:

Share this post


Link to post
Share on other sites

Hello and thank you for this module!

I'm planning to use it on a client's side, but with some extended features:

Users can add pages to some type of "shopping cart". All pages in the cart are then merged into a pdf that is offered for download.

I am not talking about a webshop here, just the cart functionality.

There is an extension for Joomla that does exactly that: http://netamity.com/extensions/contented-pdf

I'm currently researching possibilities to build this with PW as I'm switching more and more over to PW from Joomla. So it would be great if you could give me any pointers on how to achieve the pdf cart thing in PW.

Another idea is to create the PDFs for every page on save from admin. Then have the cart functionality which collects the already created pages and merges them into one downloadable pdf file. This would be less workload for the server (only merging existing files, no creation on the fly).

Can we hook into your module from the admin on creating/saving a page?

Cheers

Gerhard

Share this post


Link to post
Share on other sites

Should be possible to have it like a search, kind off.

You store selected pages via page field in the cart and then in the pdf template you iterate through them and output as pdf

just ask if you need more help

Share this post


Link to post
Share on other sites

Thanks Can for your ideas.

After browsing through available modules, I think I'm going to use a modified version of Apeisa's cart module https://github.com/apeisa/Shop-for-ProcessWire/blob/master/ShoppingCart.module to add pages to a cart.

Do you have any idea how to hook into the pages2pdf module on save/update of pages in the admin? I found this post https://processwire.com/talk/topic/2331-doing-additional-logic-after-saving-a-new-page/

Not sure though if that goes in the right direction and how to hook into pdf creation from there.

Cheers

Gerhard

  • Like 1

Share this post


Link to post
Share on other sites

Think you could make your own little "cart"

just a littly form with a hidden field for storing the page->id or if this form is on the same page you want to add to the cart you don't even need the hidden field.

 
if($input->post->addtocart && !$cart) {
  $cart = new Page();
    $cart->parent = $pages->get(5771);
    $cart->template = 'cart';
    $cart->title  = 'session_id()'; //for example
    $cart->save();
    $cart->of(false);
    $cart->items = $pages->id; //not a hundred percent sure right now but should work (think I've done it like this already)
  }
}

items field would be multi page fieldtype 

you would then include this "$modules->get('Pages2Pdf')->render();" into the page template you want to generate the pdf's from

on the cart page you add a link for the customer, think it should work when you just link to one of the pages and append ?pdf=1 to the url, which will then create the pdf

create a new template under /templates/pages2pdf/ with the same name as the template you put the "$modules->get('Pages2Pdf')->render();" in

in this template you iterate through the pages in the cart like you would on a blog page or similar and output everything you need

for me the final output worked only with heredoc syntax, seems that proper double quotes are needed by tcpdf (you could echo as "normal" but then you would need to escape the double quotes)

hoffe es ist einigermaßen verständlich und klappt (hope it's understandable and works)

  • Like 3

Share this post


Link to post
Share on other sites

Hello Can,

thanks a lot for your input. I will give this a shot and let you know how it works out.

Vielen Dank!

Gerhard

  • Like 1

Share this post


Link to post
Share on other sites

may have found a bug: the module settings doesnt seem to allow L instead of P for the orientation, I ended up changing the module defaults to do it - all other fields seem to validate fine.

  • Like 1

Share this post


Link to post
Share on other sites

@benbyf

it worked for me, but I had to change the field in the settings everytime I changed any setting.

once set it works.

By the way I just changed to mpdf without any module and it's working really great

really easy to set up

file caching is the only thing missing at the moment.

but that shouldn't be too hard, maybe I'll can dig into pages2pdf and "copy" this part or something

  • Like 1

Share this post


Link to post
Share on other sites

@Can - could you possibly share how you setup mpdf with PW? maybe on a tutorial thread?

cheers!

  • Like 3

Share this post


Link to post
Share on other sites

@benbyf

nice website you have there. I particularly like the way you present your works. Elegant animation on the buttons and the filter effect is way cool.

  • Like 2

Share this post


Link to post
Share on other sites

@Can - many thanks, looking forward to studying your post!

Share this post


Link to post
Share on other sites

Hi folks,

I have refactored the module and a new version is available on the dev branch here: 

https://github.com/wanze/Pages2Pdf/tree/dev

The module now uses mpdf in the background which has superior HTML/CSS support compared to TCPDF, but the library is slightly heavier.

What's new?

  • Creating PDFs is handled by a separate module "WirePDF". This module is just a wrapper around mpdf and you could also use it independently from Pages2Pdf as a Service to create/save/download PDF files from ProcessWire templates
  • All the configuration options related to configure mpdf (margins, document orientation...) are now defined in the module WirePDF
  • Some new config options in module pages2pdf. You can configure the PDF filename and the GET variable that is used when requesting a download
  • You can download a PDF from any page
  • The default templates have changed, with mpdf you now can use a separate stylesheet to separate CSS from HTML markup
  • Triggering the creation/download of a PDF file is handled earlier: After the ProcessWire API is ready but before page rendering is initialized. This should improve the performance.
  • Calling the render() method is technically no longer required, but it can still be used to output the download link. However, you could write the link by yourself if you prefer.

If you'd like to test out the new version and upgrade the module:

  • Please note down all the current settings
  • Uninstall pages2pdf module, then replace it with the current one
  • Install the new version
  • Maybe add your previous settings in the WirePDF module. Some settings are no longer supported or have changed slightly
  • If you created manual links to triggering the download in your templates, e.g. added ?pdf=1, you should change the GET variable in the module configs from 'pages2pdf' to 'pdf'
  • Take a look at the default_templates in /site/modules/Pages2Pdf. With mpdf, it's better to separate CSS from HTML, so you can create a "styles.css" in /site/modules/templates/pages2pdf/ and define all CSS styles there. The styles are then availalble in your templates.

I hope that's the most important stuff. I'm short in time today (going to a festival), so I can't support :)

Cheers

  • Like 12

Share this post


Link to post
Share on other sites

hello wanze. Thanks for the update. I have tested it, but now it does not render the images, I have this is my template:

if (count($page->images)) {
$someImages = $page->images->slice(0, 4);
foreach ($someImages as $someImg) {
	$someImgThumb = $someImg->size(290, 195);
	echo "<TD WIDTH='25%'><img src=\"{$someImgThumb->url}\" width=\"{$someImgThumb->width}\" height=\"{$someImgThumb->height}\" /></TD>";
}
}

I followed your instructions, is there some other way to render the images?

Also in the previous version, I couldn't create/view the pdf as a guest, only if I was logged in as a superuser or as an editor.  Is there some setting that I should change to create/view the pdf as a guest?

Thanks!

update: the new updated module was not generating the images in MAMP is working fine on a live host.
I can now also view the pdfs as a guest on the live host, in the previous version, even after saving the page as a superuser, after login off I could not view the pdfs in the live host. It seems to be working very well now. Thanks again waze for this great module.

  • Like 1

Share this post


Link to post
Share on other sites

@nfil: just a quick thought: you may try to use the file:/// protocol (with three slashes), e.g.

echo "<TD WIDTH='25%'><img src=\"file:///{$someImgThumb->filename}\" width=\"{$someImgThumb->width}\" height=\"{$someImgThumb->height}\" /></TD>";

Haven't tested and don't know if it can work with mpdf, - just a quick thought. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hello and thank you for this module!

I'm planning to use it on a client's side, but with some extended features:

Users can add pages to some type of "shopping cart". All pages in the cart are then merged into a pdf that is offered for download.

I am not talking about a webshop here, just the cart functionality.

There is an extension for Joomla that does exactly that: http://netamity.com/extensions/contented-pdf

I'm currently researching possibilities to build this with PW as I'm switching more and more over to PW from Joomla. So it would be great if you could give me any pointers on how to achieve the pdf cart thing in PW.

Another idea is to create the PDFs for every page on save from admin. Then have the cart functionality which collects the already created pages and merges them into one downloadable pdf file. This would be less workload for the server (only merging existing files, no creation on the fly).

Can we hook into your module from the admin on creating/saving a page?

Cheers

Gerhard

Hi Gerhard,

If you grab the latest version of the module (1.1.0 is now in the master) you have several possibilites to solve this.

1) Use pages2pdf module:

Do you already have a template that shows/lists the pages inside the shopping cart for a user? If so, you could create a corresponding template in /site/templates/pages2pdf/ and list the products there too. This way, the module does most of the work for you, including caching of the PDF files.

What you'd need here is to delete the cached PDF file if the user adds or removes a page in the shopping cart.

Simplest way of doing this is to trigger saving the shopping cart page, then the module will delete the cached PDF file.

2) Use WirePDF module:

WirePDF is just wrapper around mPDF that is optimized to work with ProcessWire. If you want to create the PDF files independently from Pages2Pdf module,

you may want to check out those examples: https://github.com/wanze/Pages2Pdf#wirepdf

  • Like 2

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By ukyo
      FieldtypeFontIconPicker
      v.0.1.6
      Fix FieldtypeFontIconPicker sanitizeValue() v.0.1.5
      Added uikit icon select support (required AdminThemeUikit), because uikit icons not working standalone. v.0.1.4 :
      Fix issue FontIconPicker inside repeater v.0.1.3 :
      FontAwesome updated to 4.7.0 v.0.1.2 :
      Little Corrections Some works about icon pickers inside repeater via ajax load v.0.1.1 :
      FontAwesome updated to 4.6.3 v.0.1.0 :
      Custom CSS file url support Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.9 inside dev branch
      Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.8
      FontAwesome 4.5 update, Improvements and Performance updates Important ! After update module check your input settings, because i changed input attribute names (This will only effect input options, like theme, category). Changed loading icon method from input:hidden to select>optgroup>option, added module js file for load and correct icon picker container many changes…. v.0.0.7
      FontAwesome updated to 4.4.0 v.0.0.6
      Missed... array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.5
      Fix for oldest pw versions (Assets file loding scripts moved to inputfieldfonticonpicker module) v.0.0.4
      Array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.3
      Small z-index problem solved v.0.0.2
      MarkupFontIconPicker added v.0.0.1
      Start Point FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.0 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Example :
      if($my-icon-field) echo "<i class='my-prefix-{$my-icon-field}' />"; Hook Before Render Example This example using /site/templates/admin.php file for hook
      wire()->addHook('InputfieldFontIconPicker::beforeRender', function($event) { if(!$event->return) return; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) $inputName = ""; if(isset($event->object->attributes['name'])) $inputName = $event->object->attributes['name']; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) if($inputName == 'icon_picker') { /** * Load your custom icons function file * Your array need to be same format with Icons/FontAwesome.php or Icons/Ionicons.php * Also you can pass directly an array */ wireIncludeFile('MyCustomIconFile'); // Set icons as $icons variable $icons = MyCustomIconsArray(); // Set your options $return = array( 'attributes' => array( 'category' => '', 'theme' => 'fip-grey', 'empty-icon' => 1, 'empty-icon-value' => '', 'icons-per-page' => 20, 'has-search' => 1 ), 'icons' => $icons ); // Return the event $event->return = $return; } $event->return; }); MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Screenshots - InputfieldFontIconPicker input settings



      Screenshots - InputfieldFontIconPicker page edit views


       
      Github Repo
    • By Xonox
      After some years with a website working perfectly, Page Clone started to display some strange behaviour:
      1. When cloning some pages, it takes forever. The waiting icon is displayed but the page never appears. Only after I refresh the tree page, the new page appears:

      2. The other thing is that some pages can't be copied. The pages have the same templates but the users are able to copy some and other don't. It gives this error:

      (the URL is .../page/clone/?id=76376&login=1)
      Does someone have a clue why this is happening. I can't find any real difference between the pages that I'm trying to copy.
      One more thing: If the user is a super user, he's able to copy every page without problems.
      I think both errors might be related. Thanks!
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • 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.4.2
      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
       
       
×
×
  • Create New...