Jump to content
Soma

MarkupSimpleNavigation

Recommended Posts

Thank you so much Robin  I will reduce options after solved this one,
I tried as you said nothing changed now there is no active class even in <a href>
 

<li><a href="#home">HOME</a></li>


What I ment is current code give "active" class to  <A href> not to <Li>  so my menu is not working properly

 

Share this post


Link to post
Share on other sites

The class is on the li if you don't change the options to not do it. You currently add the active class ot the a element yourself in the options. The list tpl misses the %s which will get replaced with the state classes.

It should be default

'list_tpl' => '<li%s>||</li>',

And default is this

 'item_current_tpl' => '<a href="{url}">{title}</a>',

Share this post


Link to post
Share on other sites

What would be best approach to hide certain sub-pages from a specific parent?

Here's my menu structure.

Home

Solutions
- Solutions Overview
- Solution 1
- Solution 2

Services
- Services Overview
- Service 1
- Service 2

Blog
- Blog Post 1
- Blog Post 2
- Blog  Post 3

 

When I mouse over Solutions and Services, I want to see my child pages as sub-menu items (I have this working) but I don't want my blog posts to be showing as a sub-menu.

If I could tell the Module not to display certain templates (blog post), that would solve it for me.

Normally I've gotten around this by having my Blog setup as follows

Blog
 - Posts (hidden)
- - Blog Post 1
 - - Blog Post 2
- - Blog Post 3

That's all good but it does create a longer URL
http://www.domain.com/blog/posts/blog-post01

than moving the post to the root of Blog and ending up with

http://www.domain.com/blog/blog-post01

Cheers

 

 

Share this post


Link to post
Share on other sites

There's various ways to do it. Simplest maybe to ignore certain templates use the selector option. ie "template!=blog".

Share this post


Link to post
Share on other sites
14 hours ago, Soma said:

The class is on the li if you don't change the options to not do it. You currently add the active class ot the a element yourself in the options. The list tpl misses the %s which will get replaced with the state classes.

It should be default


'list_tpl' => '<li%s>||</li>',

And default is this


 'item_current_tpl' => '<a href="{url}">{title}</a>',

Thank you so much this is solved my problem for active class but now dropdown dissaperead ? do you have any idea why its happaned ? here is my current code 



 

 <nav id="menuzord-right" class="menuzord default menuzord-responsive">
            <a class="menuzord-brand pull-left flip xs-pull-center mt-20" href="/processwire/">
              <img src="<?php echo $config->urls->templates?>/ind/logo.png" alt="">
            </a>
    


	
	<?php 
	
  $treeMenu = $modules->get("MarkupSimpleNavigation"); // load the module
  $options = array(
    'parent_class' => 'parent',
    // overwrite class name for current parent levels

    'current_class' => 'active',
    // overwrite current class

    'has_children_class' => 'dropdown',
    // overwrite class name for entries with children

    'levels' => false,
    // wether to output "level-1, level-2, ..." as css class in links

    'levels_prefix' => 'level-a',
    // prefix string that will be used for level class

    'max_levels' => 2,
    // set the max level rendered

    'firstlast' => false,
    // puts last,first class to link items

    'collapsed' => false,
    // if you want to auto-collapse the tree you set this to true

    'show_root' => true,
    // set this to true if you want to rootPage to get prepended to the menu

    'selector' => 'template!=MediaLibrary',
    // define custom PW selector, you may sanitize values from user input

    'selector_field' => 'nav_selector',
    // string (default 'nav_selector') define custom PW selector by using a property or field on a page. Use this setting if you want to overwrite the default nav_selector

    'outer_tpl' => '<ul class="menuzord-menu">||</ul>',
    // template string for the outer most wrapper. || will contain entries

    'inner_tpl' => '<ul class="dropdown">||</ul>',
    // template string for inner wrappers. || will contain entries

    'list_tpl' => '<li%s>||</li>',
    // template string for the items. || will contain entries, %s will replaced with class="..." string

    'list_field_class' => '', // string (default '') add custom classes to each list_tpl using tags like {field} i.e. {template} p_{id}
	
    'item_tpl' => '<a href="{url}">{title}<span class="indicator"></span></a>',
    // template string for the inner items. Use {anyfield} and {url}, i.e. {headline|title}, if field is of type image it will return url to image (first image if multiple)

    'item_current_tpl' => '<a href="{url}">{title}</a>',
    // template string for the active inner items.

    'xtemplates' => '',
    // specify one or more templates separated with a pipe | to use the xitem_tpl and xitem_current_tpl markup

    'xitem_tpl' => '<a href="{url}">{title}</a>',
    // same as 'item_tpl' but for xtemplates pages, can be used to define placholders

    'xitem_current_tpl' => '<span>{title}</span>',
    // same as 'item_current_tpl' but for xtemplates pages


    'date_format' => 'Y/m/d',
    // default date formatting for Datetime fields and native created/modified

    'code_formatting' => true,
    // enable or disable code indentations and newslines in markup output

    'debug' => false,
    // show some inline information about rendertime and selectors used as html comments

);

  echo $treeMenu->render($options); // render menu
 
	?>



			</nav>


and this is html output
 

	
<ul class="menuzord-menu">
	<li class="active"><a href="/processwire/">Home</a></li>
	<li><a href="/processwire/company/">Company<span class="indicator"></span></a></li>
	<li class="dropdown"><a href="/processwire/products/">Product & Solutions<span class="indicator"></span></a>
		<ul class="dropdown">
          <li><a href="/processwire/product1/">product1</a></li>



I realized my template currently working without implemented to processwire html output is like this 
 

<ul class="menuzord-menu">
              <li class="active"><a href="#home">HOME</a></li>
			  
              <li><a href="#">COMPANY<span class="indicator"><i class="fa fa-angle-down"></i></span></a>
                <ul class="dropdown" style="right: auto; display: none;">
                  <li><a href="#">item title</a></li>
				  <li><a href="#">item title</a></li>

but as I mention in this post  2 quote above out put come like this below and it dropdown is not working 
how can I output that like the one below... thanks in advance and your patience 
 

				  
<ul class="menuzord-menu menuzord-right menuzord-indented scrollable" style="max-height: 400px; display: block;">
	<li class="active"><a href="/processwire/">Home</a></li>
	
	<li><a href="/processwire/company/">Company<span class="indicator"></span></a></li>
	
	<li class="dropdown" style="display: none;"><a href="/processwire/products/">Product &amp; Solutions</a>
		<ul class="dropdown" style="right: auto;">
			<li><a href="/processwire/product1/">product1<span class="indicator"></span></a></li>






 

Edited by yetkind
Additional information added

Share this post


Link to post
Share on other sites

I don't know how your menu dropdown logic works but you have 

'has_children_class' => 'dropdown',

That adds to the <li classs="..."> and you have

'inner_tpl' => '<ul class="dropdown">||</ul>',
  • Like 1

Share this post


Link to post
Share on other sites
22 hours ago, Soma said:

I don't know how your menu dropdown logic works but you have 


'has_children_class' => 'dropdown',

That adds to the <li classs="..."> and you have


'inner_tpl' => '<ul class="dropdown">||</ul>',

 

Thank you so much menu css come with a template that I bought called "menuzord menu" I don't wanna get in the whole css code which is many but when I changed last thing you mentioned here removed one of the dropdown is now working perfectly.... you saved the day... I think spending to much time on same page I lost my focus thank you for seing that on my behalf!.....
 

Share this post


Link to post
Share on other sites

I don't know if this have been asked before, but I couldn't find anything that can solve my issues with MSN. I only wonder could MSN hide specific submenu and leave others intact?  Allow me to elaborate.

On my page tree in PW I have 3 pages that contain children pages in each.

Parent1
   Child1
   Child2
   Child3

Parent2
   Child1
   Child2
   Child3

Parent3
   Child1
   Child2
   Child3

The goal is to hide specific sub-menu in parent's name? Only on viewing page.

Parent1
   Child1
   Child2
   Child3

Parent2
   Child1
   Child2
   Child3

Parent3 (child menu hidden whole time, no dropdown or hover over and still intact in PW admin only)
 

Here's complete code...

 <nav id="navDT">
                <?php
                    $nav = $modules->get("MarkupSimpleNavigation"); 
                    $nav_options = array(
                    'show_root' => true,
                    'outer_tpl' => '<ul class="nav">||</ul>',
                    'inner_tpl' => '<ul class="drop">||</ul>',
                   
                    
                    );
                    echo $nav->render($nav_options);
                ?> 
            </nav>

If its not possible... Are there any other ways?

Thanks in advance

Share this post


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

You can use the 'selector' option. See examples here:

And the MSN Docs here.

Thank you, it worked! 

If not for another fourm post you posted. I wouldn't know anything about template!= inside selector... MSN doc isn't helping much with example 'selector' => '' why not update and use something like this 'selector' => 'template!={templatename.php}' ?

Once again, Thank you

 

Share this post


Link to post
Share on other sites

Hi Guys

Thanks for the help so far. Still working on a little issue here. I have a menu with submenus. Main menu items go from page to page, the submenus refer to anchors on the pages. I want to highlight (class="current") the current menu-button. when I'm on betrieb.php#team, I want team to show up as "current". And of course when I scroll up and down, it should change to whatever anchor I go. Does anyone have an idea how I can solve this?

This is my code so far. it works, but always highlights the menu AND the according submenus at the same time:

   
                         

      $treeMenu = $modules->get("MarkupSimpleNavigation"); // load the module

                                $treeMenu->addHookAfter('getItemString', function(HookEvent $event) {
                                    $item = $event->arguments('page');
                                    // if the item has more than one parent then it is a subpage
                                    if($item->parents->count() > 1) {
                                        $event->return = "<a href='{$item->parent->url}#{$item->name}'>$item->title</a>";
                                    }
                                    
                                });
                       
                                $options = array(
                                    'parent_class' => 'page-scroll parent',
                                    'current_class' => 'current',
                                    'has_children_class' => 'page-scroll has_children',
                                    'levels' => true,
                                    'levels_prefix' => 'level-',
                                    'max_levels' => 2,
                                    'firstlast' => false,
                                    'collapsed' => false,
                                    'show_root' => false,
                                    'selector' => '',
                                    'selector_field' => 'nav_selector',
                                    'outer_tpl' => '',
                                    'inner_tpl' => '<ul class="border">||</ul><hr>',
                                    'list_tpl' => '<li%s>||</li>',
                                    'list_field_class' => '',
                                    'item_tpl' => '<a href="{url}">{title}</a>',
                                    'item_current_tpl' => '<a href="{url}">{title}</a>',
                                    'xtemplates' => '',
                                    'xitem_tpl' => '<a href="{url}">{title}</a>',
                                    'xitem_current_tpl' => '<span>{title}</span>',
                                    'date_format' => 'Y/m/d',
                                    'code_formatting' => false,
                                    'debug' => false
                                );
                                
                                echo $treeMenu->render($options); // render default menu


     Thanks!

R

Edited by kongondo
Code Blocks

Share this post


Link to post
Share on other sites
9 hours ago, rolisx said:

This is my code so far. it works, but always highlights the menu AND the according submenus at the same time:

That, actually, has nothing to do with MSN (from what I can tell). It's called CSS :)....the styles are cascading. You need to solve this in your CSS file.

Share this post


Link to post
Share on other sites
8 hours ago, rolisx said:

when I'm on betrieb.php#team, I want team to show up as "current". And of course when I scroll up and down, it should change to whatever anchor I go.

This will require a Javascript solution. Just Google for it and you'll find loads of examples and probably a bunch of ready-made jQuery plugins. Here is something: http://codetheory.in/change-active-state-links-sticky-navigation-scroll/

Share this post


Link to post
Share on other sites

Hi everyone,

I have a question, i'm building a mega menu and i have one little question about ow to use the foreach function for the childeren of the childeren of the root. As in

 

Home
Sollution
      Submenu 1
              Link 1
              Link 2
      Submenu 2
              Link 1
              Link 2

Etc etc..

I have used the folowing code as a hook. The foreach function does not do the job:( The foreach function must be set for the childeren of the child of the root. Can anyone help me?

function customNavItems(HookEvent $event){
    $item = $event->arguments('page');
	$item2 = $event->arguments('Werkzaamheden');
	

    if($item->title == 'Werkzaamheden'){
		$out    .= '<li class="mega-menu sub-menu"><a href="#" class="sf-with-ul"><div>'.$item->get("title|name").'</div></a>';
		$out    .= '	<div class="mega-menu-content style-2 clearfix" style="display: none; width: 1628px;">';
		
					 foreach ($rootPage as $children) {
		$out	.= '		<ul class="mega-menu-column col-md-3">
								<li class="mega-menu-title">
									<div style="text-transform: uppercase!important;font-size:1.1em; margin:20px 0;">	
										<strong>Test 1</strong>
									</div>
									<ul>';
		$out	.= '					<li><a href="#"><div>sub1</div></a></li>';
		$out	.= '					<li><a href="#"><div>sub2</div></a></li>';
		$out	.= '					<li><a href="#"><div>sub3</div></a></li>';
		$out	.= '				</ul>';
		$out	.= '			</li>';
		$out	.= '		</ul>';
					 }
		
		
		
		$out	.= '		</div>';		
		$out    .= '</li>';
		
		
        //build the normal li item output or change the item with id 1068 to your needs
        //add new items that aren't in the normal pagetree or add megamenu items
        //....do what you want!
        
        //$out    = '<a href="'.$item->get("url").'">'.$item->get("title|name").'</a>';

        $event->return = $out;
    }
}

Just found the solution with "foreach($item->children as $child) {"

Share this post


Link to post
Share on other sites
On 25/01/2017 at 6:37 PM, Soma said:

There's various ways to do it. Simplest maybe to ignore certain templates use the selector option. ie "template!=blog".

Thanks @Soma That was it.

Share this post


Link to post
Share on other sites

Is it possible to list the top level link in the first dropdown? My client seem to be worried about the parent page being missed because of the target audience. 

For example :- 

- Home
--- Home
--- Page 
--- Page

Share this post


Link to post
Share on other sites

No it's not supported as the Module just renders the page structure. But it can be manipulated/faked in some ways with JS. And that's what I do if it's needed, cause it's a usability feature and something that doesn't really belong there, in the nature of a menu UL structure and the source. So I think it's ok to do that client side. 

Some example to do it. The "has_children" and "parent" come from the module and need to be removed to avoid false styling/information. 

$navigation = $('.wrapper .navigation');
    // generate "overview links“ for each submenu
    $navigation.find('li:has(ul)').each(function() {
        $this = $(this);
        var classes = $this.attr('class');
        var $link = $this.find('>a');
        var href = $link.attr('href');
        var $item = $('<li class="' + classes + '"><a href="' + href + '">' + $link.text() + '</a></li>');
        $item.removeClass("has_children");
        $item.removeClass("parent");
        $this.find('>ul').prepend($item);
    });

Edit: this is recursive over all levels. So all li's that has a UL. If you only want for the first level you'd adapt the find() to find(">li:has(ul)").

  • Like 2

Share this post


Link to post
Share on other sites

Thanks Soma,

I shall give this a try tomorrow its only the first level I require so thanks for that :)

Share this post


Link to post
Share on other sites

Am I doing something wrong or some of you encountered the same issue?

When using the simple navigation module it turns out that the site is loading every single visible and published pages in the page tree with every page request even though the max level is set to 1.

Tracy debugger reported over 8000 pages loaded on the home page on a bigger site I made, no wonder it took 15+ seconds to load. I checked on other sites I made with similar results. I swapped the navigation over to a function on the above site and the site got lightning fast again, as I expect from ProcessWire.

Is that an expected behaviour or am I doing something wrong? This is the code I used to output the navigation and had v1.3.3 installed:

$treeMenu = $modules->get("MarkupSimpleNavigation"); // load the module
$menuoptions = array('show_root' => true, 'max_levels' => 1, 'outer_tpl' => "<ul class='topnav clearfix'>||</ul>", 'inner_tpl' => "<ul class='subnav'>||</ul>");
echo $treeMenu->render($menuoptions); // render default menu

 

Share this post


Link to post
Share on other sites

Hi Soma, I need to create a menu with the centered logo as in the attached example. My idea is to create two different menus. How can it be done?
Thank you

 

multiple-menu.png

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