Jump to content
Soma

MarkupSimpleNavigation

Recommended Posts

1 hour ago, gregory said:

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

I solved by excluding pages. Great! :lol:

 

 

Share this post


Link to post
Share on other sites

Hi everyone, me again.

I have a problem with my MarkupSimpleNavigation Setup. This is the structure (the important part of it):

- about
	- news (visible in navigation an marked "active" when news-items are selected
		- news-item 1 (not visible in navigation, link will be on the news site)
		- news-item 2  (not visible in navigation, link will be on the news site)
		- news-item 3 (not visible in navigation, link will be on the news site)

From what I found in the forums I have the following php-code for the markup navigation:

<?php
                    
                        /*
                          MarkupSimpleNavigation Example for Bootstrap 2.3.2 Multilevel Navbar
                        */
                        // load MarkupSimpleNavigation module
                        $nav = $modules->get("MarkupSimpleNavigation");
                        /* SETUP HOOKs ------------- */
                        // hook to have custom items markup 
                        $nav->addHookAfter('getTagsString', null, 'customNavItems');
                        function customNavItems(HookEvent $event){
                            $item = $event->arguments('page');
                            // first level items need additional attr
                            if($item->numChildren(true) && count($item->parents) < 2){
                                $title = $item->get("title|name");
                                $event->return = '<a href="#" class="dropdown-toggle" data-toggle="dropdown">' . $title . ' <b class="caret"></b></a>';
                            }
                            
                            // submenus don't need class and data attribs
                            if($item->numChildren(true) && count($item->parents) > 1){
                                $event->return = '<a href="#" class="active">' . $item->get("title|name") . '</a>';
                            }
                        }
                        // hook to add custom class to li's that have submenu
                        $nav->addHookAfter('getListClass', null, 'customListClass');
                        function customListClass(HookEvent $event){
                            $item = $event->arguments('page');
                            // if current list item has children and is level 2 from root
                            if($item->numChildren(true) && count($item->parents) > 1){
                                $event->return = ' dropdown-submenu'; // adds class to li
                            }
                        }
                        /* Render Navigation Markup ---------------- */
                        $navMarkup = $nav->render(
                            array(
                                'max_levels' => 3,
                                'parent_class' => 'active',
                                'current_class' => 'active',
                                'has_children_class' => 'dropdown', // all li's that have children
                                'outer_tpl' => '<ul class="nav navbar-nav pull-right">||</ul>', 
                                'inner_tpl' => '<ul class="dropdown-menu">||</ul>', 
                                )
                            );

                    echo $navMarkup; ?>

 

I want the navigation link "news" to show the template "news" with links to the "news-items" (that's what I have). "News" should always be "active" when "news" or "news-item" are clicked. What am I missing here?

this is what it looks like so far: http://rolspace.net/hd/energiegossau/uber-uns/news/

Thanks for your help.

Roli

 

 

 

 

Share this post


Link to post
Share on other sites

I?m not sure I understand the problem. The "News" entry has a class "active" as it should, but it doesn't show the children as they're hidden dropdown. Seems more like a problem with your html css js.

Share this post


Link to post
Share on other sites
35 minutes ago, Soma said:

I?m not sure I understand the problem. The "News" entry has a class "active" as it should, but it doesn't show the children as they're hidden dropdown. Seems more like a problem with your html css js.

aaah! now I see! sometimes, you don't get the most obious things. Thanks Soma!

Share this post


Link to post
Share on other sites

When adding a hook, how do I target the last item in the navigation, regardless of its page id (especially if that page changes)?

What I am trying to do is adding a clickable link that opens a UIKit modal containing the PW search form.  It works just fine if I set the code as a link/button somewhere in the page, but what I want to do is to have it as a menu item. The last item in the menu would be 'Search', and when clicked, will open the modal.

I've tried using a hook (my first time trying hooks), and I got this far using the demo HookEvent:

function myItemString(HookEvent $event){
    $child = $event->arguments('page'); // current rendered child page
    // any logic with $child possible here
    if($child->id == 1016){
        // set the return value of this hook to a custom string
        $event->return .= '<li><a href="#modal-example" title="Search" uk-toggle>Search</a></li>';
    }
}

// setup the hook after on ___getItemString($class, $page) method
$nav->addHookAfter('getItemString', null, 'myItemString');

This adds the 'Search' link after page 1016, but what I want to do is append it to the end of the menu, regardless of what that page id is, keeping it there if the client decides to move page 1016 from the last spot.  Can anyone point me in the right direction? Thanks!

PW 3.0.62
UIKit 3.0
Markup Simple Navigation 1.3.4

Share this post


Link to post
Share on other sites

Mhh... I think I ran into this problem before and solved it somehow, but can't remember how...

  'item_tpl' => '<a href="{url}">{title} <span>({numChildren})</span></a>',

The {numChildren} counts hidden and unpublished item as well.

Share this post


Link to post
Share on other sites

@billjoseph I think what need to do is simply test if it is the last child of its parent.

$parent = $child->parent;
if($parent->children->last === $child) ...

 

 

Share this post


Link to post
Share on other sites
On 8/24/2017 at 8:45 AM, Soma said:

@billjoseph I think what need to do is simply test if it is the last child of its parent.


$parent = $child->parent;
if($parent->children->last === $child) ...

 

If the page is the last "unhidden" page in the admin page tree pages, it works. 

I've got my 404 page and Search Results page as the last two items, both hidden, and I like to keep the tree organized that way, so I modified the logic to this:

$parent = $child->parent;
if($parent->children->last(!hidden) === $child)...

and it seems to work!

Thanks, @Soma for getting me back on the right track with this!!

Share this post


Link to post
Share on other sites

@billjoseph

I may be missing something here but why not simply modify the outer_tpl template in $options to include the Search button? Then it would always be the last item in the menu.

'outer_tpl' => '<ul>||<li><a href="#modal-example" title="Search" uk-toggle>Search</a></li></ul>',

 

  • Like 2

Share this post


Link to post
Share on other sites

@psy

So, yeah, here's where I throw myself on the mercy of the forums.  I will swear to you up and down that I tried that first and it didn't work, but now, of course, it does.  Maybe I had the <li> outside the </ul>? Maybe I just like to overthink it?

Either way, now I've got two different ways to do it!!

  • Like 1

Share this post


Link to post
Share on other sites
13 hours ago, psy said:

@billjoseph

I may be missing something here but why not simply modify the outer_tpl template in $options to include the Search button? Then it would always be the last item in the menu.


'outer_tpl' => '<ul>||<li><a href="#modal-example" title="Search" uk-toggle>Search</a></li></ul>',

 

This is correct and I do that as well, just only works to add something at the end. I assumed he want to add to a end of a pulldown.

  • Like 1

Share this post


Link to post
Share on other sites

I want to create a navigation menu with dropdowns in Bootstrap 4 (ProcessWire 3.0.62 and MarkupSimpleNavigation v1.3.4).
This was possible in Bootstrap 3, but I have yet to see it work with Bootstrap 4.


CODE - FAILS (Bootstrap 4)

    <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
    <?php
        $treemenu = $modules->get("MarkupSimpleNavigation");
        echo $treemenu->render([
            'max_levels' => 2,
            'show_root' => false,
            'parent_class' => 'active',
            'current_class' => 'active',
            'has_children_class' => 'dropdown',
            'outer_tpl' => '<ul class="nav navbar-nav">||</ul>',
            'inner_tpl' => '<ul class="dropdown-menu">||</ul>',
            'list_tpl' => '<li%s>||</li>',
            'list_field_class' => 'nav-item',
            'item_tpl' => '<a href="{url}" class="nav-link">{title}</a>',
            'item_current_tpl' => '<a href="{url}" class="nav-link">{title}</a>',
            'code_formatting' => true,
        ], $page);
    ?>
    </ul>

OBSERVED OUTPUT:

    <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
        <ul class="nav navbar-nav">
            <li class="active dropdown nav-item"><a href="/foo/" class="nav-link">Foo</a>
                <ul class="dropdown-menu">
                    <li class="nav-item"><a href="/foo/bar/" class="nav-link">Bar</a></li>
                    <li class="nav-item"><a href="/foo/baz/" class="nav-link">Baz</a></li>
                </ul>
                </li>
            <li class="dropdown nav-item"><a href="/alfa/" class="nav-link">Alfa</a>
                <ul class="dropdown-menu">
                    <li class="nav-item"><a href="/alfa/beta/" class="nav-link">Beta</a></li>
                </ul>
                </li>
        </ul>
    </ul>

EXPECTED OUTPUT (GOAL):

    <nav class="navbar navbar-expand-md navbar-dark bg-dark">
      <a class="navbar-brand" href="/">EnormiCorp</a>
      <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
        <span class="navbar-toggler-icon"></span>
      </button>

        <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
            <ul class="nav navbar-nav">
                <li class="active dropdown nav-item"><a href="/foo/" class="nav-link">Foo</a>
                    <ul class="dropdown-menu">
                        <li class="nav-item"><a href="/foo/bar/" class="nav-link">Bar</a></li>
                        <li class="nav-item"><a href="/foo/baz/" class="nav-link">Baz</a></li>
                    </ul>
                    </li>
                <li class="dropdown nav-item"><a href="/alfa/" class="nav-link dropdown-toggle" id="dropdown1" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Alfa</a>
                    <ul class="dropdown-menu" aria-labelledby="dropdown1">
                        <li class="nav-item"><a href="/alfa/beta/" class="dropdown-item">Beta</a></li>
                    </ul>
                    </li>
            </ul>
        </ul>
    </nav>


CODE - WORKS (Bootstrap 3)

    <div class="navbar">
        <div class="container">
            <?php
                $treemenu = $modules->get("MarkupSimpleNavigation");
                echo $treemenu->render([
                    'max_levels' => 2,
                    'levels' => false,
                    'show_root' => true,
                    'parent_class' => 'active',
                    'current_class' => 'active',
                    'has_children_class' => 'dropdown',
                    'outer_tpl' => "<ul class='nav navbar-nav vertical-align-bottom'>||{$editlink}</ul>",
                    'inner_tpl' => '<ul class="dropdown-menu">||</ul>',
                    'code_formatting' => true,
                ], $page);
            ?>
        </div>
    </div>


See also:
https://getbootstrap.com/docs/4.0/components/navbar/
https://getbootstrap.com/docs/4.0/components/dropdowns/

 

Share this post


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

Issue posted in separate topic (to prevent this topic from becoming too long):
MarkupSimpleNavigation - Navigation menu with dropdowns in Bootstrap 4

@SwimToWin

Moderator note:

I understand the concern of topics becoming too long (and it is something we are looking into), however, I am afraid we do not address the issue in this manner, i.e., by starting other topics in other places. This is MarkupSimpleNavigation's support forum, hence, it is the correct place to discuss your issue. Thus, I have reverted your topic here.

 

  • Like 1

Share this post


Link to post
Share on other sites

@SwimToWin I don't think I can help you on this as I have no time and no interest in maintaining bootstrap navigations. The module isn't made for it anyway. Maybe someone else who uses bootstrap stuff can help you out?

Share this post


Link to post
Share on other sites

@Soma You may be right that the request is beyond "simple navigation". It's a cool module and has worked well for me in many other projects.

I have created a plain Processwire solution that supports dropdowns and multi-language using Bootstrap 4 markup, will post it when time allows.

Share this post


Link to post
Share on other sites

Hello,

Im having some problems making my menu to look like it should. I tried everithing, just can't figure it out. Any help is appreciated. ;) Im using MarkupSimpleNavigation.

My HTML looks like:


					<ul class="navbar-nav ml-auto">
						<li class="nav-item active">
							<a class="nav-link" href="index.html"><span class="sr-only">(current)</span>Home</a>
						</li>

						<li class="nav-item dropdown drop_single ">
							<a class="nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false" href="javascript:void(0)">Pages</a>
							<ul class="dropdown-menu dd_first">
								<li><a href="page-aboutus.html">About Us</a></li>
								<li><a href="page-team.html">Team</a></li>
								<li><a href="page-member-details.html">Profile</a></li>
							</ul>
						</li>
					</ul>

I tried with: And many other combinations ...

<?php 

$options = array(
	'parent_class' => 'nav-link dropdown-toggle',
    'current_class' => 'current',
    'has_children_class' => 'nav-item dropdown drop_single',
    'levels' => true,
    'levels_prefix' => 'level-',
    'max_levels' => null,
    'firstlast' => false,
    'collapsed' => false,
    'show_root' => true,
    'selector' => '',
    'selector_field' => 'nav_selector',
    'outer_tpl' => '<ul class="navbar-nav ml-auto">||</ul>',
    'inner_tpl' => '<ul class="dropdown-menu dd_first">||</ul>',
    'list_tpl' => '<li%s>||</li>',
    'list_field_class' => '{nav-item dropdown drop_single}',
    'item_tpl' => '<a href="{url}" class="nav-link dropdown-toggle"><span class="sr-only">(current)</span>{title}</a>',
    'item_current_tpl' => '<a href="{url}"><span class="sr-only">(current)</span>{title}</a>',
    'xtemplates' => '',
    'xitem_tpl' => '<a href="{url}" class="nav-link"><span class="sr-only">(current)</span>{title}</a>',
    'xitem_current_tpl' => '<span>{title}</span>',
    'date_format' => 'Y/m/d',
    'code_formatting' => false,
    'debug' => false
);

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

?>

But can't get it right, not sure where Im wrong here.

 

Thank you very much

R

Edited by kongondo
Moderator Note: Moved your post to the module's support forum

Share this post


Link to post
Share on other sites

Guys, me again. I'm still trying to wrap my head around this module. How can I achieve the following structure:

Home
-- Submenu 1 (anchor #)
-- Submenu 2 (anchor #)
...

Products
-- Submenu 1 (anchor #)
-- Submenu 2 (anchor #)
...

and so on.... I need a clickable first menu-level (home and products are main sites and need to remain clickable). and then I need the submenus to be anchors, so clicking on the link jumps to the correct position on this or the other page. Is this possible. Or is it done differently in Processwire? Url segments maybe (tried to understand this, but no luck..)?

Thanks for any help...

Share this post


Link to post
Share on other sites

MarkupSimpleNavigation is really nice if you show the real path of your document structure in your url.

But in your case you always show the parents url, then I would go another way and do it yourself like:

echo '<ul>';
foreach($pages->get('/')->children as $item){
  $class = '';// for marking the parent li

  if($item->id == $page->id) { $class = "parent"; }
  echo "<li class='{$class}'><a href='{$item->url}'>{$item->title}</a>";// open toplevel li
  // if there are childpages
  if($item->children){
    echo '<ul>';
    foreach($item->children as $anchor){
      // you would have to set the anchor targets to the name of the page
      // note: $item->url # $anchor->url because you need the parents url 
      echo "<li><a href='{$item->url}#{$anchor->name}'>{$anchor->title}</a></li>";
    }
    echo '</ul>';
  }
  echo '</li>';// close toplevel link li
}
echo '</ul>';

 

  • Like 2

Share this post


Link to post
Share on other sites
On 08/11/2017 at 9:10 PM, Roych said:

Im having some problems making my menu to look like it should. I tried everithing, just can't figure it out. Any help is appreciated. ;) Im using MarkupSimpleNavigation.

My HTML looks like:



					<ul class="navbar-nav ml-auto">
						<li class="nav-item active">
							<a class="nav-link" href="index.html"><span class="sr-only">(current)</span>Home</a>
						</li>

						<li class="nav-item dropdown drop_single ">
							<a class="nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false" href="javascript:void(0)">Pages</a>
							<ul class="dropdown-menu dd_first">
								<li><a href="page-aboutus.html">About Us</a></li>
								<li><a href="page-team.html">Team</a></li>
								<li><a href="page-member-details.html">Profile</a></li>
							</ul>
						</li>
					</ul>

I tried with: And many other combinations ...

@Roych

What sort of output are you getting with your MarkupSimpleNavigation code? We can't tell what is not working if we can't see the output :).

Share this post


Link to post
Share on other sites
On 10.11.2017 at 9:11 AM, Donald said:

Hi everyone,

I just do not understand how to use css styles with markup simple navigation in the right way.

Could anyone post very basic examples for a complete markup simple navigation tree (with the options and the css styles) for a very basic responsive recursive navigation. If possible with hamburger button for small displays or a basic recursive accordeon  navigation.

Very basic examples would help as long the navigation is responsive and recursive and as the styles already added.

There's nothing special about it. Just as you normally would style a navigation. The module doesn't do that for you, it just outputs a nice clean nested UL, just a few classes for parents and active.

https://www.smartmenus.org/docs/ Is a simple JS Script to generate dropdowns and also resposive. You can drop the smartmenu plugin with their CSS and mobile hamburger button as in the docs (further down) and add the id and class to the outer tpl <ul id="main-nav" class="..."> of MarkupSimpleNavigation and it works out of the box,

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 Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • 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
×
×
  • Create New...