Jump to content
kongondo

Menu Builder

Recommended Posts

1 hour ago, bud said:

Thanks for your help so far. Your gif demonstration shows exactly why I mentioned that your module actually works great. I am personally only missing on little functionality or something similiar which you call "Using the Include Children Feature". The "Using the Include Children Feature" just seems to work if you choose the "page" option. It seems not to work together with the "custom" option you showed in the gif.

You are right. The 'Include Children Feature' only works for natural menu items, menu items that are ProcessWire pages. Your BMW (as per my example), are not ProcessWire pages but custom menu items. There is no way to tell what their children are since they are external items. 

1 hour ago, bud said:

In my example above I would use the "Using the Include Children Feature" to get all 1000 items in and afterwards customize that 50 items out of 1000 if I just could

Where would you be getting the 1000 items from? From my understanding, these 1000 items are not ProcessWire pages but external links. Maybe this is the bit I am not understanding. I have a feeling that your 1000 items are also actual pages in ProcessWire (part of the ProcessWire tree) and you want to include only their parent and have the children automatically added. If that's the case, that is not how MenuBuilder works. We currently don't support such a feature.

Share this post


Link to post
Share on other sites

OK, I now get what you are saying. However, I don't want to introduce confusion regarding terms. Custom items are not ProcessWire pages. Also, the include children feature you currently see in the backend is for influencing what happens in the frontend. It's not about including children in the backend. 

23 hours ago, bud said:

I am talking about the default menu which you would also become if you would use the module simple markup navigation in its very basic configuration. 

Here again, I don't want users to get confused. There is no default menu in MenuBuilder 🙂. I get your point though. I'll think about making it possible to select a ProcessWire page and have all its children added to the menu, hierarchically, according to their position in the ProcessWire tree. Please add this as a feature request in the module's project page.

As for customising links of ProcessWire pages that are part of a menu, I don't think that's a good idea so I will not be heading in that direction.

Share this post


Link to post
Share on other sites

Hello community.

For a new project of my company I would like to implement a checck if a menu exist (by ID, name etc.) and only if yes, to render it. So far I was googling and reading the pages here, but could not find a way to implement that. Could you kindly assist me in that?

So far what I've tried and obviously it did not work was this:

if ($menu->render(1234)!='') {
	echo $menu->render(1234, $options);        
}

It might be useful to have this check added to the MenuBuilder instructions as I always like to have a check for existence with any field/template so the menu would not differ. It sort of prevents the "danger screen" during website setup or if a typo in a call was made 😉

P.S. As far as every menu added is a page, I found a way to check for the page existence and it work, however I am not sure if that is the simplest and most elegant way to achieve the needed:

if($pages->get(1234)->title){ 
   echo $header_menu->render(1234, $options);        
}

 

Share this post


Link to post
Share on other sites
On 7/17/2018 at 10:51 AM, MilenKo said:

For a new project of my company I would like to implement a checck if a menu exist (by ID, name etc.) and only if yes, to render it. So far I was googling and reading the pages here, but could not find a way to implement that. Could you kindly assist me in that?

Hi @MilenKo,

Your code was close. If a menu is not found AND the user is a supersuser, Menu Builder will throw a WireException. If the user is not a supersuser, it will return false (boolean). In such a case, you can do your check like this:

$mb = $modules->get('MarkupMenuBuilder');

$out = $mb->render(1234, $options);
if($out) echo $out;
// OR
//if($mb->render(1234, $options)) echo $mb->render(1234, $options);

 

Share this post


Link to post
Share on other sites

Hi @kongondo I almost guessed the check on my first attempt, however the result came the same - I got a whole new "red page" while being logged on as SuperUser and the menu was not rendered if logged out (I did not yet add a non-SuperUser yet).

The thing is that once I hand out the profile, it wont be only me the person to hold the SuperUser but an IT team as well. So if someone gets the "red screen" and is not aware of MenuBuilder rendering way, they will report the issue as a profile failure. I found out though, that if I treat the menu as a page and check for existence of a title, than it does not matter whether you are a SU or not - if the page does not exist, nothing would happen and that is it (that is what I need as if someone reports to me, that the menu is not rendered, then I would simply advise to make sure that the menu ID or name is added with the links needed).

Following the initial logic, I reworked a bit my check up as to add an OR statement that besides the ID would also look for the menu name (page->title):

// Check if the menu has an id of 1234 or has a title equal to my_menu_name
// If no match for the ID but a match for the page title, then stil the menu would be rendered
// If no condition match, the error page would not be shown on any user and the menu would simpy not render
if($pages->get(1234)->title || $pages->get('title=my_menu_name') !=''){
   echo $footer_menu->render(1047, $options);        
}  

In a real world scenario, the check would work, but in a case where the page title matches another page being added with the same name outside of MenuBuilder, than it would force the menu to be rendered, but I can live with it for now, as the profile would already have the page added and it would be too much for someone to delete and recreate the menu (which would change the ID), then add another page with the same name as my original menu title and then test for rendering. This way I avoid any error page for all users and the only result would be that the menu would not render 😉

Share this post


Link to post
Share on other sites
45 minutes ago, MilenKo said:

In a real world scenario, the check would work, but in a case where the page title matches another page being added with the same name outside of MenuBuilder, than it would force the menu to be rendered

You can also do a check using the template 'menus'. That's the template used by menu builder menus.

Share this post


Link to post
Share on other sites

Well I've tried to check for the template earlier and it worked, but it was rendering the menu if any page had that template. After you brought this, I thought to re-create the query and this way just add it in the get statement:

// Check if the menu has an id of 1234 or has a title equal to my_menu_name
// If no match for the ID but a match for the page title, then stil the menu would be rendered
// If no condition match, the error page would not be shown on any user and the menu would simpy not render
if($pages->get(1234)->title || $pages->get('template=menus, title=my_menu_name') !=''){
   echo $footer_menu->render(1047, $options);        
}  

So we are adding an extra check to make sure that a similarity with another custom added page would be minimized. For sure it could happen, but there are already 3 criteria to match and I believe this would be enough.

Thanks very much, @kongondo for the perfect module and the shared knowledge (as usual) 😉

  • Like 1

Share this post


Link to post
Share on other sites

Update: Menu Builder 0.2.4

Changelog

  1. Fixed a bug where default_class was not getting applied to menu items in getMenuItems() context.
  2. Fixed bugs where last_class was not getting applied correctly/at all to some menu items.

In modules directory.

  • Like 2

Share this post


Link to post
Share on other sites

Hello,

This was probably already asked, but can't find something like this on the forum.

Im having some problems adding some extra html to the menu.

I'm using

<?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' => 'menu-main-menu-1',// a CSS ID for the menu
		'menu_css_class' => 'menu',// a CSS Class for the menu
		'submenu_css_class' => 'sub-menu',// CSS Class for sub-menus
		'has_children_class' => '',// 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' => 1,// 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(1032, $options);
?>

as my menu which is working great, but for the mobile menu I need to add extra <span class="toggler"></span> to the parrent so the html will look like this:

<li>
	<a href="#">Home</a><span class="toggler"></span>
		<ul class="sub-menu">
			<li><a href="#">Sub Menu 1</a></li>
			<li><a href="#">Sub Menu 2</a></li>
			<li><a href="#">Sub Menu 3</a></li>
			<li><a href="#">Sub Menu 4</a></li>
		</ul>
</li>

Is it possible to achieve this somehow?

Thank you

R

Share this post


Link to post
Share on other sites

Hi @Roych,

How are you building the mobile menu? Is it a separate menu or built on the fly? The usual way to tackle this is to use the Menu Builder's getMenuItems() method to return menu items either as an object or an array which you can traverse using a recursive function to build your menu with your markup and logic as you see fit. Please have a look at this post for examples (including 3 recursive functions you can edit to suit your needs). The functions (somewhat modified) can also be found in this gist.

Give us a shout if you run into issues.

 

  • Like 1

Share this post


Link to post
Share on other sites

Thank you, made it work using

Spoiler

<?php
/**
* Builds a nested list (menu items) of a single menu.

* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Object of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromObject($parent = 0, $menu, $first = 0) {
  if(!is_object($menu)) return;
  $out = '';
  $has_child = false;
  foreach ($menu as $m) {
    $newtab = $m->newtab ? " target='_blank'" : '';            
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($m->parentID == $parent) {// if this menu item is a parent; create the inner-items/child-menu-items
        // if this is the first child
        if ($has_child === false) {                    
            $has_child = true;// This is a parent                        
            if ($first == 0){                            
              $out .= "<ul id='menu-main-menu-1' class='menu'>\n";                            
              $first = 1;
            }                        
            else $out .= "\n<ul class='sub-menu'>\n";
        }
        $class = $m->isCurrent ? ' class="current"' : '';
        // a menu item
        $out .= '<li' . $class . '><a href="' . $m->url . '"' . $newtab . '>' . $m->title;                    
        // if menu item has children
        if ($m->isParent) {
          $out .= '</a><span class="toggler"></span>';
        }
        
        else $out .= '</a>';         
        // call function again to generate nested list for sub-menu items belonging to this menu item. 
        $out .= buildMenuFromObject($m->id, $menu, $first);
        $out .= "</li>\n";
    }// end if parent
  
  }// end foreach
  if ($has_child === true) $out .= "</ul>\n";    
  return $out;
}
##################################
/* grab menu items using MarkupMenuBuilder */
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder
/* get menu the menu we want (i.e. a menu created and published using ProcessMenuBuilder) */
// we can pass the menu's Page, page ID, title, name or its menu items string to getMenuItems()
#$menu = $pages->get(1032);// pass a Page
#$menu = 1032;// pass an ID
#$menu = 'Main';// pass a name
// passing an array
#$jsonStr = $pages->get(1032)->menu_items;
#$arrayFromJSON = json_decode($jsonStr, true);
#$menu = $arrayFromJSON;// pass an array
$menu = 'Main';// pass a title
/* only these 3 options apply to getMenuItems() */
$options = array('default_title'=> 1, 'default_class'=> 'cool_menu_class', 'current_class_level' => 4);
/* grab menu items as a WireArray with Menu objects */
$menuItems = $mb->getMenuItems($menu, 2, $options);// called with options and 2nd argument = 2 {return Menu (WireArray object)}
#$menuItems = $mb->getMenuItems($menu);// if calling without without options; 2nd argument defaults to 2
?>


<?php
  // build menu from array (example 1b only)
  echo buildMenuFromObject(0, $menuItems);
?>

So far so good. 😉

 

Thank you

R

  • Like 1

Share this post


Link to post
Share on other sites

Hi guys,

 

I'm struggling a little getting a menu rendered here. After having build the menu I want to manipulate it; I want to add all menu items to an array, grab an image from each of the target pages in the menu and then render each menu item with some pictures from its target page. I tried using getMenuItems() for this but somehow it fails, I probably don't really get how to properly use it. Here's what I have so far:

$menuBuilder = $modules->get('MarkupMenuBuilder');
$menu = 'mainNav';

$menuItems = $menuBuilder->getMenuItems($menu, 2, $options);
$bundledMenuItems = array();
$menuItemsWithPictures = array();

//build an array that holds the random picture for each category in the menu

foreach ($menuItems as $menuItem) {
    $targetPage = $pages->get($menuItem->id);
    $menuItemsWithPictures['title'] = $targetPage->title;
    $menuItemsWithPictures['pictures'] = $targetPage->get('images'); //this array is intentional, I want to do some slideshow thingy there
    array_push($bundledMenuItems, $menuItemsWithPictures);
}

$view->set('menuItems', $menuItems);
$view->set('bundledMenuItems', $bundledMenuItems);

?>

(This code is probably highly questionable, I'm not really proficient in php; love ProcessWire but despise php...., but what the hell.)

I can't, however, seem to render all the items with their corresponding pictures in the frontend.

I'm using twig as a template engine; this is what var_dump returns in the frontend:

 

            pages:
            array(4) {
  [0]=>
  array(2) {
    ["title"]=>
    string(4) "Home"
    ["pictures"]=>
    object(ProcessWire\Pageimages)#235 (2) {
      ["count"]=>
      int(1)
      ["items"]=>
      array(1) {
        ["steinlampe_2_grayscale.png"]=>
        string(26) "steinlampe_2_grayscale.png"
      }
    }
  }
  [1]=>
  array(2) {
    ["title"]=>
    string(5) "Admin"
    ["pictures"]=>
    NULL
  }
  [2]=>
  array(2) {
    ["title"]=>
    NULL
    ["pictures"]=>
    NULL
  }
  [3]=>
  array(2) {
    ["title"]=>
    string(5) "Pages"
    ["pictures"]=>
    NULL
  }
}

... which aren't the pages that I declared in the menu with menuBuilder. I there something I'm missing here?

My desired menustructure should be:

illustrationen
leuchten
impressum
...

 

Does anyone have an idea what I got wrong here?

Best regards, derelektrischemoench

 

 

Share this post


Link to post
Share on other sites

Hi @derelektrischemoench,

This code:

$targetPage = $pages->get($menuItem->id);

is the problem. For objects returned by getMenuItems(), id refers to the internal menu item ID in the collection AND NOT the corresponding ProcessWire page ID :-). Apologies, documentation could be clearer. To get the ProcessWire page ID of that menu item, use pagesID instead. 

So:

$targetPage = $pages->get($menuItem->pagesID);

By the way, please note that menu items with a pagesID of 0 are external menu items (e.g. an item pointing to google.com, etc). 

And while we are here..

This:

$targetPage->get('images');

Could be changed to:

$targetPage->images; 

However, your code shows that you are returning the whole 'images' field object. That is why you see this:

["pictures"]=>
    object(ProcessWire\Pageimages)#235 (2) {
      ["count"]=>
      int(1)
      ["items"]=>
      array(1) {
        ["steinlampe_2_grayscale.png"]=>
        string(26) "steinlampe_2_grayscale.png"

Is that intentional? Aren't you really after the url of the image? Secondly, how many images are in each menu item's images field? Is the image field a multi image field or single? If multi, you need to loop through it if you want multiple images from it, or get the first one using first(). If it is a single image field, you are fine, you can just grab the URL.

Share this post


Link to post
Share on other sites

Hi Kongondo,

thanks for the quick reply; I fixed my mistake by nesting the loops. I'm totally not used to php, which treats arrays very differently than other languages. What I ended up with was this:

 

foreach ($menuItems as $item) {
    $targetPageId = $item['pages_id'];
    $randomImage = $pages->get($targetPageId)->images->getRandom();
    $menuItemsRendered[] = array(
        'page_id'=>$item['pages_id'],
        'title'=>$item['title'],
        'url'=>$item['url'],
        'image'=>$randomImage
    );
}

which works perfectly fine. Thx  for the support.

Share this post


Link to post
Share on other sites

Thanks for this module very useful, However I still need one more option and I'm not sure how to get it.

The builder in the admin has the option to write a class(es) for each link. So far i cant find a way to retrieve that class and print it in the menu I create with the MarkupMenuBuilder.

Is there any other param in options or maybe someway to rewrite the part that print the links ?

Share this post


Link to post
Share on other sites

Really sorry I'm new in the forum. This topic should go in Modules/Plugins > Menu Builder

Share this post


Link to post
Share on other sites

@aolba, welcome to the forums.

On 11/7/2018 at 4:53 AM, aolba said:

The builder in the admin has the option to write a class(es) for each link. So far i cant find a way to retrieve that class and print it in the menu I create with the MarkupMenuBuilder.

How are you rendering your menus? If you are using render() then the classes are already included in <li> or <a> depending on the $options your send to render(). If you are using getMenuItems() with the array option, i.e. second parameter $type = 1, you get your classes in the index css_itemclass. If using getMenuItems() to return an object, you get the classes at $m->cssClass where $m is a single menu object/item.

Share this post


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

@aolba, welcome to the forums.

How are you rendering your menus? If you are using render() then the classes are already included in <li> or <a> depending on the $options your send to render(). If you are using getMenuItems() with the array option, i.e. second parameter $type = 1, you get your classes in the index css_itemclass. If using getMenuItems() to return an object, you get the classes at $m->cssClass where $m is a single menu object/item.

Thanks for the answer. You were right. I was thinking the class could be printed on the <a> tag.

Share this post


Link to post
Share on other sites

I hope someone can help: I get an error message and can't figure out what's wrong. I'm getting the following errors:

Warning: Creating default object from empty value in .../site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module on line 302
Warning: Creating default object from empty value in .../site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module on line 305

I use the same code on two sites, in the same environment, one works, the other one doesn't. Latest module version: 0.2.4 and latest Processwire dev.
The code:

<?php
  // Output the main menu
  $menu_builder = $modules->get("MarkupMenuBuilder");
  $menu_options = array(
    "menu_css_class" => "navbar-nav justify-content-end main-menu",
    "current_class" => "active",
    "default_class" => "nav-item"
  );
  echo $menu_builder->render("main_menu", $menu_options);
?>

It looks like the menu items get lost somewhere but I'm not that great with reading code and debugging.

Share this post


Link to post
Share on other sites
On 11/9/2018 at 9:16 AM, Jozsef said:

in the same environment, one works, the other one doesn't.

What's your environment (PHP ,etc)

I've not see this error before. Is this a multilingual site? Other than the warning, does the menu render at all? TracyDebugger error?

 

Share this post


Link to post
Share on other sites

Hi Kongondo, it's just a fresh install of PW 3.0.118 with a site profile that I took from the previous site.
All modules were added by the site profile backup. I use the same code in the template to output the menu.

My development machine is a Mac running AMPPS with PHP 7.1
The menu doesn't render, I get the error message instead.

Steps I tried (to no avail):
- Delete and recreate the menu
- Uninstall and delete the module, download a fresh copy and reinstall
- Downgrade the core to the same version as the other (working) site by overwriting the "wire" folder

 

Share this post


Link to post
Share on other sites

I also deleted the content of the file compiler and cache folders.
TracyDebugger shows the same two php errors I quoted before but I don't know how to dig deeper, I don't have a lot of experience with PHP debugging.

Share this post


Link to post
Share on other sites

Do you have Tracy installed? If yes, could you add the following before line 302 in MarkupMenuBuilder.module (e.g. on line 297) and tell me what Tracy reports?

d($menu);
// or this one
bd($menu);

 

Share this post


Link to post
Share on other sites
ProcessWire\WireArray #1f8a
	data protected => array ()
	extraData protected => array ()
	itemsRemoved protected => array ()
	itemsAdded protected => array ()
	duplicateChecking protected => FALSE
	useFuel protected => TRUE
	_instanceNum private => 0
	localHooks protected => array ()
	trackChanges private => 0
	changes private => array ()
	_notices protected => array (3)
		errors => NULL
		warnings => NULL
		messages => NULL
	_wire protected => NULL

 

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