Jump to content
tpr

Module: Template Latte Replace

Recommended Posts

v029 is available:

  • change in adding custom macros and filters: $view->addMacro(), $view->addFilter()
  • added $view->invokeFilter($name, $args) method to run filters directly in PHP
  • updated filters to accept PageArrays instead selectors only
  • new filter: 'renderpager'
  • new filter: 'getsetting' (to use with TextformatterMultivalue module)
  • $view->latte returns the Latte object
  • lowercase filter names

See the docs for "renderpager" filter, otherwise these changes won't affect you if you're not using your own custom filters/macros. Another goodie is the ability to run a filter directly in your PHP files (ready.php or template files).

  • Like 1

Share this post


Link to post
Share on other sites

Hey @tpr,

Thanks for your effort with this module! I haven't use this module and still stuck with the old way of setting up the latte template engine. Hopefully I got a chance to use your module moving forward.

Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Thanks! The old method is better to forget, the module is the way to go. The latest filters and latte-only template files make templating even more enjoyable. Recently I updated an earlier site of mine and I could throw off about half of the template files and the code is also much cleaner/maintainable.

  • Like 2

Share this post


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

Thanks! The old method is better to forget, the module is the way to go. The latest filters and latte-only template files make templating even more enjoyable. Recently I updated an earlier site of mine and I could throw off about half of the template files and the code is also much cleaner/maintainable.

 

On my current project I decided to keep the .php extension but on the next one I'll enjoy this new approach for sure. Many thanks, @tpr !

Share this post


Link to post
Share on other sites

I like this approach because of less number of template files. Sometimes I end up with 10+ templates and it gets duplicated because of the view files. Keep in mind that you should use ready.php (or another one) to act as a controller if you still need to separate concerns. There you can use conditionals to target the current template or even include another php files if needed - I often include files eg. in case of the search template to keep ready.php less crowded.

Share this post


Link to post
Share on other sites

Just added a new filter 'default' (v031) - this seems to be a nice shortcut for simple if-else conditions.

<div>
    {$page->product_description|default:'No description is available for this product.'}
</div>

I guess the core PW API could also use something like this:

$page->get('product_description', 'No description is available for this product.')

What do you think?

Share this post


Link to post
Share on other sites
7 minutes ago, tpr said:

I guess the core PW API could also use something like this:


$page->get('product_description', 'No description is available for this product.')

What do you think?

There is this:

<div>
    <?= $page->product_description ?: 'No description is available for this product.' ?>
</div>

 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, good suggestion, I haven't thought about this. Although for newbies it can be harder to understand.

It works in Latte too but I'll keep the 'default' filter as it's easier to use, especially when chaining filters:

{($page->title|replace:'Home','') ?: 'No content available.'}
{$page->title|replace:'Home',''|default:'No content available.'}

 

Share this post


Link to post
Share on other sites

v033 is available that contains two new filters, lazy and surround.

I like the succinctness of the surround filter, eg in case of a tag list:

{$p->tags->sort('name')->title()|surround:'li'|surround:'ul class="tags"'|noescape}
<ul class="tags">
	<li>one</li>
	<li>two</li>
	<li>three</li>
</ul>

The docs were moved to GitHub Wiki, the increasing number of filters required this.

  • Like 2

Share this post


Link to post
Share on other sites

Another filter added in v036: embediframe. Unlike other responsive embed setups this one uses two wrappers to allow setting custom width so the iframe won't necessarily fill the available horizontal space.

There's also a protectemail filter available and the bodyclass filter was updated to include paginated pages too.

  • Like 1

Share this post


Link to post
Share on other sites

Hi @tpr,

Have a question here (more like a Latte question rather than module question): I have my default base layout called @layout.latte which is a base template for almost all of my pages but I also want to have another layout template that does have a sidebar. How do I setup this up in such a way I only declare my base HTML file once? Using {extends} or {layout} directive seems to replace the whole template file? or am I missing something here?

Share this post


Link to post
Share on other sites

@peterfoeng - I'm not sure about Latte (tpr might be able to answer this better), but surely you can have one layout extend another? So you would have a base layout and a sidebar layout where the sidebar layout extends the base layout, which would import the content of the sidebar layout if it's provided. Blade provides a nice way of doing this by using a combination of @section() and @parent.

 

Share this post


Link to post
Share on other sites
10 minutes ago, Mike Rockett said:

@peterfoeng - I'm not sure about Latte (tpr might be able to answer this better), but surely you can have one layout extend another? So you would have a base layout and a sidebar layout where the sidebar layout extends the base layout, which would import the content of the sidebar layout if it's provided. Blade provides a nice way of doing this by using a combination of @section() and @parent.

 

My previous setup is not using this module and seems to be working ok (I am pretty sure I am just missing something here)

This is my previous setup:
I have `@base.latte` file which contains the default markup then on my `Contact Page` (where I want this page have to have a sidebar) I have the following markup:

`Contact.latte` file:

{extends '@layout.sidebar.latte'}

{block side_navigation}
  {include $config->paths->templates . 'views/components/_globals/side-navigation/contact.latte'}
{/block}

{block content}
....My content
{/block}

 

`@layout.sidebar.latte`file:

{extends '@base.latte'}

{block body}
  {var $fixed = in_array($page->template, array("Contact", "Size-Guide", "Product-Information"))}

  <main class="component component--main-content" id="content">
    <div class="component__wrapper">

      <div class="main-content">
        <div class="main-content__wrapper">
          <div class="main-content__col main-content__col--sidebar {if $fixed}main-content__col--sidebar-fixed{/if}">
            {block side_navigation}{/block}
          </div>
          <div class="main-content__col main-content__col--body">
            {include content}
          </div>
        </div>
      </div>

    </div>
  </main>
{/block}

This works with my previous setup. Hopefully @tpr can help a bit with his knowledge of this templating engine :)

Cheers

Share this post


Link to post
Share on other sites

What is the error you got? Layout inheritance is available in latte too.

btw you don't need separate layout for a sidebar, just add an empty block to the base layout and fill with markup when you need it.

Plus you don't need to pass the full path for includes, use relative paths, eg include 'components/...latte'.

Share this post


Link to post
Share on other sites

This is how I use multiple layouts in a project.

@default.latte:

...
<body>
{include content}
</body>
...

@sidebar-left.latte:

{layout '@default.latte'}

{block content}
    <div>
        <div class="main">
            {include main}
        </div>
        <div class="sidebar-left">
            {include sidebar_left}
        </div>
    </div>
{/block}

contact.latte:

{layout 'layouts/@sidebar-left.latte'}

{block sidebar_left}
    ...
{/block}

{block main}
    ...
{/block}

Maybe there's a better setup for this, please share if you find one :)

Share this post


Link to post
Share on other sites
12 hours ago, tpr said:

This is how I use multiple layouts in a project.

@default.latte:


...
<body>
{include content}
</body>
...

@sidebar-left.latte:


{layout '@default.latte'}

{block content}
    <div>
        <div class="main">
            {include main}
        </div>
        <div class="sidebar-left">
            {include sidebar_left}
        </div>
    </div>
{/block}

contact.latte:


{layout 'layouts/@sidebar-left.latte'}

{block sidebar_left}
    ...
{/block}

{block main}
    ...
{/block}

Maybe there's a better setup for this, please share if you find one :)

You're the man!!! benggg....problem solved

  • Like 1

Share this post


Link to post
Share on other sites

Hey @tpr,

How do you setup a page that returns just json response without the base layout template markup? I know we can set $view->json_encode = true but the template markup is also encoded, how do we avoid this?

Thanks for your help in advanced!

Share this post


Link to post
Share on other sites

Just create an empty layout, eg. @empty.latte:

{include content}

and of course tell the view file to use this layout:

{layout '../layouts/@empty.latte'}
{block content}
    ...
{/block}

 

Share this post


Link to post
Share on other sites

Two new macros in v038: minify and editlink.

Minify is an easy way to remove unnecessary whitespace and optionally to try some additional tweaks too. It's nowhere to ProCache or AIOM but can help reducing markup size. I could tweak things on one site to achieve 100% HTML minification according to gtmetrix but that required extra work on the markup so this macro alone won't help you on this :) 

As a bonus the macro can be used to remove whitespace between list items (<li>'s) which sometimes can cause headaches.

Editlink is another helper that can substitute bigger modules like FEEL, Fredi or the built-in frontend editor. There's nothing special in it, just outputs edit links to edit the page in the admin. First I was about to modify FEEL but I realized this would be more fun :) 

  • Like 2

Share this post


Link to post
Share on other sites

I've modified the editlink macro in v039, now you can easily add any attributes and additional url parameters to the edit link. This way it's easy to add edit links that open the admin in a lightbox. I've added a few lines about it to the docs along with a style example.

  • Like 3

Share this post


Link to post
Share on other sites

v041 contains two new filters: getlines and imageattrs.

The first is a simple replacement to my MultiValueTextformatter module. Unlike the module it can only return a simple or an associative array but in fact that's just enough most of the time.

The imageattrs filter is an easy way of adding image width-height-alt attributes. "alt" value is taken from image description or set empty if not provided, or optionally can be removed entirely.

  • Like 1

Share this post


Link to post
Share on other sites

Just popped in to praise the getlines filter's coolness :) I have a CKEditor field containing a simple unordered list. I wanted to animate each lines separately but it wasn't possible because the whole UL was rendered together so I couldn't add the required classes to each LI's.

Using getlines together with striptags filter it's now possible ($iterator is built-in):

<ul n:inner-foreach="($p->body|striptags|getlines) as $key => $value">
  <li data-animate data-animation-classes="animated fadeInLeft" data-animation-delay="{$iterator->counter * 300 + 200}">
    <h3>{$key}</h3> {$value}
  </li>
</ul>

Of course I could add the required attributes in CKEditor but that would require more troubles (modifying CKEditor field to allow attributes, hardcoded delay values, etc).

  • Like 3

Share this post


Link to post
Share on other sites

There was an undocumented "list" filter among the filters that is now "officially" published. It was similar to the built-in implode filter but didn't choke if you passed a string instead of an array to it. I suggested this improvement in the Nette forums but they weren't too enthusiastic. In PW there are times (at least I had) when you don't know for sure if a data is a string or an array so I added this check to avoid errors.

The filter removes empty values so no need to check data existence manually. You can specify a separator string and/or a HTML tag, so it's easy to build eg. an unordered list. Just apply it to an array of possible items and the filter will take care of the rest. Here is an example.

  • Like 1

Share this post


Link to post
Share on other sites

Just upgraded the module to v0.4.3. There's a new option to disable the "noescape" filter, and a workaround for translations on a non-multilanguage site.

The latter is a simple solution for a situation when you copy over a latte file from another project full with translations but the current project is single-language only. This is perhaps not an issue if you're using full strings for translation keys, e.g "_t('Read more')" instead "_t('read_more_text')" because the original key is returned. But even so you may start a non-English project and there you'll be in trouble :) I was there several times and ended up rewriting strings/translations all over the project, now they can remain in place and I have to add translations at one file (which you can copy over).

  • Like 1

Share this post


Link to post
Share on other sites

Just added a new 'getembedurl', 'append' and 'prepend' filters to v4.4.

With getembedurl you can retrieve the embed url to be used when embedding videos (currently for Youtube/Vimeo). Editors aren't really capable of copying the embed url so you can use this filter to allow them adding the url of the video to the admin.

Filters append and prepend are convenience filters that you can use to quickly append/remove data. Data can be primitive or arrays. These filters are particularly useful when chaining filters so you don't have to split the current line just to modify the original data.

The bodyclass filter now contains the name of the viewFile (if exists), prefixed with "v-", and directory separators converted to "-". Custom classes can be added using $page->body_class if needed.

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...