Jump to content
kongondo

Menu Builder

Recommended Posts

I don't know if MSN can use a WireArray to build menus. It certainly can take a PageArray and build a menu out of that. The key here is that MSN relies on true/natural PW child-parent relationships (unless something has changed that I don't know about) to create menus. So, $page->children will make sense to it. You won't get $page->children in MB...at least not in that original sense.

My bad. It is PageArray, not WireArray.

Anyway, could you consider the scenario of somehow making it possible for MenuBuilder and MarkupSimpleNavigation to work together? Maybe providing PageArray output with some dynamically-made-up pages for external links?

I really like the idea of separating concerns. It seems to me very handy to have one module to build menu markup from anywhere (MarkupSimpleNavigation) and one module to be able to generate contents for it from custom user input (MenuBuilder). So you do not have to learn two ways of doing the same thing on one site.

What do you think? Could this be possible?

Share this post


Link to post
Share on other sites

OK...sigh...because you asked nicely...
 
@note: 

  • Using this method, it makes no sense to create a menu with more than 1 level  in Menu Builder. The levels will be built using natural child-parent relationship in MSN
  • The CSS attritubes that can be set in MB have no meaning. I see no way of passing those to MSN
  • This was a one-time exercise. Currently, I am not able to support more features for this technique :-)

Step 1: Create a 1-level menu in MB
 
post-894-0-73568400-1464003482_thumb.png
 
Step 2:  Grab menu items from the menu created in MB in Step #1

$itemIDs = '';

$mb = $modules->get("MarkupMenuBuilder");
 
// options 1: get menu items as array
$menuItemsArray = $mb->getMenuItems('Ivan Gretsky', 1);
foreach($menuItemsArray as $m) $itemIDs .= $m['pages_id'] . '|'; 
$itemIDs = rtrim($itemIDs, '|');
 
        #### OR ####
 
//option 2: get menu items as object (WireArray)
$menuItemsObj = $mb->getMenuItems('Ivan Gretsky'); 
// implode the WireArray the cool way (PW 2.4+)
$itemIDs = $menuItemsObj->implode('|', 'pagesID');
 
// get a PageArray using menu item IDs
$itemsPageArray = $pages->find('id=' . $itemIDs);

 
Step 3: Output the menu using MSN

// pass the PageArray to MSN (optionally passing it MSN $options) to output your menu
$menu = $modules->get("MarkupSimpleNavigation");
echo $menu->render($options, null, $itemsPageArray);
  • Like 3

Share this post


Link to post
Share on other sites

Hi,

I got a problem, which makes me scratch my head a lot.

I have a menu item with two children, which are 'hidden', but not 'unpublished'. (A newsletter opt in page with landing pages for the double-opt-in-process.)

The menu generated looks like this (just the last 3 items):

                <li>
                    <a href='/pw/de/impressum/'>Impressum</a>
                </li>
                <li>
                    <a href='/pw/de/kontakt/'>Kontakt</a>
                </li>
                <li class="current">
                    <a href='/pw/de/newsletter/'>Newsletter</a>
                    <ul class="submenu">
                    </ul>
                </li>

As one can see, there is an empty ul in the last li. This causes some trouble with some jQuery - mobile - navigation generator.

What is puzzling me is, that in a second menu, which just contains this last 3 items (a footer in the non-mobile version) this ul does not appear. I could not find any differences in the menu settings. 

FYI: runs otherwise smoohtly on pw 3.08 dev.

Share this post


Link to post
Share on other sites

Works fine here...(2.7.3)...How are you building and generating the menu? Using includeChildren? Anything else?

Share this post


Link to post
Share on other sites

Thanks for your answer.

I can indeed make the empty ul make disappear by setting

'include_children' => 0

in the options. But then, also those items, which shall have their submenu, don't have one. 

Also, i can switch on an unintended empty ul in another menu, when i set include_children to 1 there.

Share this post


Link to post
Share on other sites

My intent was not to suggest that you use include_children as a solution. What I needed is more information to reproduce this. I have been unable to replicate you issue so the more information I have the better :-)...How the menu is constructed, the options, your environment, etc...basically, the whole code if that is possible....

Edited by kongondo

Share this post


Link to post
Share on other sites

Ah, ok. I'll attach all files i think could be relevant. if you want more, just drop a line.

It's  the "newsletter" item, which has the empty ul.

post-4083-0-08867200-1464815536_thumb.jp

Share this post


Link to post
Share on other sites

Hi, I found a possible cause for the issue when tampering with my own menu function and running into the very same problem.

In line 351 of MarkupMenuBuilder.module 

if($p->numChildren) $hasNativeChildren = 1;// has children to add

is the function numChildren used. This function counts in default mode also hidden children. 

To make it count only visible children, it has to be used with a parameter:

if($p->numChildren(true)) $hasNativeChildren = 1;// has children to add

I tried it and it seems to work! :-)

Share this post


Link to post
Share on other sites

Ok, this might just be a dumb question...But, has anyone had any success adding "<span class="caret"></span>" into a menu yet using bootstrap? My dropdown works great, save for the the fact that for the life of me I can not figure out how to get the dropdown li to have a caret.

Share this post


Link to post
Share on other sites

Hi, I found a possible cause for the issue when tampering with my own menu function and running into the very same problem.

In line 351 of MarkupMenuBuilder.module 

if($p->numChildren) $hasNativeChildren = 1;// has children to add

is the function numChildren used. This function counts in default mode also hidden children. 

To make it count only visible children, it has to be used with a parameter:

if($p->numChildren(true)) $hasNativeChildren = 1;// has children to add

I tried it and it seems to work! :-)

OK, I'll try and replicate. As for the files, seems I wasn't clear, sorry. I just needed to see how you were calling menubuilder methods + the options you were passing to it :-)

Ok, this might just be a dumb question...But, has anyone had any success adding "<span class="caret"></span>" into a menu yet using bootstrap? My dropdown works great, save for the the fact that for the life of me I can not figure out how to get the dropdown li to have a caret.

Have a look here: https://processwire.com/talk/topic/4451-menu-builder/?p=120639

Share this post


Link to post
Share on other sites

Ha ha.. touche.. Well, I will get this all sorted out. I went with Example "1b", however, I am getting "Call to undefined function buildMenuFromObject()"... Any idea what could cause this?

Share this post


Link to post
Share on other sites

Example 1b is for buildMenuFromArray() actually...buildMenuFromObject() is for example 1a. Whichever you choose, you need to define the function first before you can call it...(i.e. the function code first, then echo it...)

Edited by kongondo

Share this post


Link to post
Share on other sites

Thank you so much (and sorry for my confusion). I thought I had it, but now I am just getting 6 errors:

Error: Exception: Method MarkupMenuBuilder::getMenuItems does not exist or is not callable in this context (in Desktop/_Staging/test/wire/core/Wire.php line 409)

#0 [internal function]: ProcessWire\Wire->___callUnknown('getMenuItems', Array)
#1 Desktop/_Staging/test/wire/core/Wire.php(347): call_user_func_array(Array, Array)
#2 Desktop/_Staging/test/wire/core/WireHooks.php(555): ProcessWire\Wire->_callMethod('___callUnknown', Array)
#3 Desktop/_Staging/test/wire/core/Wire.php(370): ProcessWire\WireHooks->runHooks(Object(MarkupMenuBuilder), 'callUnknown', Array)
#4 Desktop/_Staging/test/wire/core/Wire.php(371): ProcessWire\Wire->__call('callUnknown', Array)
#5 Desktop/_Staging/test/site/templates/navTwo.inc(11): ProcessWire\Wire->__call('getMenuItems', Array)
#6 /Desktop/_Staging/test/site/templates/head.inc(85): include('/Us

I am a bit lost on this now, though I am trying to dig through them and understand what they mean.

What I have thus far (all using example 1b):

head.inc

   <div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
     <?php //include('./navigation.inc');?>
     <?php include('./navTwo.inc');?>
     <?php  echo buildMenuFromArray(0, $menuItems2); ?>
   </div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder

$jsonStr = $pages->get(1033)->menu_items;
$arrayFromJSON = json_decode($jsonStr, true);
#$menu = $arrayFromJSON;// pass an array
$menu = 'main';// pass a title

/** grab menu items as WireArray with Menu objects **/
// for examples 1a, 2 and 3
$menuItems = $mb->getMenuItems($menu, 2, $options);// called with options and 2nd argument = 2 {return Menu (WireArray object)}
#$menuItems = $mb->getMenuItems($menu);// called without options; 2nd argument defaults to 2

/** grab menu items as Normal Array with Menu items **/
// only for example 1b below
$menuItems2 = $mb->getMenuItems($menu, 1);// called without options; 2nd argument is 1 so return array

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0) {

  $out = '';
  $has_child = false;

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($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 class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul class='sub-menu'>\n";
        }

        $class = isset($m['is_current']) && $m['is_current'] ? ' class="current"' : '';

        // a menu item
        $out .= '<li' . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

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

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}



?>

Did I miss something crucial here?

Share this post


Link to post
Share on other sites

I see you copied and pasted more code than necessary. I have used your code and it works for me...

First, you need to make sure you have the latest version of Menu Builder which has the method getMenuItems(), i.e. version 0.1.5

head.inc

<div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
  <?php include('./navTwo.inc');?>
  <?php  echo buildMenuFromArray(0, $menuItems); ?>
</div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder
$menu = 'Main';// pass a title of an existing menu (i.e. a menu already built and published in ProcessMenuBuilder)

// grab menu items as Normal Array with Menu items (argument #2 = 1)
$menuItems = $mb->getMenuItems($menu, 1);

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0) {

  $out = '';
  $has_child = false;

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($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 class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul class='sub-menu'>\n";
        }

        $class = isset($m['is_current']) && $m['is_current'] ? ' class="current"' : '';

        // a menu item
        $out .= '<li' . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

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

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}

?>

Share this post


Link to post
Share on other sites

Thanks again.. Finally starting to understand what is going on, but now it is time to figure out how to give the "second nested ul" a different class than the wrapper ul. I thought I could pass that through with $options, but that doesnt seem to work. (sorry to drag this thread out).

Share this post


Link to post
Share on other sites

Actually, my bad; the README and my post above wasn't very clear (have now updated them). Not all options apply to getMenuItems(). The reason is that if using MarkupMenuBuilder to output the menu for you, i..e using the method render(), the structuring of the menu (the <ul>, their CSS classes, etc) are taken care of by the method. In contrast, if using getMenuItems() what you get back are the menu items with all their relevant properties. The reasoning here is that you will use those properties as well as any other logic and/or options you want in your own custom recursive function (nested loops) where you have full control of the markup. That said, only 3 options (from the list of those applicable to render()) apply to getMenuItems(). These are default_title, default_class and current_class_level. default_class is applied to the  item's property $m['ccss_itemclass'].

Here is a revised navTwo.inc showing how you can pass custom options to the recursive function and applying the same as well as the 3 options that can be passed to getMenuItems(). head.inc is also slightly revised to pass $options to buildMenuFromArray()

- @note: The new 4th argument in the function

- @note: The custom options array

- @note: Complete code for previous examples 1-3 can be found in these gists

head.inc

<div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
 <?php include('./navTwo.inc');
  // your CUSTOM options to pass to the recursive function buildMenuFromArray()
  $options = array (
   'submenu_css_class' => 'nested-ul-css-class',//CSS Class for sub-menus; you can use whatever index you want
   'other_custom_option' => 'foo',
   'first_class' => 'first',
   'last_class' => 'last',
   'current_class' => 'current',
   'has_children_class' => 'parent',
 );

  echo buildMenuFromArray(0, $menuItems, 0, $options);

 ?>
</div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder
$menu = 'Main';// pass a title of an existing menu (i.e. a menu already built and published in ProcessMenuBuilder)

// @note: only these 3 options will work with getMenuItems(); Only pass options if you need to; it is not mandatory 
$options4getMenuItems = array('default_title' => 1, 'default_class' => 'list-group', 'current_class_level' => 4);

// grab menu items as Normal Array with Menu items (argument #2 = 1)
#$menuItems = $mb->getMenuItems($menu, 1); OR
$menuItems = $mb->getMenuItems($menu, 1, $options4getMenuItems);// if passing options

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0, $options = array()) {

  $out = '';
  $has_child = false;
  $subMenuCSSClass = isset($options['submenu_css_class']) ?  'class="' . $options['submenu_css_class'] . '"' :  '';

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($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 class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul ". $subMenuCSSClass .">\n";
        }

	// item CSS
	$itemCSSID = isset($m['css_itemid'])? ' id="' . $m['css_itemid'] . '"' : '';				
	$itemCSSClass = isset($m['css_itemclass']) ? $m['css_itemclass'] . ' ' : '';
	$itemFirst = isset($m['is_first']) && isset($options['first_class']) ? $options['first_class'] : '';				
	$itemHasChildren = isset($m['is_parent']) && isset($options['has_children_class']) ? $options['has_children_class'] . ' ' : '';				
	$itemLast = isset($m['is_last']) && isset($options['last_class']) ? $options['last_class'] . ' ' : '';
	$itemCurrent = 	isset($m['is_current']) && isset($options['current_class']) ? $options['current_class'] . ' ' : '';

	$classes = $itemCSSClass . $itemHasChildren . $itemLast . $itemCurrent . $itemFirst;
	$classes = trim(preg_replace('/\s+/', ' ', $classes));
	$class = strlen($classes) ? ' class="' . $classes . '"' : '';

        // a menu item
        $out .= '<li' . $itemCSSID . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

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

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}

?>

Share this post


Link to post
Share on other sites

Thanks again Kongondo! I appreciate all the help. I actually figured it out about 5 mins ago (forgot to check back on the forums). It feel good to have actually learned through your help and the various comments what actually is occurring and not blindly copying. Your module has made things so much easier (once I learned).

Share this post


Link to post
Share on other sites

Hey kongondo,

thanks for thi great module again. A few days ago I figured out, that the output of the main menu builder header is not formated in html. Maybe it has to do with some other modules installed, because I never had the issue, that the output is not "rendered" as HTML.

Does anyone else have this issue, too?

 

menubuilder.jpg

Share this post


Link to post
Share on other sites

Saw that once in a multilingual setup, IIRC.....What's your setup? PW version, etc...

Share this post


Link to post
Share on other sites

Hey, 

 

thanks for your fast reply. I attached a screenshot with my current setup. You are right, the page is multilingual. 

Maybe you cna give me a hint, how I can solve this?

screenshot-2016-06-29 10-55-17.png

It seems, that the HTML is not rendered correctly. I tried to edit the HTML of the decription field and put Markdon tags in the description, which are displayed correct.

 

Edited by pmichaelis
Description Field HTML

Share this post


Link to post
Share on other sites

Sorry,

I still can't figure it out. All the descriptions are not displayed as HTML. A can't update Menu Item, or anything else. Does anyone have a hint for me to solve this?

Share this post


Link to post
Share on other sites

I see you are using PW 3.x. Could you please try in a multilingual PW 2.7xx and let me know if it works?

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