Jump to content
kongondo

Menu Builder

Recommended Posts

7 minutes ago, kongondo said:

Glad you like the module @cjx2240

Do you mean if disabled menu item does not show in the frontend? What's the use case? Why not just not add that menu item? 

 

I don't follow. Please explain.

Well, sometimes you just want to turn off a menu item, temporarily right? Like I have a client who wants to disable registrations in a few months. He can just delete it, but if he wants to put it back, then he has to get the right page and fill out (accurately) the css class again etc.

And change type I mean, if I make a "Pages" menu item, but later I want to change the URL, or maybe make it external... I have to delete and remake. This is fine for me, but maybe less intuitive for some people.

Basically, I am talking about things that you and I won't need, but an end-user of the CMS might ;)

Share this post


Link to post
Share on other sites

I see. The change type might not be easy to pull off but will have a think. The en/dis-able, please file that as a request here. Thanks.

Share this post


Link to post
Share on other sites

Hi kongondo, one question: the title of the page is always taken from the module? Because after creating the menu, I modified some page titles in pw by request of the client and the module continues printing the old title. Maybe I can use a var %s or something in the title input to tell the module that get it from the pw page.

Share this post


Link to post
Share on other sites
14 minutes ago, Pixrael said:

Hi kongondo, one question: the title of the page is always taken from the module? Because after creating the menu, I modified some page titles in pw by request of the client and the module continues printing the old title. Maybe I can use a var %s or something in the title input to tell the module that get it from the pw page.

Please see the 'default_title' option as documented here.

Share this post


Link to post
Share on other sites

Hi Kongondo,

I have been searching this support forum for an answer to my scenario for a while to no avail, and was hoping you could advise me on the following:

Scenario:

I have created a menu using MB with a structure similar to this:

Menu Builder items:

  1. Home
  2. Page 1
  3. Page 2
  4. Page 3
  5. Contact

My problem:
in the PW page tree ‘Page 1’ has 20-children. 

I don’t want to include the 20-children in MB.  However, I want ‘Page 1’ to maintain the <li class=“active”> if I navigate to any of its 20 children.

Question:
Is it possible to keep ‘Page 1’ <li class=“active”>, without the children of ‘Page 1’ being included and output into the MB HTML?

Share this post


Link to post
Share on other sites
On 4/19/2017 at 5:54 PM, CodeCoffeeCode said:

Hi Kongondo,

I have been searching this support forum for an answer to my scenario for a while to no avail, and was hoping you could advise me on the following:

Scenario:

I have created a menu using MB with a structure similar to this:

Menu Builder items:

  1. Home
  2. Page 1
  3. Page 2
  4. Page 3
  5. Contact

My problem:
in the PW page tree ‘Page 1’ has 20-children. 

I don’t want to include the 20-children in MB.  However, I want ‘Page 1’ to maintain the <li class=“active”> if I navigate to any of its 20 children.

Question:
Is it possible to keep ‘Page 1’ <li class=“active”>, without the children of ‘Page 1’ being included and output into the MB HTML?

I think you would need to work with the "custom render" solution as described here.

  • Like 1

Share this post


Link to post
Share on other sites

This is probably a basic question and I've failed to spot the answer in the docs, in which case, many apologies...

Using an example such as example-recursive-function3.php is there an easy/built-in way of outputting only a portion of a deep menu, from part-way into that menu?

I need a menu like:

- food
-- cheese
-- fruit
--- apples
--- grapes
- energy
-- solar
-- wind

so at times I can output all of its items. But at other times I need to render only from say `fruit` down, e.g.:

- fruit
-- apples
-- grapes

Thanks in advance for any pointers ^_^

Share this post


Link to post
Share on other sites
On 11/23/2016 at 11:11 PM, Michael van Laar said:

Anyone has a solution for multi-language menus with custom menu items?

For pages localisation works using the default_title option. But this is not possible with custom menu items. And since the items’ title field is not a multi-language field, I have no idea how to solve this. But I’m probably not the first one stumbling over this. ;-)

If not, I think I have an idea how to build a solution using nested repeater fields.

You already find a solution for this?

 

I came accros the same problem as i wanted to add custom anchor links.

 

Thanks!

Share this post


Link to post
Share on other sites
On 8.5.2017 at 4:50 AM, Missariella said:

You already find a solution for this?

 

I just used a Repeater field on a hidden “website config” page to create my own menu building tool with exactly the features I needed for that website, including using multi-language fields within the repeater.

Share this post


Link to post
Share on other sites

Update: Menu Builder Version 0.1.8.

Changelog

  1. Added support to disable menu items + related (required for this) permission 'menu-builder-disable-items'. Thanks @cjx2240
  2. Support not to show menu items (pages) not listable to current user. Needs option 'check_listable' => 1 in $options Array. Thanks @Peejay
  3. 'current_class' now also applies to Breadcrumbs as well. Thanks @Jonathan Lahijani

Note

Disabling a menu item cascades the status to all its descendants. In Build Menu view (backend), disabled items displayed with strike-through.

Currently available in dev branch only. Please test and let me know, thanks.

Screenshots

 

mb_disable_menu_items1.thumb.png.665fcf66cbcde728cfd709f9cb433b7b.pngmb_disable_menu_items2.thumb.png.e522c30cfe4cd46fdba6d6b83226a56d.png

Edited by kongondo
  • Like 3

Share this post


Link to post
Share on other sites

Hi @kongondo - I'm still getting an issue with HTML in the menu item titles, where quoted attributes (e.g., class names, such as those used FontAwesome icons etc) get garbled in the title's input field.

I did mention a very simple fix earlier in this topic, but it may have got overlooked.  Would it be possible to apply this fix to the module:

In the ProcessMenuBuilder.module file, on line #1158 (in the listMenu() menthod), surround the $title variable with the htmlentities() function:

// Change line #1158 from:
<input type="text" value="' . $title . '" name="item_title[' . $id . ']" class="menu_settings" id="item_title' . $id . '">

// To:
<input type="text" value="' . htmlentities($title) . '" name="item_title[' . $id . ']" class="menu_settings" id="item_title' . $id . '">

It immediately fixes the HTML display issues witin the input field.

Thanks.

Share this post


Link to post
Share on other sites
1 hour ago, LMD said:

I'm still getting an issue with HTML in the menu item titles, where quoted attributes (e.g., class names, such as those used FontAwesome icons etc) get garbled in the title's input field.

I did mention a very simple fix earlier in this topic, but it may have got overlooked.  Would it be possible to apply this fix to the module:

Hi @LMD. Sorry about that; forgot about it. Pushed a fix to the dev branch. Please check and let me know if it works for you. Thanks.

Share this post


Link to post
Share on other sites
On 2017-4-25 at 7:36 PM, alan said:

This is probably a basic question and I've failed to spot the answer in the docs, in which case, many apologies...

Using an example such as example-recursive-function3.php is there an easy/built-in way of outputting only a portion of a deep menu, from part-way into that menu?

I need a menu like:


- food
-- cheese
-- fruit
--- apples
--- grapes
- energy
-- solar
-- wind

so at times I can output all of its items. But at other times I need to render only from say `fruit` down, e.g.:


- fruit
-- apples
-- grapes

Thanks in advance for any pointers ^_^

Hi @alan,

Hope it's not too late to reply. Sorry I missed this!

It is possible but the how would depend on the condition you want to check for to decide whether to output the whole menu or just part of it. There are at least two solutions:

  1. Using their IDs, remove unwanted menu items from the array or object returned by getMenuItems(). This would probably cost a bit more in memory, but probably nothing to write home about
  2. Modify the menu function in the gist you've linked to, to filter out IDs of unwanted items. It should suffice with creating an array of unwanted parent IDs. The, in the recursive function, check, for example if(in_array($m->parentID, $arrayOfParentIDs)) continue;. This is pseudo/incomplete code. You would also need to account for menu items without parents, etc.

If you gave us more info (condition to check for), I can give you a more clear answer.

  • Like 1

Share this post


Link to post
Share on other sites
On 2017-4-19 at 11:54 PM, CodeCoffeeCode said:

Hi Kongondo,

I have been searching this support forum for an answer to my scenario for a while to no avail, and was hoping you could advise me on the following:

Scenario:

I have created a menu using MB with a structure similar to this:

Menu Builder items:

  1. Home
  2. Page 1
  3. Page 2
  4. Page 3
  5. Contact

My problem:
in the PW page tree ‘Page 1’ has 20-children. 

I don’t want to include the 20-children in MB.  However, I want ‘Page 1’ to maintain the <li class=“active”> if I navigate to any of its 20 children.

Question:
Is it possible to keep ‘Page 1’ <li class=“active”>, without the children of ‘Page 1’ being included and output into the MB HTML?

Sorry for late reply @CodeCoffeeCode,

In addition to the suggestion to use the custom menu render strategy as suggested by @elabx, I think the options: include_children and current_class_level should also cover what you need.

https://github.com/kongondo/MenuBuilder/tree/dev#options

Please let me know if this solves your issue.

Share this post


Link to post
Share on other sites
On 2017-2-6 at 3:11 PM, Sahil said:

I have few children pages under a parent page.  i want to show that children page under two parents page in Main menu as well as in breadcrumbs.

With the help of menu builder main menu show same childern page under both the parents, but Breadcrumbs follow the page tree structure.

how can i get the expected result?

Hi @Sahil,

Sorry I never resolved this. It's difficult to give an answer without getting more information about your pages tree structure.

Share this post


Link to post
Share on other sites
On 2017-3-23 at 3:43 PM, cjx2240 said:

Maybe a way to change a menu from one type to another?

I think it should be easy enough to just create a new menu item, no? I see no easy way of automating this so will have to let the idea go.

Share this post


Link to post
Share on other sites
3 hours ago, kongondo said:

Pushed a fix to the dev branch. Please check and let me know if it works for you. Thanks.

Thanks, @kongondo - the fix works perfectly.

Share this post


Link to post
Share on other sites

Thanks @kongondo for that :)

The project has gone to sleep for a bit but I am hoping it will wake up soon and as soon as it does I will use your suggestions (thank you) and/or provide more info here. Cheers! -Alan ^_^

Share this post


Link to post
Share on other sites

Update: Menu Builder Version 0.1.9.

Changelog

  1. Added support for multi-lingual menu items (both PW pages and custom ones)! Thanks @Michael van Laar for 'reminder'.

Note

  • Multilingual feature only applies to multi-lingual sites.
  • You have to choose the languages you want for your menu items (in menu settings).
  • Multi-lingual feature only applies to menu items. This means menu titles themselves remain as normal.
  • The feature only applies to menu item title and URL
  • If other language's item title or URL are left empty, in the frontend, these fallback to default language's title or URL respectively. This means, for other languages, you can have, for example, a German menu title but leave the German URL blank. In that case, assuming the default language is English, the German menu item will get the English URL.

Currently available in dev branch only. Please test and let me know, thanks.

Screenshots

Backend

mb_backend_ml_version_19.thumb.gif.1115b82437543f4a325b0c9bc12e8818.gif

Frontend

mb_frontend_ml_version_19.thumb.gif.45454215ab02f37ae0479c26a1e2790c.gif

Edited by kongondo
  • Like 5

Share this post


Link to post
Share on other sites

Hi kongondo,

I've bumped into this issue again, and still cannot see how to resolve it without rendering the menu through custom code. I need to have parents displayed (simple nav menu) without their children, but need to assign current_class to the parent when one of its children is currently open. This is for the newsroom part of the site I'm working with. I'm on the dev branch of MB.

Is there no way to include an option like check_current_children on a local/global level so that it applies the current class even if the children are not listed? Or is there another really simple way of doing it?

Thanks a ton!

Share this post


Link to post
Share on other sites
On 16/08/2017 at 4:15 PM, Mike Rockett said:

Is there no way to include an option like check_current_children on a local/global level so that it applies the current class even if the children are not listed? Or is there another really simple way of doing it?

Sorry for late response. I have managed to get this working via a new option. Currently testing to check it doesn't break anything. Hopefully will commit later this week.

  • Like 1

Share this post


Link to post
Share on other sites
2 minutes ago, kongondo said:

Sorry for late response. I have managed to get this working via a new option. Currently testing to check it doesn't break anything. Hopefully will commit later this week.

No problem at all -- I'm sure you're quite a busy-bee.

Thank you, looking forward to testing it.

Share this post


Link to post
Share on other sites

Update: Menu Builder Version 0.2.0.

Changelog

  1. Modified 'current_class_level' option to apply 'current_class' to a menu item when viewing any of its descendant child pages (child, grandchild, etc.) in cases where those descendant pages are neither part of the menu nor included via 'include_children'. To enable this, set 'current_class_level' to '0'. Thanks @Mike Rockett for reviving this.

Note

  • I have tested this thoroughly but sometimes in Multilingual sites, depending on some conditions I am yet to pin down, the setting does not work properly. In such cases, using 'current_class_level' >= what you need does the trick.

Please test and let me know. In dev branch for now.

  • Like 2

Share this post


Link to post
Share on other sites
11 hours ago, kongondo said:

Update: Menu Builder Version 0.2.0.

Changelog

  1. Modified 'current_class_level' option to apply 'current_class' to a menu item when viewing any of its descendant child pages (child, grandchild, etc.) in cases where those descendant pages are neither part of the menu nor included via 'include_children'. To enable this, set 'current_class_level' to '0'. Thanks @Mike Rockett for reviving this.

Note

  • I have tested this thoroughly but sometimes in Multilingual sites, depending on some conditions I am yet to pin down, the setting does not work properly. In such cases, using 'current_class_level' >= what you need does the trick.

Please test and let me know. In dev branch for now.

Thank you! It does appear to work, but the root page is also assigned the current class when viewing any decsendant.

This is my code:

$view->siteNavigation = $menuBuilder->render('site-navigation', [
    'current_class' => 'here',
    'menu_css_class' => 'menu-items',
    'default_class' => 'menu-item',
    'current_class_level' => 0,
]);

And this is the output:

<ul class="menu-items">
	<li class="menu-item here">
		<a href='/'>Home</a>
	</li>
	<li class="menu-item">
		<a href='/about'>About</a>
	</li>
	<li class="menu-item">
		<a href='/security'>Security</a>
	</li>
	<li class="menu-item">
		<a href='/recycling-initiatives'>Recycling</a>
	</li>
	<li class="menu-item here">
		<a href='/newsroom/'>Newsroom</a>
	</li>
	<li class="menu-item">
		<a href='/contact-us'>Contact Us</a>
	</li>
</ul>

Is there no clean way to add an option to specific menu items that states "add current class here if an included / non-included descendant is current"?

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