Jump to content
Soma

MarkupSimpleNavigation

Recommended Posts

On 8/5/2019 at 4:46 PM, 999design said:

Update: I hadn't read the documentation properly and was able to add a custom class to pages that had the checkbox field checkbox_nav_prominent checked 🙂


function hookGetListClass(HookEvent $event){
    $child = $event->arguments('page'); // current rendered child page
    $class = $event->arguments('class'); // the class string already present
    // any check on that child to set your custom class
    if($child->checkbox_nav_prominent == 1){
        $event->return .= " is-prominent"; // add your custom class to the existing
    }
}

 

Glad you found it yourself. What's also possible is to just add a page-{name} or page-{id} to the item template and use them to style.

  • Thanks 1

Share this post


Link to post
Share on other sites

Hi,

I want to add icons to the urls using Mark Up Simple Navigation.

'item_tpl' => '<a href="{url}">{title}</a>'  (can add to all links)

'item_current_tpl' => '<a href="{url}">{title}</a>', (can add to current)

How can I add icon to separate urls

Thanks

 

Share this post


Link to post
Share on other sites

Well, is there a logic behind it? Icons per page-tree / category?

How do you plan to use icons? Inline SVGs? With :before or :after pseudo-selectors in CSS? Icon-fonts?

The easiest is to use your own classes and then style items with pseudo-selectors.

Or you could use attribute selectors: https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors e.g. .nav a[href^="https://mysite.tld/blog/"]:before {}

  • Thanks 1

Share this post


Link to post
Share on other sites

@buster808, just a heads-up that I've merged your question to the Markup Simple Navigation support thread. When you have questions regarding an existing module, you can find the module-specific support forum thread from the modules directory entry for that particular module 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Solved (My JavaScript causing Issue)

 

Hi, I cant get the link for the parent of a sub menu to go to its page - the submenu works fine.

Products (Not Working)
     Products One  (Working)
     Products Two (Working)

$options = array(
    'parent_class' => 'parent',
    'current_class' => 'current',
    'has_children_class' => 'has_children',
    'levels' => true,
    'levels_prefix' => 'level-',
    'max_levels' => null,
    'firstlast' => false,
    'collapsed' => false,
    'show_root' => true,
    'selector' => '',
    'selector_field' => '',
    
    'outer_tpl' => '<ul class="dropdown">||</ul>',
    'inner_tpl' => '<ul>||</ul>',
    'list_tpl' => '<li%s>||</li>',
    'list_field_class' => '',
    'item_tpl' => '<a href="{url}">{title}</a>',
    'item_current_tpl' => '<a href="{url}">{title}</a>',
    'xtemplates' => '',
    'xitem_tpl' => '<a href="{url}">javascript:;</a>',
    'xitem_current_tpl' => '<span>{title}</span>',
    'date_format' => 'Y/m/d',
    'code_formatting' => false,
    'debug' => false
);
echo $treeMenu->render($options, $page, $rootPage);
?>

Share this post


Link to post
Share on other sites

@Soma

One of the pages at level 2 of my menu has template access restricted so it does NOT show up in lists/searches by default. The only place I DO need this page to show up is in the menu.

Here's my MarkupSimpleNavigation options:

    $homepage = $pages->get("/");
    $menuItems = $homepage->children();
    
    bd($menuItems, "Menu items");

    $menuOptions = array(
        // 'outer_tpl' => '<ul class="nav nav-pills" id="mainNav">||</ul>',
        'selector' => "check_access=0",
        'inner_tpl' => '<ul class="dropdown-menu">||</ul>',
        'outer_tpl' => '||',
        'has_children_class' => 'dropdown',
        'current_class' => 'current',
        'parent_class' => 'current',
        'item_tpl' => '<a class="dropdown-item" href="{url}">{title}</a>',
        'item_current_tpl' => '<a class="dropdown-item" href="{url}">{title}</a>',
        'max_levels' => 2,
    );

I thought if I set 'selector' => "check_access=0" then the module would ignore security restrictions on any of the pages it finds for the menu. But adding this to the selector does not change anything -- the page using my secure template is still not being included in the menu (unless a user is logged in who has permissions to view that page). How can I get this page included into the menu for all users/guests?

Share this post


Link to post
Share on other sites

Hi there
I would like to have a menu with dropdowns for the subpages. But sometime I have a lot of subpages I don't want to disply in the menu structure. At the moment I am hiding these pages but this is no solution because then they are also hidden from the search.

How can I choose which menu-item should show subpages and which not?
Hope you can give me a hint how to archeive this.
Best wishes
Lukas

Share this post


Link to post
Share on other sites
6 hours ago, ---Lukas--- said:

But sometime I have a lot of subpages I don't want to disply in the menu structure.

You can add a new checkbox field „Show in menu“.
And then use the selector for this field 😉 

  • Like 1

Share this post


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

You can add a new checkbox field „Show in menu“.
And then use the selector for this field 😉 

Hi Zoeck
Thanky you for your reply - great idea!
So I added a checkbox field "show_in_menu" and added the following code to my menu options. But I get an error.
How can I use this checkbox properly for the selector?

'selector_field' => 'nav_selector',
'selector' => 'show_in_menu',

Share this post


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

Hi Zoeck
Thanky you for your reply - great idea!
So I added a checkbox field "show_in_menu" and added the following code to my menu options. But I get an error.
How can I use this checkbox properly for the selector?

'selector_field' => 'nav_selector',
'selector' => 'show_in_menu',

it’s a normal processwire selector:

https://processwire.com/docs/selectors/

your field name is show_in_menu, correct?

simply use:

'selector' => 'show_in_menu=1',

Share this post


Link to post
Share on other sites

EDIT: I'm still curious whether this is possible, but given this template has very low usage on our site I've decided to change it to a Verified URL field instead of a Page Reference. Problem solved!

Hi,

I have a 'redirect' template which consists of basically just a Page Reference field (it was designed for our in-page 'visual' navigation and works perfectly there).

However, in our left navigation I'd also like it to point to the URL of the referenced page rather than the URL of the page that has the redirect template applied.

I tried 'xitem_tpl' => '<a href="{target_page->url}">{title}</a>', but it doesn't appear to accept the target_page->url syntax (it just points to the URL of the current page instead). Is there a way to achieve this? I'd prefer not to have to hide that template type from the left navigation if at all possible.

Thanks!

Margaret

Edited by AAD Web Team

Share this post


Link to post
Share on other sites

Hi all!

I just installed the MarkupSimpleNavigation. I'm trying to implement this code below:

               <ul>
                        <li><a href="./index.html"><span>Home</span></a></li>
                   
                        <li class="active"><a href="#"><span>Pages <i class="fa fa-angle-down"></i></span></a>
                            <ul class="dropdown">
                                <li><a href="./categories-list.html">Categories</a></li>
                                <li><a href="./categories-grid.html">Categories grid</a></li>
                                <li><a href="./typography.html">Typography</a></li>
                                <li><a href="./details-post-default.html">Post default</a></li>
                                <li><a href="./details-post-gallery.html">Post gallery</a></li>
                                <li><a href="./details-post-review.html">Post review</a></li>
                                <li><a href="./contact.html">Contact</a></li>
                            </ul>
                        </li>
                        <li><a href="#"><span>Reviews <i class="fa fa-angle-down"></i></span></a></li>
                        <li><a href="#"><span>Windows <i class="fa fa-angle-down"></i></span></a></li>
                        <li><a href="#"><span>Videos <i class="fa fa-angle-down"></i></span></a></li>
                    </ul>

My problem is: The module has a way to add a class in the tag element li. But there seems to be no way to add in the <span> or the <i> in the list item. 

Any advice? 

 

Share this post


Link to post
Share on other sites

@Pip,

Moderator note:

Hi. I moved your question here, the support forum of MarkupSimpleNavigation.

  • Thanks 1

Share this post


Link to post
Share on other sites

Hi,

How can i add <a> class to first level of a href, excactly like in this example below, that class should not be added to all <a>.

Also how can i make a link Not clickable for those who have chlidrens? Currently to hide some menus i am using 'selector' => 'navhide!=1, template!=sitemap'. But is there a way where i can assign a field to parent template not to have dropdown, and how to do that?

Thank you

P.s i have read documentation but i dint find a way to achieve this

 

								<ul class="main-menu">
									<li class="main-menu__item main-menu__item--has-child main-menu__item--active"><a class="main-menu__link" href="javascript:void(0);"><span>Home</span></a>
										<!-- sub menu start-->
										<ul class="main-menu__sub-list">
											<li class="item--active"><a href="index.html"><span>01 Home Color Style</span></a></li>
											<li><a href="front_2.html"> <span>02 Home Color Style</span></a></li>
											<li><a href="front_3.html"><span>03 Home Color Style</span></a></li>
											<li><a href="mono/index.html"><span>04 Home Monochrome</span></a></li>
											<li><a href="mono/front_2.html"><span>05 Home Monochrome</span></a></li>
											<li><a href="mono/front_3.html"><span>06 Home Monochrome</span></a></li>
										</ul>
										<!-- sub menu end-->
									</li>
</ul>

My menu configuration is like this:

$options = array(
    'parent_class' => 'parent',
    'current_class' => 'item--active',
    'has_children_class' => 'main-menu__item--has-child',
    'levels' => true,
    'levels_prefix' => 'level-',
    'max_levels' => null,
    'firstlast' => false,
    'collapsed' => false,
    'show_root' => false,
    'selector' => 'navhide!=1, template!=sitemap',
    'selector_field' => 'nav_selector',
    'outer_tpl' => '<ul class="main-menu">||</ul>',
    'inner_tpl' => '<ul class="main-menu__sub-list">||</ul>',
    'list_tpl' => '<li%s>||</li>',
    'list_field_class' => 'main-menu__item {title}',
    'item_tpl' => '<a href="{url}"><span>{title}</span></a>',
    'item_current_tpl' => '<a href="{url}">{title}</a>',
    'xtemplates' => '',
    'xitem_tpl' => '<a href="{url}">{title}</a>',
    'xitem_current_tpl' => '<span>{title}</span>',
    'date_format' => 'Y/m/d',
    'code_formatting' => false,
    'debug' => false
);

 

Share this post


Link to post
Share on other sites

Hi there,

I would like to start the navigation on the 2nd level / depth instead of the 1st. I've tried to set this up with the `$rootPage` variable, bit I can't seem to find the correct flow for what i'm trying to achieve. Ideally I want to use the following setup:

- Home
-- Location A
--- Page 1
--- Page 2
-- Location B
--- Page 3
--- Page 4

When you're on the Homepage the menu should show: Home - Location A - Location B
When you're on the Location A page, the menu shows: Home (which is the Location A page) - Page 1 - Page 2

Is there a way to achieve this with the MarkupSimpleNavigation module? Or could somebody point me in the right direct to implement this menu?

Thanks!

Share this post


Link to post
Share on other sites

Moderator Note

@combicart

Please don't double post. I am sure other forums members have seen your question above and those who have an answer will chip in. I have removed your other topic. Thanks.

Share this post


Link to post
Share on other sites

I have installed for the first time the "Markup Simple Navigation". It works, the UL is given, as well as the LI with labels parent has_children:

<nav class="nav-main">
	Array<ul>
		<li class="level-1 current"><a href="/">Home</a></li>
		<li class="level-1 has_children"><a href="/service/">Service</a>
			<ul>
				<li class="level-2"><a href="/service/general-service/">General Service</a></li>
			</ul>
		</li>
	</ul>1    </nav>

But I don't understand why the word "Array" is placed before, and a "1" after the UL.

ProcessWire 3.0.165
Blank Installation
MarkupSimpleNavigation 1.3.6

Share this post


Link to post
Share on other sites

Good question. I doubt that MarkupSimpleNavigation does this, my guess goes more towards the template code it is used in.

The "1" likes to appear when you accidentally output the return value of include(), most common when mixing up <?= and <?php (but "echo include('something.php')" has been encountered in the wild too).

The "Array" points towards an echo $something where $something is an array. It might even be another <?= vs. <?php issue like this one:

<?= $myvar = array(1,2,3); ?>

So, to get to the culprit, check your PHP open tags first, then look for superfluous "echo" calls.

  • Like 1

Share this post


Link to post
Share on other sites

Is there a way not to show the last level (last child page) in the navigation?
In this case the parent of this last child page should have the "current_class" ...

Thanks!

Share this post


Link to post
Share on other sites
17 hours ago, BitPoet said:

Good question. I doubt that MarkupSimpleNavigation does this, my guess goes more towards the template code it is used in.

The "1" likes to appear when you accidentally output the return value of include(), most common when mixing up <?= and <?php (but "echo include('something.php')" has been encountered in the wild too).

The "Array" points towards an echo $something where $something is an array. It might even be another <?= vs. <?php issue like this one:


<?= $myvar = array(1,2,3); ?>

So, to get to the culprit, check your PHP open tags first, then look for superfluous "echo" calls.

I have placed the code as indicated by the developer. I couldn't find a bug. But I'm not a master programmer, so it was probably my fault.

I've changed the module: MarkupMenu works fine, doesn't output the module name. Now it's time to write the CSS. A pity that developers don't include a simple css sample 😉

Allow me a question: Is there no way to list the page tree without a module? I understand that it needs options to write the CSS, but maybe if there is a way without a module, it could be solved with simple code in an template?

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