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

@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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • 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.4.2
      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 Robin S
      Sanitizer EasySlugger
      Allows the use of the EasySlugger library as Sanitizer methods.
      Installation
      Install the Sanitizer EasySlugger module.
      Usage
      The module adds four new sanitizer methods.
      slugger($string, $options)
      Similar to $sanitizer->pageName() - I'm not sure if there are any advantages over that method. Included because it is one of the methods offered by EasySlugger.
      $slug = $sanitizer->slugger('Lorem Ipsum'); // Result: lorem-ipsum utf8Slugger($string, $options)
      Creates slugs from non-latin alphabets.
      $slug = $sanitizer->utf8Slugger('这个用汉语怎么说'); // Result: zhe-ge-yong-han-yu-zen-me-shuo seoSlugger($string, $options)
      Augments the string before turning it into a slug. The conversions are related to numbers, currencies, email addresses and other common symbols.
      $slug = $sanitizer->seoSlugger('The price is $5.99'); // Result: the-price-is-5-dollars-99-cents See the EasySlugger readme for some more examples.
      seoUtf8Slugger($string, $options)
      A combination of utf8Slugger() and seoSlugger().
      $slug = $sanitizer->seoUtf8Slugger('价钱是 $5.99'); // Result: jia-qian-shi-5-dollars-99-cents $options argument
      Each of the methods can take an $options array as a second argument.
      separator (string): the character that separates words in the slug. Default: - unique (bool): Determines whether a random suffix is added at the end of the slug. Default: false $slug = $sanitizer->utf8Slugger('这个用汉语怎么说', ['separator' => '_', 'unique' => true]); // Result: zhe_ge_yong_han_yu_zen_me_shuo_3ad66c4  
      https://github.com/Toutouwai/SanitizerEasySlugger
      https://modules.processwire.com/modules/sanitizer-easy-slugger/
    • By Robin S
      If you've ever needed to insert links to a large number of files within CKEditor you may have found that the standard PW link modal is a somewhat slow way to do it.
      This module provides a quicker way to insert links to files on the page being edited. You can insert a link to an individual file, or insert an unordered list of links to all files on the page with a single click.
      CKEditor Link Files
      Adds a menu to CKEditor to allow the quick insertion of links to files on the page being edited.

      Features
      Hover a menu item to see the "Description" of the corresponding file (if present). Click a menu item to insert a link to the corresponding file at the current cursor position. The filename is used as the link text. If you Alt-click a menu item the file description is used as the link text (with fallback to filename if no description entered). If text is currently selected in the editor then the selected text is used as the link text. Click "* Insert links to all files *" to insert an unordered list of links to all files on the page. Also works with the Alt-click option. Menu is built via AJAX so newly uploaded files are included in the menu without the page needing to be saved. However, descriptions are not available for newly uploaded files until the page is saved. There is an option in the module config to include files from Repeater fields in the edited page. Nested Repeater fields (files inside a Repeater inside another Repeater) are not supported. Installation
      Install the CKEditor Link Files module.
      For any CKEditor field where you want the "Insert link to file" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "LinkFilesMenu" to the "CKEditor Toolbar" settings field.
       
      http://modules.processwire.com/modules/cke-link-files/
      https://github.com/Toutouwai/CkeLinkFiles
    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate a repeater item from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
×
×
  • Create New...