Soma

MarkupSimpleNavigation

Recommended Posts

Soma    6,126

Markup Simple Navigation Module

While there was a lot of people asking how to make navigation, and there were many examples around already (apeisa, ryan...) I took the chance to sit down 2-3 hours to make a simple navigation module. It has even some options you can control some aspects of the output.

Installation:

1. Put this module's folder "MarkupSimpleNavigation" into your /site/modules folder.
2. Go to your module Install page and click "Check for new modules". It will appear under the section Markup. Click "install" button. Done.

Technically you don't even need to install it, after the first load call ( $modules->get("MarkupSimpleNavigation") ) it will install automaticly on first request if it isn't already. But it feels better. However, it will not be "autoloaded" by Processwire unless you load it in one of your php templates.
 

Documentation:
https://github.com/somatonic/MarkupSimpleNavigation/blob/master/README.md

Modules Repository processwire.com

mods.pw/u

Download on github

https://github.com/somatonic/MarkupSimpleNavigation

Advanced example with hooks

creating a Bootstrap 2.3.2 Multilevel Navbar

https://gist.github.com/somatonic/6258081
 
I use hooks to manipulate certain attributes and classes to li's and anchors. If you understand the concept you can do a lot with this Module.

Edited by Nico Knoll
Added the "module" tag.
  • Like 18

Share this post


Link to post
Share on other sites
ryan    13,367

Great module Soma! Thanks for making this and posting.

The only thing I wonder is why make it an autoload module? This is one that is meant for on-demand use, so it doesn't technically need to be an autoload module. Though I agree it does make for a nicer API call:

echo treeMenu->render(...); 
// vs. 
echo $modules->get('MarkupSimpleNavigation')->render(...); 

But I'm just thinking that if every module took this approach, PW wouldn't run as efficiently, or could even run out of memory. But I love this module either way. :)

Share this post


Link to post
Share on other sites
Soma    6,126

I just implemented a new option to prepend the rootpage to the navigation.

echo $treeMenu->render( array('show_root' => true) );

Thanks Ryan! Yes I wasn't sure if that makes sense, now as you're saying it... So could I make it so that it isn't autoload and load it once before the call, and then you would have the $treeMenu->render variable? Like

$treeMenu = $modules->get('MarkupSimpleNavigation');
echo $treeMenu->render();

I will change it I think, as it's better performancewise.

EDIT: Just commited new version and updated first post and readme.

Share this post


Link to post
Share on other sites
ryan    13,367

Thanks Soma, this is a great module and a recurring need--I think it will be helpful to a lot of people, including myself. Nice work with the good documentation too.

  • Like 1

Share this post


Link to post
Share on other sites
MarcC    130

Very helpful! Thanks Soma, I'm excited to try it. BTW, is there a way to exclude items from the menu? Maybe I missed something...

Share this post


Link to post
Share on other sites
Soma    6,126

Very helpful! Thanks Soma, I'm excited to try it. BTW, is there a way to exclude items from the menu? Maybe I missed something...

Thanks Marc! Well not with the module, usually you make the pages you don't want to appear status "hidden".

BTW. I just commited a new update and added support for max level. You can now use 'max_levels' => 2.

Share this post


Link to post
Share on other sites
alan    364

Soma / anyone,

This is off-topic really but as a newb to PW (and github), my desktop github client shows the github version is now updated, I just looked in the forum but couldn't find a post to tell me the preferred method for updating a module.

Is it a case of just getting the latest version and overwriting the contents of the folder the module is in locally? Or doI need to disable the module first? Or something different?

Thanks for any help, cheers, -Alan

Share this post


Link to post
Share on other sites
Soma    6,126

Soma / anyone,

This is off-topic really but as a newb to PW (and github), my desktop github client shows the github version is now updated, I just looked in the forum but couldn't find a post to tell me the preferred method for updating a module.

Is it a case of just getting the latest version and overwriting the contents of the folder the module is in locally? Or doI need to disable the module first? Or something different?

Thanks for any help, cheers, -Alan

You are save to just replace the files. No need to uninstall, as it doesn't install something or depend on something.

Although because it was at first "autoload" and I changed that, you should check in the db table "modules" if the col "flags" of this module is set to 1 and not 3. If it's at 3 it you can just change it manually to 1.

Share this post


Link to post
Share on other sites
SiNNuT    1,020

Ho Soma, awesome stuff! Can't wait to play a bit with this module.

I think there is an error in the opening post and docs on github:

The call under basic usage should be

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

Share this post


Link to post
Share on other sites
alan    364

You are safe to just replace the files. No need to uninstall, as it doesn't install something or depend on something.

Although because it was at first "autoload" and I changed that, you should check in the db table "modules" if the col "flags" of this module is set to 1 and not 3. If it's at 3 it you can just change it manually to 1.

Thanks Soma!

Share this post


Link to post
Share on other sites
Pete    3,387

I like this module as it reminds me of WayFinder for MODx - definitely one of the most useful tools I used to use for getting a site up and running quickly.

  • Like 1

Share this post


Link to post
Share on other sites
tnt    1

Another MODx defector! ;-) (well, actually I'm building my first ProcessWire site at the mo and I'm liking it so far, so it might become my CMS of choice!)

This is typical though... I just adapted (don't really know PHP to do it on my own!) a script for multilevel navigation and this comes out!!! At least I learnt a few things about PW whilst doing that!

Thanks for this very useful module Soma! Will try it out straight away!

Share this post


Link to post
Share on other sites
diogo    4,507

... I just adapted (don't really know PHP to do it on my own!) a script for multilevel navigation and this comes out!!! At least I learnt a few things about PW whilst doing that!

It's great that people are coming with modules like this, but the reason PW is so flexible, is because it's so easy to build your own snippets of code to achieve this kind of things. I have mixed feelings concerning the modules, and tend to prefer the idea of the snippets repository...

Share this post


Link to post
Share on other sites
MarcC    130
Thanks Marc! Well not with the module, usually you make the pages you don't want to appear status "hidden".

Doh, just checked, that's what I was already doing. My brain is fried :-[ Thanks again !

Share this post


Link to post
Share on other sites
tnt    1

Modified it a bit to fit my needs, but someone might find it useful as well.

Basically, I added a 'first' and 'last' class to the first and last item of each level and also added an exclusion list, so that pages with certain templates can have their children excluded.

The usage is:


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

The $exclusions is an array that contains the name of the template of a page which we don't want to see its children. For example if we have a 'News' page with a template of 'news-list' that aggregates a list of article pages with template 'news-article', then 'news-list' should be added in the $exclusions array. I hope that's clear. Not sure if this is the most flexible way to do this, but it works for me right now and I'm sure someone will come along and improve on it!!

One other change was that I removed the newlines from the <li>'s to make the menu code easier to read and also I've changed the $childs to $children just because it bugged me... sorry!!

I haven't tested the module extensively (read: at all) and as I mentioned in a previous post I'm not really a PHP coder (or a web dev for that matter!) so bear that in mind when you read the few lines that I changed!!! :-)

<?php
/**
*
* Simple Tree Menu Module 1.0.0
*
* @author Soma, with code based by Apeisa, Ryan.
*
* @date_created 08/03/2012
* @last_modified 08/03/2012
*
* ProcessWire 2.x
* Copyright (C) 2011 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/
class MarkupSimpleNavigation extends WireData implements Module {
public static $defaultOptions = array(
 'css_parent' => 'parent',
 'css_current' => 'current',
 'css_levels_on' => false,
 'collapsed' => false,
 'show_root' => false,
 'ul_id' => '',
 'ul_class' => '',
 'max_levels' => null
);

public static function getModuleInfo() {
 return array(
  'title' => "Markup for simple nested navigation",
  'summary' => 'Module to render simple nested ul tree of the site structure. See readme for usage and options avaiable.',
  'version' => 100,
  'href' => 'http://processwire.com/talk/topic/1036-markupsimplenavigation/',
  'autoload' => false,
  'singular' => true
 );
}
public function init() {
 //$this->fuel->set('treeMenu', $this );
 $this->set('iteration',0);
}

/**
*
*   Main method called ony pages by echo $treeMenu->render(); to render
*   init tree rendering, merge options with defaults
*
*/
public function render( Array $options = null, Array $exclusions = null, Page $page = null, Page $rootPage = null ) {
 if($options != null && is_array($options)){
  $options = array_merge(self::$defaultOptions, $options);
 } else {
  $options = self::$defaultOptions;
 }
 return $this->_renderTree( $options, $exclusions, $page, $rootPage );
}

/**
*
*   Render the tree method
*
*/
private function _renderTree( $options, $exclusions, $page, $rootPage ){
 $this->iteration++;
 if(is_null($page)) $page = wire('page');
 if(is_null($rootPage)) $rootPage = wire('pages')->get('/');
 $ul_class = '';
 $ul_id = '';
 if($options['ul_class'] != '') $ul_class = " class='".$options['ul_class']."'";
 if($options['ul_id'] != '') $ul_id = " id='".$options['ul_id']."'";
 if($this->iteration == 1) $out = "\n<ul$ul_class$ul_id>";
  else  $out = "\n<ul>";
 $parents = $page->parents;
 if($options['show_root'] && $this->iteration == 1) {
  $children = $rootPage->children;
  $children->prepend( $rootPage );
 } else {
  $children = $rootPage->children;
 }
 foreach($children as $key=>$child) {
		$s = '';
		$level = ($child === $rootPage) ? 1 : count($child->parents);
		if($options['css_levels_on']) $class = " level-" . $level;
		else $class = '';

		$template = $child->template;
		if ( !in_array($template->name, $exclusions) ) {

		   if(!$key) $class .= " first";
		   if($key == (count($children) - 1 ) ) $class .= " last";
		   if($options['max_levels'] != null && $level >= $options['max_levels']) $stopit = true;
			  else $stopit = false;
		   if(!$options['collapsed']){
			  if($parents->has($child)) {
				 $class .= ($child !== $rootPage) ? " " . $options['css_parent'] : '' ;
			  }
			  else if($child === $page){
				 $class .= " " . $options['css_current'];
			  }
			  if($child->numChildren && $child !== $rootPage){
				 if(!$stopit) {
					$s = str_replace("\n", "\n\t\t", $this->_renderTree($options, $exclusions, $page, $child));
				 }
			  }
		   }
		   else
		   {
			  if($child->numChildren && $parents->has($child)) {
				 $class .= ($child !== $rootPage) ? " " . $options['css_parent'] : '' ;
				 if(!$stopit) {
					$s = ($child !== $rootPage) ? str_replace("\n", "\n\t\t", $this->_renderTree($options, $exclusions, $page, $child)) : '';
				 }
			  } else if($child === $page) {
				 $class .= " " . $options['css_current'];
				 if($page->numChildren && $child !== $rootPage) {
					if(!$stopit) {
					   $s = str_replace("\n", "\n\t\t", $this->_renderTree($options, $exclusions, $page, $child));
					}
				 }
			  }
		   }
		$class = substr($class,1);
		if(strlen($class) > 0) {
		   $class = " class='$class'";
		}
	 }  
	 $out .= "\n\t<li><a$class href='{$child->url}'>{$child->title}</a>$s</li>";
 }
 $out .= "\n</ul>\n";
 return $out;
}
}
  • Like 1

Share this post


Link to post
Share on other sites
Soma    6,126

Hey tnt, thanks for posting a modified version.

- That's a good addition to exclude page per template, it can make sense in the example with news pages. I will implement it as an option.

- Hehe, yes I'm not native english speaker, so I often use false words like "childs" instead of children. Thanks for pointing out.

- Your right the markup outputted could be improved, but I mostly use a web inspector anyway so that it wouldn't matter much.

- I'm not sure if I think about it, last and first is something that can be done more easy with css using li:first-child, li:last-child. And if implemented I would see it as turn on/off feature like the levels-. I don't want that outputted by default.

EDIT: Thinking about setting classes, I thought it way could make sense to have an option for where to put the item classes, either <a> or <li>.

EDIT: Oh and I would be good to may use github "fork" to then make a pull request so I could implement or merge additions. Or even easier, make a feature request. Same with bugs. It would help not having multiple version around, as people start copying your code and would may lose it after updating it with the github version.

Share this post


Link to post
Share on other sites
Soma    6,126

I made an update to the module. If you get the latest version you'll get new features.

Added support for custom selector:

Instead of adding more options to exclude pages, since PW is so open as to how to set up you pages/template stucture, I've implemented the option to specify a PW selector. So some of the power of it comes into play. (Remember it's always best-practice to sanitize values that may come from user input you can trust. This module doesn't do any)

You can for example hide page(s) with a certain or parent(s):

echo $tree->render( array("selector" => "parent!=1008|1002") ); 

And child pages from those parent will not be rendered.

Or if you want to exclude page(s) with certain template(s) you would do :

echo $tree->render( array("selector" => "template!=news-item|event-item") );

Or you could limit the items per level:

echo $tree->render( array("selector" => "limit=5") );

Added support for "first,last" class:

A new option that is off by default, that will output extra class to links. You can turn it on with the options "css_firstlast_on" set to true

array('css_firstlast_on' => true)

Minor changes:

Done some renaming and restructuring. Also removed some newlines in the markup output.

  • Like 2

Share this post


Link to post
Share on other sites
nikola    219

Hey Soma,

this is nice plugin, it will definitely simplify various navigation scenarios.

I've tried it and it works like a charm.

Thanks

Share this post


Link to post
Share on other sites
MadeMyDay    555

Hey Soma,

I am new to PW and just checking out the possibilities by reading hours in the forums before getting my hands dirty ;-) The navigation was on the schedule today and I like your module (also coming from MODX and looking for a wayfinder replacement). Your module seems to do more or less exactly what one needs for a navigation. But one (or two) suggestions: I would like to be able to define the output myself, because habits or requirements are different. Sometimes I need an additonal <span> somewhere or would like to use another field as title (or well, a title at all ;-) ) and so on. Since PW doesn't use any template or placeholder syntax I am not sure how to do so without hacking your module. Antoher example: the active class should be appended to the <li> element since this is the element which is active, not a child of it. I often need to style the <li> element and the containing <a> element as well. I your markup this is hard to accomplish, other way around it would be easy (you already mentioned an upcoming option for that). But as I said, requirements differ all the time and the most flexible solution would be to define the markup myself (or falling back to the standard output of course).

Thank you for your solution(s), I will try PW on a "real" project soon.

Share this post


Link to post
Share on other sites
Pete    3,387

Hi MadeMyDay - you might be better off just taking a look a the default head.inc template and changing the breadcrumb layout there if you want to do something quite a bit different.

I know how useful WayFinder was coming from MODx myself, but familiarising myself with the head.inc template file also helped me to learn the basics and I was off into the advanced stuff in no time.

That's not to knock Soma's module by any means as it's a good, quick way of getting navigation up and running quickly, but rather saying that PW is really easy to customise to do what you want with a fairly easy learning curve compared to full-blown PHP development.

Share this post


Link to post
Share on other sites
Soma    6,126

Hey MadeMyDay! Thanks for your post and inputs. As a modx user myself (not anymore) I certainly know Wayfinder, but found it a little too overhelming with way too many complicated options, so I've never used it to it's full power, also because the basic output was always enough.

Pete is right, if you want the ultimate flexiblity you would want to create your own nested function to output.

But I guess it also can get complicated depending on what you want to do. Generating a basic nested navigation is really easy using PW API, but I like to have some sort of tool that suites for most cases without getting into too much coding everytime. So having a module like I see as a nice way you can always rely on for fast implementation.

You're right that maybe best option would be to have classes appended to <li> element and not inner item. It will more easily allow for if you are styling <li> elements, but let's you as well style the inner element. The other way around it isn't possible. I'm always styling the anchor and not the list element as it is the most easy and reliable cross-browsers. That's why I implemented it this way. But it's now changed by default.

I understand that having a possibility to define custom markup will make it even more flexible and I was already planing to do anyway. Though with such implementation it's always the case that at some point you're still limited at best in some way or the other.

I already looked into it and found a easy implementation that will work and not having too much options. I just commited a major new update to github and updated first post to reflect changes. It let's you now define custom markup even with placeholders/tags for fields you want to output.

Just as an example you could do something like this:

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

'item_tpl' => '<img src="{icon}"/><a href="{url}">{headline|title}</a><p>{summary}</p>',
// {icon} any image field will be auto-recognized and return image url instead. {url} will output url to document. Any other field will output normally (assuming it's a textfield)

'item_current_tpl' => '<img src="{icon}"/><span>{title}</span><p>{summary}</p>'

I also renamed and removed some options with this update, so if you already using it, make sure you update your template code. Sorry for the inconvenience it may cause. But I think it is now better and will not change in future.

Changed:

'class_current' to 'current_class'

'class_parent' to 'parent_class'

'css_levels_on' to 'levels'

'css_firstlast_on' to 'firstlast'

Added:

'has_children_class' => 'has_children'

'levels_prefix' => 'level-'

'outer_tpl' => '<ul>||</ul>'

'inner_tpl' => '<ul>||</ul>'

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

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

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

Removed:

'ul_class' and 'ul_id'. Which now can be added via 'outer_tpl'.

While at it I also fixed a max level issue when using other root page than "/".

Thanks.

Share this post


Link to post
Share on other sites
MadeMyDay    555

Hi Pete,

yes, I already took at the head.inc template and the (one level) navigation is straightforward. But if dealing with more levels it gets a bit more complicated. Of course it is doable, but I think a navigation as unordered list is used on nearly every website so a module for it seems appropriate.

Hi Soma,

well... I am impressed! This is exact the way how I would do it ;-) Perfect! Im am eagerly looking forward to use it. I am MODX user since 6 years, but disappointed by the current development (extJS, slow manager, you all know it) and this chaotic business model. PW really seems to be as flexible and the roadmap is a dream (matrix thingie, draft mode, versions, form generator etc.). I think I will start an extra thread with some questions, nice to see MODXers here which then know what I am talking about ;-)

Greetings from Germany,

Marc

Share this post


Link to post
Share on other sites
Pete    3,387

Yup - a module is definitely easier when you get to recursive submenus. If you want something that will show a lot of pages with multiple levels of submenus it would be good to have the module cache the output (if t doesn't already).

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      hi everybody,
      this is a preview of a module that i'm working on for quite a long time. I needed it for an intranet office management application that i'm still working on. It makes it very easy to create very customized Datatables using the awesome jquery datatables plugin (www.datatables.net)
       
      EARLY ALPHA release!
      It's very likely that there will lots of changes to this module that may cause breaking your implementations.
       
      Module source
      sorry, removed as it changes too frequently; closed alpha - contact me if you think you can contribute
       
       
      Remarks:
      The module is intended to be used on the backend. Loading styles is at the moment only done via adding files to the $config->styles/scripts arrays. Also the communicaton to javascript is done via the $config->js() method that is built into the admin and would have to be implemented manually on frontend use. But it would not be difficult of course
      Installation:
      Nothing special here, just download + install
       
      edit: removed some parts, because i made a complete rewrite of the module! (see last posting in the thread)
       
      Customization example:
      in the screencast you see an example that i'm using in a process module. i put the table inside an InputfieldMarkup just to have the same look&feel all around the admin. you see that you could also use this module to create tables quickly and easily using @kongondo s runtime markup module.
      complete PHP code:
      $this->headline('Kundenliste'); $form = $modules->get('InputfieldForm'); // init datatables module $dt2 = $modules->get('RockDataTables2'); // setup columns // name $col = new dtCol(); $col->name = 'name'; $col->title = 'Name'; $col->data = function($page) { return $page->title; }; $dt2->cols->add($col); // type $col = new dtCol(); $col->name = 'type'; $col->data = function($page) { return $page->rockcontact_type->title; }; $dt2->cols->add($col); // modified $col = new dtCol(); $col->name = 'modified'; $col->data = function($page) { $obj = new stdClass(); $obj->timestamp = $page->modified; $obj->display = date('d.m.Y', $page->modified); return $obj; }; $dt2->cols->add($col); // setup table $dt2->id = 'dt_kundenliste'; $dt2->js('/site/modules/ProcessRockProjects/dt_kundenliste.js'); $f = $modules->get('InputfieldMarkup'); $f->value = $dt2->render(); $form->add($f); // ################################## // ajax request -> return data // non-ajax -> render form + table // ################################## if($config->ajax) { echo $dt2->getJSON($pages->find('template=rockcontact, sort=random, limit=10000')); die(); } else $out .= $form->render(); return $out; what is interesting here is this part:
      // modified $col = new dtCol(); $col->name = 'modified'; $col->data = function($page) { $obj = new stdClass(); $obj->timestamp = $page->modified; $obj->display = date('d.m.Y', $page->modified); return $obj; }; $dt2->cols->add($col); datatables support orthogonal data (https://datatables.net/extensions/buttons/examples/html5/outputFormat-orthogonal.html). a date column is a good example, because you need to DISPLAY a formatted date (like 10.02.2017) but you need to be able to SORT this column by a different value (timestamp). its very easy to accomplish this by providing both values in your json. Btw: You could also just transfer the timestamp and do the formatting on the client-side via javascript. Next Example will show ho this would work. Both cases can be necessary, it's just an example here.
      [...] removed
      Why i created this module:
      of course i know @Soma s module but i needed a lot more features and the newer datatables version. also i like to define all the columns as objects and have everything on one place. lister & markupadmindatatable: nice for basic tables but lacks of features to modify the appearance of the cell values (like rendering icons, background colors and so on) datatables provides a great frontend API for filtering, showing/hiding columns, getting data, modifying it... it also plays well together with frontend charts like google chart api in this case:
       
      todo / roadmap:
      all kinds of column filters (like seen in the example above that shows an older and bloated version of this module) support for ajax filters and pagination (currently all filtering and sorting is done on the client side. i tried it with up to 50.000 rows and got reasonable results. initial loading took around 10sec. but of course this heavily depends on the complexity of your table and your data.  
       
       
    • By Robin S
      PageListTrash
      Allows non-superusers to trash pages directly from Page List (if they have page-delete permission for that page).
      Not much to say really - the module adds a "Trash" option to the extra actions for pages in Page List. It looks and works just like the Trash action available to superusers.

      https://github.com/Toutouwai/PageListTrash/
       
      Up to you whether you think non-superusers should be trusted with simpler trashing. For most cases I like the default behaviour where editors have to jump through some more hoops - I want them to think carefully about what they are doing. But if an editor needs to trash several pages then this module might reduce frustration.
      @tpr, by now you can probably predict what I'm going to say...
      ...something to merge into AdminOnSteroids?
    • 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.2.5
      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; } 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


      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 celfred
      Hello,
      I'm desperately trying to update my website to PW 3.0.62 and I'm facing issues to to module compatibility. I was stuck with Pages2Pdf which I managed to solve bu updating the module from Github, but now it's the Pages Web Service module... and this time, I don't know wht to do
      The Module is found there. But it is quite old and I can't find it in the modules catalogue... and my site is making quite a use of it (I can't think of a way to do otherwise, sorry...)
      After adding the FileCompiler=0 to the module pages, the error I'm stuck with is :
      Fatal error: Class 'WireData' not found in /home/celfred/PlanetAlert/site/modules/ServicePages/ServicePages.module on line 22
      and I have no idea on what to do... I must admit I'm not a programmer but a middle-school teacher... (for your information, here's the site I'm talking about : http://planetalert.tuxfamily.org ) but I'm struggling hard to solve the different issues I have to face and I'm wlling to understand things. I have just spent many hours trying to make 2.8 work on my localhost (and it seems ok ) but I'd like to switch to 3.x to prepare the future
      If anyone had the will to spend a few minutes to try and help me, I would greatly appreciate.
      Thanks in advance !
      If you need more information to understand my problem, feel free to ask.
    • By dimitrios
      Hello,
      I have created a module that, given a Facebook app ID and secret, posts on Facebook on behalf of a user profile or page after a PW page is saved.
      This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates On/Off switch: specify a checkbox field that will not allow the post if checked Specify a message and/or an image for the post
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, a token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is used.