Jump to content
kongondo

Menu Builder

Recommended Posts

On 3/24/2020 at 4:03 PM, maddmac said:

Just a question that might be answered in a previous post. If I want to apply a class to the <a> tag how would I do this using the module options?

See the two posts above yours 😀. Currently, this is not possible if using the render() method but I have added it to my todo list.

  • Like 2

Share this post


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

Actually, this is not true 😀.

I don't know what version you are using but there has always been a save as unpublished or published during menu creation and an unpublish/publish action that can be applied to existing menu items in the menus list/table. See the big green shiny buttons 😁.

Am I missing something?

You're right, It just wasn't obvious at the time, now that I create another menu it's fine, i must have been smoking something.. 🚬🍀

Thanks for this great module!!

Share this post


Link to post
Share on other sites

Hey,

I searched the forum, but I couldn't find any post with a topic of the problem that I am facing with the module. 

I setup multilingual menues nd have different roles which have the menu-builder permission. As soon as Editors save a Menu, the custom title translations of the menu are gone. Menu Item titles of the default language are editable as a non-admin user, but all other language titles are ignored / deleted on save.

Are only admin users allowed to edit title translations?

Thanks for a short hint on that.

Share this post


Link to post
Share on other sites

Hi,

I am using Menu builder on a new multi-language web site. It's a simple use case : only on level on the main menu.
It'is working fine. Thanks again for the module.
However I have one issue. the class for the current item is not rendered in the html.

My code is like this

$menu = $modules->get('MarkupMenuBuilder');
$options = array(
                                            'current_class' => 'active',
                                                                         );

echo $menu->render('MainMenu', $options);

One point though : each menu item is a "custom item" with a url to the page and url segments (2 or 3) and all the menu item points to the same page (with different url segment).

Do you think this is the reason why the current class is not present in the html ? If so is there any workaround ?

Thanks a lot

Share this post


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

It'is working fine. Thanks again for the module.

Glad you find the module useful.

1 hour ago, antpre said:

One point though : each menu item is a "custom item" with a url to the page and url segments (2 or 3) and all the menu item points to the same page (with different url segment).

I am not sure I understand this statement. By, "custom item", do you mean external links? (e.g., processwire.com). If not, please explain.

Thanks.

Share this post


Link to post
Share on other sites

Kongondo,

I am refering to the 3 choices you have to add a menu item in the admin interface of the module : Pages / Custom /selector.

Each of the menu item are using the custom option. here are 2 items of this menu

1534615158_Screenshot2020-06-25at11_33_06.png.936ea634153b4a01e4060a7e4f626e05.png1738638171_Screenshot2020-06-25at11_32_46.png.744dd42d6bfbd8075ae16ada3224cd47.png

The base url is the same, cause this a single process wire page, and the 2 last bit of the url are the url segments (ie /type/talk or /type/cours).
 

Share this post


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

2 last bit of the url are the url segments (

My hunch is that this is the reason. I don't think I ever tested MB with url segments. I'll have to look into this. Not sure when though, sorry.

By the way, although the option to use HTML in the title is available, I'd encourage you to use the method getMenuItems() instead (in your template file). It is much more powerful and will give you full control over the markup.

Edited by kongondo

Share this post


Link to post
Share on other sites

Hello,

Im kinda lost here, can't make it work, what am I doing wrong here. It kinda work but not the way it should it looks messy.

HTML:

<nav class="collapse">
  <ul class="nav nav-pills" id="mainNav">
    <li class="dropdown"><a class="dropdown-item dropdown-toggle" href="#">Features</a>
      <ul class="dropdown-menu">
        <li class="dropdown-submenu">
          <a class="dropdown-item" href="#">Headers</a>
            <ul class="dropdown-menu">
            	<li><a class="dropdown-item" href="feature-headers-overview.html">Overview</a></li>
            </ul>
        </li>
      </ul>
    </li>
  </ul>
</nav>
												<?php 
												$menu = $modules->get('MarkupMenuBuilder');
												$options = array(
													'wrapper_list_type' => 'ul',// ul, ol, nav, div, etc.
													'list_type' => 'li',// li, a, span, etc.
													'menu_css_id' => 'mainNav',// a CSS ID for the menu
													'menu_css_class' => 'nav nav-pills',// a CSS Class for the menu
													'submenu_css_class' => 'dropdown dropdown-menu dropdown-item',// CSS Class for sub-menus
													'has_children_class' => 'dropdown dropdown-submenu',// CSS Class for any menu item that has children
													'first_class'=>'',// CSS Class for the first item in 
													'last_class' => '',
													'current_class' => 'active',
													'default_title' => 0,// 0=show saved titles;1=show actual/current titles
													'include_children' => 4,// show 'natural' MB non-native descendant items as part of navigation
													'm_max_level' => 5,// how deep to fetch 'include_children'
													'current_class_level' => 1,// how high up the ancestral tree to apply 'current_class'
													'default_class' => '',// a CSS class to apply to all menu items
												);
												echo $menu->render(1022, $options);
												?>

This is the best combination I could found that doesn't look totaly broken.

Any help appreciated

thank you

R

Share this post


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

Im kinda lost here, can't make it work

How should it work? What is not working? 😊

1 hour ago, Roych said:

what am I doing wrong here

Impossible to tell since we don't know what is not working and what you mean by 'working'.

1 hour ago, Roych said:

It kinda work but not the way it should it looks messy.

No idea what this means. What do you mean messy? Maybe show us what you are trying to replicate first.

1 hour ago, Roych said:

I could found that doesn't look totaly broken.

Is it broken or does it look broken? What is broken? Looks like valid HTML to me.

@Roych, please give a better description and/or illustration of how you want the menu output to appear. Thanks.

Share this post


Link to post
Share on other sites

Sorry for beeing so unclear.

So the menu doesnt look like it should. The main menu looks ok, but the submenu looks messy. It does not work as in normal html. I guess my classes in code are not in the right place.

posting gifs below

Looking good: (original HTML)

Working.gif.a732f35b18a017a9fd8c6684b9f19f95.gif

 

Not looking good (my code)

Not-Working.gif.08a9c1c6a3d9b1abe815a3873ec17f46.gif

 

I hope Im making more sense now

Thank you

R

Share this post


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

I guess my classes in code are not in the right place.

Probably. Please copy paste here the original menu HTML that you are trying to replicate.

Share this post


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

Probably. Please copy paste here the original menu HTML that you are trying to replicate.

here is my original html (already posted above) 😉

<nav class="collapse">
  <ul class="nav nav-pills" id="mainNav">
    <li class="dropdown"><a class="dropdown-item dropdown-toggle" href="#">Features</a>
      <ul class="dropdown-menu">
        <li class="dropdown-submenu">
          <a class="dropdown-item" href="#">Headers</a>
            <ul class="dropdown-menu">
            	<li><a class="dropdown-item" href="feature-headers-overview.html">Overview</a></li>
            </ul>
        </li>
      </ul>
    </li>
  </ul>
</nav>

Thank you

R

Share this post


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

here is my original html (already posted above) 😉

I thought this was the output from echo $menu->render(1022, $options);, hence the confusion. In that case then, please post the 'messy/broken' output that results from echo $menu->render()....

Share this post


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

I thought this was the output from echo $menu->render(1022, $options);, hence the confusion. In that case then, please post the 'messy/broken' output that results from echo $menu->render()....

Here it is:

<ul id="mainNav" class="nav nav-pills">
	<li class="active">
		<a href='/'>Domov</a>
	</li>
	<li class="dropdown dropdown-submenu">
		<a href='/about/'>Mladi</a>
		<ul class="dropdown dropdown-menu dropdown-item">
			<li class="dropdown dropdown-submenu">
				<a href='/site-map/'>Site Map</a>
				<ul class="dropdown dropdown-menu dropdown-item">
					<li class="dropdown dropdown-submenu">
						<a href='#'>Test 1</a>
						<ul class="dropdown dropdown-menu dropdown-item">
							<li>
								<a href='#'>Test 2</a>
							</li>
						</ul>
					</li>
				</ul>
			</li>
		</ul>
	</li>
	<li>
		<a href='#'>Test 3</a>
	</li>
</ul>

Thank you

R

Share this post


Link to post
Share on other sites

@Roych

The menu you want cannot presently be achieved by using the render() method. For instance, looking at your <li> tags, going down the levels/depth, they have different classes. This is currently not possible in MB but I will add it to my todo list, e.g. a 'levels class'.

For custom menus such as yours, it is better to use the getMenuItems() method together with a custom recursive function. Below is an example recursive function that will output the example menu you provided. You can adapt it to your needs if you find it useful. It might need a bit of polishing.

Spoiler

<?php namespace ProcessWire;

function buildMenuFromObject($parent = 0, $menu, $first = 0, $level = 0) {
 if (!is_object($menu)) return;

 $level += 1;

 //------- LEVELS CLASSES -------
 //
 $liLevelClasses = '';
 $aLevelClasses = 'dropdown-item';
 if ($level === 1) {
  $liLevelClasses = 'dropdown';
  $aLevelClasses .= ' dropdown-toggle';
 } elseif ($level === 2) $liLevelClasses = 'dropdown-submenu';
 
 //----------

 $out = '';
 $hasChild = false;
 foreach ($menu as $m) {
  // if this menu item is a parent; create the sub-items/child-menu-items
  if ($m->parentID == $parent) {

   // if this is the first child
   if ($hasChild === false) {
    $hasChild = true; // is a parent
    // top/outer <ul></ul>
    if ($first == 0) {
     $out .= "<ul id='mainNav' class='nav nav-pills'>\n";
     $first = 1;
    }
    // submenu/inner <ul></ul>
    else $out .= "\n<ul class='dropdown-menu'>\n";
   }

   // CLASSES FINAL
   // ** li classes **
   // current class
   if ($m->isCurrent) $liLevelClasses .= ' active';
   $liClasses = $liLevelClasses ? " class='{$liLevelClasses}'" : '';

   // ** anchor classes **
   $aClasses = $aLevelClasses ? " class='{$aLevelClasses}'" : '';

   // anchor link (hash for top 2, else real URL)
   $href = $level < 3 ? '#' : $m->url;
   //---------
   // single menu item
   $out .= "<li$liClasses><a$aClasses href='$href'>{$m->title}</a>";

   // call function again to generate nested list for sub-menu items belonging to this menu item.
   $out .= buildMenuFromObject($m->id, $menu, $first, $level);
   $out .= "</li>\n";

  } // end if parent

 } // end foreach

 if ($hasChild === true) {
  $out .= "</ul>\n";
 }
 return $out;

}

//---------------- END FUNCTIONS -------------
$options = array('include_children' => 1, 'm_max_level' => 3);
$mb = $modules->get('MarkupMenuBuilder');
/* grab menu items as a WireArray with Menu objects */
$menuItems = $mb->getMenuItems(1022, 2, $options);
// render custom menu
echo '<nav class="collapse">' . buildMenuFromObject(0, $menuItems) . '</nav>';

 

 

  • Like 1

Share this post


Link to post
Share on other sites

Yes, it would be a great feature for the module. Im mostly using MB. 😉 Thank you for the code I'll try to addapt it to my needs 😉 

Thank you very much

R

Share this post


Link to post
Share on other sites

Hey @kongondo

I've found a PHP warning, i guess, when there a no items assigned to a menu, have a look at the screenshot:

2030783994_2020-10-2310_28_39.thumb.jpg.e1fe166db791c872be35b47765491ced.jpg

Latest Version of PW 3.0.167 / Menu Builder 0.2.5 / PHP 7.2.34

Share this post


Link to post
Share on other sites

Good day, @kongondo!

I can see some great features (like extra_fields option) on a dev branch (added in version 0.2.7). Is there a reason for not releasing it yet for everyone to enjoy on a master branch, which is being installed by default?

  • Like 1

Share this post


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

Is there a reason for not releasing it yet for everyone to enjoy on a master branch,

@Ivan Gretsky  Thank you for reminding me about this! Not only are there new features, but the dev version already has fixes for the issue you filed recently! I note that I added these features way back in January 2020! For now, I'll just blame the pandemic/isolation for my forgetfulness 😀.

I'll merge to master asap. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Hey @kongondo

I've read the docs and tried to find some hints here in the forum, but couldn't find anything regarding to my problem:

I need some menus only be displayed on the frontend when they are filled in the backend.

When I try to render a menu

<?=$menus->render('footer-3', $scnd_options);?>

with no items in it I get an error:

597270331_2020-10-2911_44_12.thumb.jpg.af5d2aedf0c61cf51ea40ca7349a0326.jpg

Even if i try to count the items before with

<?php bd($menus->getMenuItems('footer-3'));?>

I get this error.

So how can I check, if a specific menu has some items, is not empty or is unpublished and render it only if these conditions match?

Many greets.

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