Jump to content
kongondo

Menu Builder

Recommended Posts

We'll that's strange...I thought I had dealt with this.....Old code must have crept in. I'll look into it, thanks for reporting.

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

No need for the HTML builder :-)....for the <ul, it's just a missing space I forgot to put back after switching to configurable menu wrapper and for the <li> just a space to trim...I'll update tonight...

I guess I'm just a sucker for clean code.  ;)

Share this post


Link to post
Share on other sites

Just a thought and I am not sure how much this is needed but I am thinking about rendering breadcrumbs and wondering what would be the best way to render breadcrumbs based on the menu structure. Maybe I didn't think about it enough but there seems to be a possibility of complications rendering breadcrumbs when the menu structure is different to page structure.

Is there some way to have a feature whereby breadcrumbs could be output based on the menu structure with of course homepage being one step higher in the hierarchy of pages that are on the same level.?

Hmm, interesting thought. Technically, it is not impossible - just a recursive function that only grabs one branch...I'll have think...

Share this post


Link to post
Share on other sites

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

I guess I'm just a sucker for clean code.  ;)

I'm all for clean and valid HTML too...What I meant is that I forgot to put back a space when I went from this <ul to this <$wTag.....bundling a third-party PHP class just to deal with that seems like an overkill :-)

Share this post


Link to post
Share on other sites

I'm all for clean and valid HTML too...What I meant is that I forgot to put back a space when I went from this <ul to this <$wTag.....bundling a third-party PHP class just to deal with that seems like an overkill :-)

Yeah, I figured that. Just mentioned it because of the general output. To me, it isn't overkill if it's to be used to enhance everything the module outputs. Much the same way I used ParseCSV in Jumplinks - I wanted the flexibility it provides, which enhances the experience.

:-)

Share this post


Link to post
Share on other sites

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

Aaah, ye that's it. It works fine in dev branch. Please test and let me know? Thanks. I tested thoroughly with different combinations of multiple classes. I want to merge to master later today.

Share this post


Link to post
Share on other sites

I downloaded this archive, and it's still sticking ul and class together, unless I use an id.

Using 

<?= $modules->MarkupMenuBuilder->render('main', array('menu_css_class' => 'navigation')); ?>

Result:

<ulclass ="navigation">
<li  ><a  href='/'>Home</a></li>
...
</ul>

Edit: Culprit seems to be line 185 of MarkupMenuBuilder on in the archive I grabbed.

$cssMenuClass = $options['menu_css_class'] ? 'class ="' . $options['menu_css_class'] . '"' : '';

Share this post


Link to post
Share on other sites

Thanks, will fix soon. As for the <li>, it works fine for me...are you seeing that extra space (as in your code above...)?

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, will fix soon. As for the <li>, it works fine for me...are you seeing that extra space (as in your code above...)?

The code is as I pasted it.

post-2289-0-60312500-1426615972_thumb.pn

(Except the ul thing, which I changed.)

Share this post


Link to post
Share on other sites

Update: version 0.0.5

  • Fixed markup errors reported above in MarkupMenuBuilder
  • Merged version to master (updated in modules directory as well)
Edited by kongondo
  • Like 3

Share this post


Link to post
Share on other sites

Hmm, interesting thought. Technically, it is not impossible - just a recursive function that only grabs one branch...I'll have think...

Great. Would be cool to have this feature.

Share this post


Link to post
Share on other sites

Very nice, a must-have. Thanks!

May I ask what admin theme was used on the screenshots? Looks pretty sharp but cannot find anywhere.

  • Like 1

Share this post


Link to post
Share on other sites

@tpr,

Thanks.

They are all part of the admin themes that natively ship with PW. In the first couple of screenshots, that's AdminThemeReno, followed by AdminThemeDefault using the color set 'Futura' and last screen the color set 'Warm'.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, I got it now. It was the Reno theme, it has to be installed first to use. Have to do some PW development soon to get back to PW basics :)

Share this post


Link to post
Share on other sites

Update: version 0.0.6

In dev branch for now

  1. As per this idea, thanks @dazzyweb, added a renderBreadcrumbs() method to render, uh..., breadcrumbs. See documentation in Read Me for how to use
  2. For both render() and renderBreadcrumbs(), you can also pass a Page object as the first parameter. This is in addition to the already available ways, i.e. you can also pass a menu page's title, name or id or an array of menu items built from a menu page's menu_items field.

Please test and let me know, especially playing around with the options you can pass renderBreadcrumbs(). See Read Me, including comments in the code. These options can be shared between the above two methods. Same goes for the first parameters - e.g. get a menu page and pass that once to both render() and renderBreadcrumbs(). Also added the option to prepend 'Homepage' as topmost breadcrumb item even when it is not ancestrally part of the breadcrumb.

Note

If you call renderBreadcrumbs() in a page that is not part of the menu items you will get an error if logged in as superadmin but nothing returned for all other users. E.g., say you have the following menu items:

Home
About Us
Products
Services
Contact Us

renderBreadcrumbs() would only work (duh!) if called from the template file of AND viewing one of those pages. This is because the method works by first matching the 'pages_id' of a menu item with the $page->id (current page) and builds the breadcrumb from that.

External menu items can be part of the breadcrumb as long as they are not the current item (of course) - which they can never be anyway since clicking on them will load external URLs

  • Like 3

Share this post


Link to post
Share on other sites

Thanks kongondo, seems to work fine but I have one or 2 queries or suggestions for a couple of issues I have.

There are times when it would be useful to display breadcrumbs for pages that are not in the main header menu created. Do you think there is a way around this with some kind of option?

So as a simple example if we have the following menu created with Menu builder:

HOME

ABOUT

-who are we?

-Our history

FAQ

CARS

CONTACT

ABOUT page would have children in the menu created and work fine with the renderBreadcrumbs method.

'CARS' would have 50 children in the page tree but I might not want to show these children as a sub menu so they would not be included in the menu created but I might still want to show breadcrumbs if going to the page 'Audi' or 'Jaguar' such as Home / Cars / Jaguar which could have been accessed from some different link or list.

Do you think it is possible to have some kind of option whereby the breadcrumbs or normal render method  recognises the children of the 'CARS' page in the normal pages tree without actually having them in the menu created by menu builder?

Another point connected with this is if I am at the page Jaguar (Home / cars / Jaguar) it would be useful with the normal menu render method to be able to still add a 'current' class to 'CARS' in the menu so it could still be highlighted as the parent page even though the page Jaguar is not in the menu created with menu builder. It would also be useful to be able to add a 'current' class to ABOUT page when viewing sub pages of the ABOUT page which are in the menu created by Menu builder.

Share this post


Link to post
Share on other sites

@dazzyweb,
 
OK, I might have found a way to achieve both of these. Although I think it is possible to include intermediate natural parents (i.e. PW parentage) that are also not in the breadcrumbs, I think I will stick to immediate parent only. Same goes for the 'current' class. What I mean is this....let's say your 'jaguar's had child pages as well, maybe 'model A', 'model B', etc., that are also NOT part of the MB menu, following your request, you would something like this: Home / cars / Jaguar / Model A. The problem I foresee is what if an intermediate parent was part of the MB menu but not in a 'natural' position? I we were to include it in the breadcrumbs, it could end up in the wrong position (from the breadcrumbs point of view). I hope this makes sense and maybe this is an edge case. Anyway, unless convinced otherwise, I am limiting this to the immediate parent, e.g. Home / cars / Jaguar /. Thoughts?
 
Edit:
 
No, scratch that. I'll make the depth to which one wants to display non MB items that are natural children of the current MB item configurable, e.g. 

append_child => 0//default - no child appended = Home / Cars
append_child => 1// append the immediate child = Home / Cars / Jaguar
append_child => 2// append immediate child and grandchild
etc...

Beyond that...how you structure your menus is up to you :-)

Edited by kongondo
Changed mind...
  • Like 1

Share this post


Link to post
Share on other sites

Another thought I have of doing this is the following though I am not sure if there are any complications making this.

What if each separate page added to the menu had an option added to it in the menu builder(where title, url, css options are etc..) such as 'include this pages natural children from page tree' with a second option with it with a yes/no to display children in normal render method? The breadcrumbs could then normally display all levels as the pages would be included in the built menu with the option of not displaying with the normal render method if not wanted there.

This could actually be useful in other ways as well if normally wanting to include natural children under a page without actually having to manually put them all there especially if there are many.

If this is set up in such a way whereby all natural children are included such as the way a selector works then I assume when adding another page as a child in the normal page tree that it would then be included as well automatically in the menu builder if set up such a way. This could be quite useful making the menu builder much more flexible.

  • Like 1

Share this post


Link to post
Share on other sites

I think your 'another thought'  is a better approach since it allows for more granularity, i.e. it targets individual menu items rather than the first approach which targets the whole menu in terms of including natural child pages. I don't think there is a need for the second option 'yes/no' though unless am not getting it? By using the 'include natural children' option, you imply that you want them to be displayed. 

The way I think I'll do it:

'include_children' => 0//default = no
'include_children' => 1//yes, but only in menu, i.e. render()
'include_children' => 2//yes, but only in breadcrumbs, i.e. renderBreadcrumbs()
'include_children' => 3//yes, in both

//number of child nesting levels to show IF include_children > 0
//include_children_levels => 1//default, i.e. show only immediate children [or child in case of breadcrumbs]
//include_children_levels => 2//etc....show up to grandchildren/grandchild, etc..

The include_children can be tricky though....One might end-up with lots of sub-menus! But this is is optional, so up to the developer really.

Apart from some coding issues I may not have thought of yet, the visual MB aspect has to be considered. Those natural child pages will not be included in the saved menu items, hence will not be displayed in the menu tree in the back-end (ProcessMenuBuilder). They will only be included in the front-end output during runtime. That may confuse your editors, but nothing you can't educate them about, and this is optional anyway.

Edit:

Or...in the spirit of flexibility and granularity....in MB admin, also add an include_children_levels text (int) box next to an include_children checkbox. Then in the front-end, render() and renderBreadcrumbs() will be guided by:

if the setting include_children_levels is empty AND you have an $options = array ('include_children' => xx,  'include_children_levels' => zz), the level set in $options takes precedence and is applied overall except for menu items where the setting include_children_levels is NOT empty; an explicit level set at menu item level will override any $options setting. Would such a workflow work for you?

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

I don't think there is a need for the second option 'yes/no' though unless am not getting it? By using the 'include natural children' option, you imply that you want them to be displayed. 

Yes but sometimes not displayed in the main menu but only breadcrumbs.

The yes/no option was to give flexibility for the editors so that a choice could be made on whether to have the children displayed with the 'normal render method'(in main menu for example) or not for each page that has children. Since there can be times when I don't want them displayed on the main menu(only in breadcrumbs) and this option can be different for each page added in the menu builder. In the example I made before the car brands would not be shown in the main header menu but would be shown in breadcrumbs so option chosen would be set to 'NO'. The about page would have option set to 'YES'(which would be default) so the children of about page would be displayed in the main menu and breadcrumbs.

Choosing to 'include natural children' and 'YES' would include the children in both normal menu and breadcrumbs, choosing 'NO' would only include in breadcrumbs. Having this option with each page(menu item) enables each page added to the menu to have different options if they are displayed in main menu or not.

Maybe I am not understanding the 'include_children' option fully but wouldn't this then end up overriding all the options chosen for each individual page(menu item) by the admin for the normal render method(main menu)? This would then disable the ability to have one page on main menu displaying it's children and one page in the menu not displaying it's children.

Apart from some coding issues I may not have thought of yet, the visual MB aspect has to be considered. Those natural child pages will not be included in the saved menu items, hence will not be displayed in the menu tree in the back-end (ProcessMenuBuilder). They will only be included in the front-end output during runtime. That may confuse your editors, but nothing you can't educate them about, and this is optional anyway.

That's fine, I think that is the best way anyway since if there were many children it could make the menu builder quite crowded & unworkable. This way would actually make it much cleaner to use.

Share this post


Link to post
Share on other sites

Ah, I see (see also my edited posts above). Your yes/no is targeted at editors whereas my include_children with its options is targeted at developers. Giving editors the choice makes more sense and I'll adapt that instead. So, just to make sure we are on the same page:

  1. Editors control inclusion of natural children (default is exclude - this setting is not saved)
  2. Editors control whether natural children are shown in menu or breadcrumbs or both (This can a set of 3 radio buttons - any selection also implies include children; no selection implies don't include - or I could add a fourth button but it's already crowded in that menu setting as it is!! if one wants to edit the setting. No, better yet, I'll use a drop-down with 3 options - 'menu', 'breadcrumbs', 'both'. No selection = default and means 'don't include natural children')
  3. Editors control this per menu item (i.e. per PW page)

What do you think about my levels question though? Sticking to immediate children is pretty straightforward. Do you see a need for grand-children? This is more relevant for breadcrumbs, e.g. if you wanted Home / Cars / Jaguar / Model X where both 'Jaguar' and 'Model X' were not part of a MB menu...

Share this post


Link to post
Share on other sites

Ah, I see (see also my edited posts above). Your yes/no is targeted at editors whereas my include_children with its options is targeted at developers. Giving editors the choice makes more sense and I'll adapt that instead. So, just to make sure we are on the same page:

  1. Editors control inclusion of natural children (default is exclude - this setting is not saved)
  2. Editors control whether natural children are shown in menu or breadcrumbs or both (This can a set of 3 radio buttons - any selection also implies include children; no selection implies don't include - or I could add a fourth button but it's already crowded in that menu setting as it is!! if one wants to edit the setting. No, better yet, I'll use a drop-down with 3 options - 'menu', 'breadcrumbs', 'both'. No selection = default and means 'don't include natural children')
  3. Editors control this per menu item (i.e. per PW page)

Looks good

What do you think about my levels question though? Sticking to immediate children is pretty straightforward. Do you see a need for grand-children? This is more relevant for breadcrumbs, e.g. if you wanted Home / Cars / Jaguar / Model X where both 'Jaguar' and 'Model X' were not part of a MB menu...

Would be good to have levels and I can see a need for grand-children sometimes.

I think that levels could be useful as well for the main menu at certain times when using include_children so as to limit the amount of levels shown for example in a drop down menu. But then the levels needed to be shown in main menu could then differ to the amount needed for breadcrumbs so would maybe need different include_children_levels for main menu and breadcrumbs.

Or...in the spirit of flexibility and granularity....in MB admin, also add an include_children_levels text (int) box next to an include_children checkbox. Then in the front-end, render() and renderBreadcrumbs() will be guided by:

if the setting include_children_levels is empty AND you have an $options = array ('include_children' => xx,  'include_children_levels' => zz), the level set in $options takes precedence and is applied overall except for menu items where the setting include_children_levels is NOT empty; an explicit level set at menu item level will override any $options setting. Would such a workflow work for you?

So an options default would be set to all menu items in one swoop and then can be tweaked at admin level? It is an interesting thought. The more I think about it the more I see it could come in handy.

Share this post


Link to post
Share on other sites

Would be good to have levels and I can see a need for grand-children sometimes.

I think that levels could be useful as well for the main menu at certain times when using include_children so as to limit the amount of levels shown for example in a drop down menu. But then the levels needed to be shown in main menu could then differ to the amount needed for breadcrumbs so would maybe need different include_children_levels for main menu and breadcrumbs

OK, we should have these separate...I need to reiterate that MB will not control the number of such children to show at any level.....although I want to leave that to the developer (or editor?), I may need to limit maximum number of pages returned in that 'find'. I imagine a situation where an editor working on some other part of the site inadvertently adds tens of child pages (e.g. under CARs and under Jaguar, etc...)...Coupled with a levels of say 3, you suddenly end up with 3 x XX number of pages to find for one or more menu items! Can easily chock memory...Not sure how to implement this at the moment...maybe make it configurable at developer (template file) level...something like max_children at each level...

So an options default would be set to all menu items in one swoop and then can be tweaked at admin level? It is an interesting thought. The more I think about it the more I see it could come in handy.

Exactly...would save you a few clicks...

Edit:

Below is how I envisage the order of priority of $options (API/template file) setting vs. admin-level settings. There's 4 possible admin-level settings for each menu item in respect of whether to show its natural children. Show in: (1) Menu (2) Breadcrumbs (3) Both (4) Never. In addition there's the number of levels to show in respects of choices 1-3.

Desc order of priority for final display

  1. $options = array('include_children' => 0)//overrides everything set at admin level. No natural children displayed anywhere
  2. Any explicit admin-level setting: 1- 4//Natural children displayed/not displayed as per choices 1-4 FOR ONLY THIS menu item irrespective of what is set in $options (apart from a '0' setting as shown in point #1 above)
  3. $options = array('include_children' => 1|2|3)//overrides ONLY EMPTY admin-level settings: Show natural children of all items without an admin-level setting ONLY in menu [1] (render()) OR breadcrumb (renderBreadcrumbs()) [2] OR both [3]
  4. Empty admin-level setting: no natural children displayed anywhere
Edited by kongondo
order of priority description
  • Like 1

Share this post


Link to post
Share on other sites

Is it possible to use this in a Multi Language Site.

Tried to use it, but in the menu title I get Array and in the outputs as well, it outputs Array, instead of the menu title. When changing language it buts.

Thanks in advance.

Share this post


Link to post
Share on other sites

@bbeer,

No, it's not multi-lingual in that sense. The reason you see an array is because the various titles (in the different languages you have installed) are held in an array. When saving, since I have not implemented ML support, PW does not know what to save. That is what I am assuming. I have never worked in a ML site before so this is new to me too. I am looking into it. I'll ask in the forums (Soma probably will pick it up :-)). So far my searches have come empty, i.e. how to save a field (in this case a page title) in a ML environment. Hopefully I'll find an answer here: https://processwire.com/api/multi-language-support/multi-language-fields/

Edited by kongondo

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 robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...