Jump to content
ryan

Hanna Code

Recommended Posts

Agreed, this is a problem for anyone using CKEditor together with Hanna Code. Entities config setting seems like a good solution, at least I'm not aware of any serious drawbacks to that.

There's another option (config.basicEntities) for things like <, > etc. which could be potentially harmful if left unescaped. We're talking about HTML markup here, after all. If I ever needed to use comparison operators as parts of Hanna Code variables, I'd probably let CKEditor escape them and then handle decoding in the code snippet with str_replace() or html_entity_decode().

If you're wondering what these config settings can cause, I'd suggest taking a look at CKEditor source. There you can see a list of all entities separated to couple of different variables; htmlbase is only affected by config.basicEntities while encoding all the others (entities, latin, and greek) is going to be disabled if you set config.entities to false. 

Share this post


Link to post
Share on other sites

@Teppo - thanks again for your help and comments  - yeah i should definitely go with the basicEntities and decode in Hanna.. will try asap and report back...

Share this post


Link to post
Share on other sites
I recently debugged similar issue and eventually found out that it was caused by CKEditor encoding " to " (default behavior) before Hanna Code had a chance to grab it. Similar issues could be caused by other editors, textformatters placed before Hanna Code etc.

It might make sense for Hanna code's parser to just allow " as an allowed attribute container, in the same way it does unencoded quotes? I'm happy to implement this change if you guys think it would solve the issue without creating other problems (I can't think of any at the moment). 

Share this post


Link to post
Share on other sites

Yes! that would be great! - seems the only reliable way to use HC with an editor? otherwise you'd have to adjust the config settings per the above conversation...

Share this post


Link to post
Share on other sites
Yes! that would be great! - seems the only reliable way to use HC with an editor? otherwise you'd have to adjust the config settings per the above conversation...

Strangely I've not ever run into this issue, and I guess it just depends on whether the editor is entity encoding quotes or not (it looks like CKEditor does not entity encode quotes, so no problems with Hanna code). I've gone ahead and added support for " entity encoded quotes to the latest version. 

Share this post


Link to post
Share on other sites

for some reason both times i was using ckeditor and i had to either decode entities in the hanna code or change the ck editor config...

Share this post


Link to post
Share on other sites

I've just tried using it to input something from rafflecopter into my post but it does not seem to work correctly. The code from rafflecopter is:

<a id="rc-603abd0" class="rafl" href="http://www.rafflecopter.com/rafl/display/603abd0/" rel="nofollow">a Rafflecopter giveaway</a>
<script src="//d12vno17mo87cx.cloudfront.net/embed/rafl/cptr.js"></script>

but when I add to hanna code and insert the tag into my post, nothing shows up. I've selected javascript as the options as well.

Share this post


Link to post
Share on other sites

i see htmls in there

sholdunt u.use html as mode ?

their is no javascripts here

just html script link to javascript

tl;dr use.html mode

  • Like 2

Share this post


Link to post
Share on other sites

Just to follow up here in case anyone else ever runs into something similar: WillyC was correct about the issue here. It just needed to be an HTML HannaCode rather than a javascript one. 



Also wanted to mention I've posted an update to HannaCode, version 0.1.4 which fixes a couple of bugs having to do with the Ace editor. It fixes the issue where extra whitespace was getting inserted at the end of the code. It also fixes the issue where Ace sometimes wasn't active after doing a 'save & test'. 

  • Like 1

Share this post


Link to post
Share on other sites

This I almost feel like i'm building my own CMS when I use this module it is so easy! + awesome. 

Idea: it could be cool but not totally necessary of Hanna supported shorthand single arguments for easy to remember usage. ie. [[block=myblock]]  rather than [[block title=myblock]. Just idea to shorten hanna codes by a few character and make them easier to remember.  if you have an attribute that matches the name of your Hanna code it could work that way...

question: is it possible to render hannacode inside of hanna? so far I have not been able to do it, even by calling a new instance of Hanna: 

<?php

//my Hanna block
$mypage = $pages->get("/settings/blocks/".$title);
$block_hanna = $modules->get('TextformatterHannaCode'); 
echo $block_hanna->render($page->body); 

/* 
This does no seem to work as planned. 
It currently returns nothing: and breaks my existing Hanna codes.  Also does not work if I use an existing 
instance of hanna i call from my template which would look like this: echo $hanna->render($page->body); 
*/
?>

I might just be a Hanna obsessed and should chill-out with with that I want it to do, and find other ways. The main reason i'm running into this is that I am using hanna to build my css grids and call the the [[blocks]] of hanna formatted feilds from other hanna formatted fields. 

[[grid_start col=8 ]]
My left column body content
[[grid col=4 col_class=print]]
my right column content
[[block title="load my hanna formatted field"]]
[[grid_end]]

I might have been able to accomplish this all with repeaters rather than using hanna, but I liked the freedom Hanna offered.

Share this post


Link to post
Share on other sites

@Neeks,  your suggested idea sounds kind of fun, but also not very useful. [[block=myblock]] would be equal to [[myblock]], except that you'd have a lot of your "blocks" within one single Hanna Code.. which is exactly what individual Hanna Codes are meant for.

About your question: in your example code you're assigning /settings/blocks/".$title to $mypage and later asking Hanna Code to render $page->body -- while you probably meant to render $mypage->body. Is this just a typo in your example code here or could this be the issue with your original Hanna Code?

Anyway, even if this can be fixed, wouldn't it make more sense to have a [[block type=something' title='something else]] Hanna Code that finds a page (let's call it $block_page) and then renders it with $block_page->render(), i.e. by using ProcessWire's full template system? Is there a particular reason why you're trying to move your template level stuff into Hanna Codes?

I'm afraid that's not really what Hanna Code was intended for, at least as far as I'm aware. Hanna Codes are snippets you can drop in your code -- once you find yourself building complex logic with them, you'd probably be better off by using other PW features instead  :)

  • Like 1

Share this post


Link to post
Share on other sites

Strangely I've not ever run into this issue, and I guess it just depends on whether the editor is entity encoding quotes or not (it looks like CKEditor does not entity encode quotes, so no problems with Hanna code). I've gone ahead and added support for " entity encoded quotes to the latest version. 

@ryan: that definitely is strange, considering that with default config CKEditor encodes everything it possibly can; even single quotes get encoded per the entities_additional default value. Perhaps you've modified the config already? :)

Anyway, my solution for this (and most CKEditor issues I've been dealing with) was simply adding config.entities = false to CKEditor's config.js. As you can see from CKEditor source, so-called base HTML entities (nbsp, gt, lt and amp) still get encoded, making this a very good default. As long as we're dealing with UTF-8 data, there shouldn't be any reason to encode everything.

This also prevents issues such as search not working properly with Scandinavian characters ä/Ä, ö/Ö etc. Sure, searching from CKEditor fields is possible even with default config, but how many users would really try something like "Väinö" when they want to search for "Väinö"? Of course encoding search queries would be doable, but that would mean searching with both encoded and non-encoded versions.. :)

As a matter of fact, I would like to suggest this as the default value for upcoming Inputfield CKEditor releases, unless someone knows of some terrible security issue this introduces.

Edit: by the way, I do realize that the default config is much less of a problem for English speakers than us who have to deal with Scandinavian characters, umlauts etc. regularly. Still, it becomes a problem for just about everyone once they try to create multilanguage sites and/or use modules like Hanna Code, which is essentially why I believe that this would make sense as a default.

Edited by teppo

Share this post


Link to post
Share on other sites

Teppo, the way you describe the entities config option, that makes sense to me. Given these issues, I wonder why they have it true by default. I have updated the InputfieldCKEditor module to have the entities option set to false by default. I really can't think of any security issues with doing that, especially given that we're requiring HTMLPurifier for the inline editor. As for why I seem to be getting the entities=false behavior for quotes already, I have no idea. Maybe something to do with HTMLPurifier and inline mode vs. regular mode. 

Share this post


Link to post
Share on other sites

Just a little tip when working with hanna code.

I for some project prefer to have the code on file system and not db.

This can be achieved simply by including the php file in the hanna code.

For example a Hanna code:

include($config->paths->templates . "hannas/archive.php"); 

And have your Hanna code in archive.php.

  • Like 6

Share this post


Link to post
Share on other sites

Hanna Code doesn't actually execute from the DB. It writes each Hanna code to a file in /site/assets/cache/HannaCode/ and then uses the DB copy of the code to compare against the one on the file system, to make sure something hasn't changed the one on the file system. It executes the PHP code from a file in order to ensure it is as fast as possible (avoiding eval) and in the same context as a template file. That's what it does behind the scenes, but Soma's tip is just as useful either way, as Hanna Code wouldn't let you edit its own PHP files directly. 

  • Like 4

Share this post


Link to post
Share on other sites

I just noticed that the complete ACE editor is bundled with TextformatterHannaCode. Wouldn't it be nice to make it a separate js module and use it if it's installed? Also there's already a ACE editor fieldtype from Adam. Since ACE editor source comes with 1million! files I think it would be the way to go. Much like jQueryDataTables or Magnific etc.

  • Like 2

Share this post


Link to post
Share on other sites

I've just been playing around wit Hanna code for the first time, pretty cool. I think i might have discovered some bugs, or at least an error/omission in the instructions.

If you make a Hanna code with a hyphen in it and you then use parameters the Hanna code doesn't get executed. Given the example Hanna on https://github.com/ryancramerdesign/ProcessHannaCode:

if(isset($parent)) {
  // If $parent is an ID or path, lets convert it to a Page
  $parent = $pages->get($parent);
} else {
  // otherwise lets assume the current page is the parent
  $parent = $page; 
}

foreach($parent->children as $child) {
  echo "<p><a href='$child->url'>$child->title</a>";
  // echo "<p><a href='$child->url'>$child->body</a>"; does not work as i expected, it only outputs the last child->body instead of foreaching over them
}

// below is used in the body field of a fresh install from dev  2.3.15

[[menu_items]] //this works
[[menu_items, parent=1006]] //this works
[[menu-items]] //this works
[[menu-items, parent=1006]] //this does not work, it doesn't execute and just displays the literal text

Also, in the example above, if i echo $child->body the Hanna code stops working. It's looks like echoing $child->body from the body field of a parent does not work, or at least not in the example above.

Maybe this is all for obvious reasons but it took me a good while with trial and error to figure out. All tested with PW dev 2.3.15, Hanna 0.1.5 on a Win7 machine.

Share this post


Link to post
Share on other sites

Probably I'm missing something simple, but the $page variable doesn't seem to be referring to the page where the field including the HannaCode is, as the doc says:

 The $page API variable available to your Hanna code represents the page where the Hanna code exists. It is possible for this to be different from wire('page'), which represents the page that originated the request.

For example, I have a very simple code [[files_url]] to get the files directory url from a text fiel in a page:

echo $config->urls->files . $page->id . "/";

It's used for referencing page images or file from a "body" field:

<img class="video-image" onclick="play_video('NxgHAktpdF8')" src="[[files_url]]an_image.jpg" /> 

When using this code in a "body" field in page $article_page, referenced from the currently displayed page wire("page") like this

function renderArticle($article_page) {
   //...
   $out .= $article_page->body;
   //...
   return $out;
}

echo  renderArticle($article_page); 

the page id in the html page is the wrong one, i.e. the one from  wire("page") and not the article_page's id.

To clarify, here is what I get:

echo $article_page->id;
=> 1048

echo wire("page")->id;
=> 1041

echo $article_page->body
=> <img class="video-image" onclick="play_video('NxgHAktpdF8')" src="/site/assets/files/1041/an_image.jpg" />

Which causes an image-not-found error, as the expected result should have been:

echo $article_page->body
=> <img class="video-image" onclick="play_video('NxgHAktpdF8')" src="/site/assets/files/1048/an_image.jpg" /> 

I'm running version 2.3.15 from dev branch.

So bug or expected behavior? And any idea of how to make it work?

(For such a simple use case I could of course do some kind of string replacement in my template, but I would prefer to stay with HannaCodes for regularity if possible  :) ) 

Edited by jean-luc

Share this post


Link to post
Share on other sites

I read your Post atleast 5 times, But I really don't understand what you're asking.

Ok. I've tried to clarify it in the original post.

Share this post


Link to post
Share on other sites

The page that originated the request is meant the one that is rendered, and that's not your article page.

wire("page") or $page is the requested page, so doing echo $someotherpage->body won't give the hanna code on this body the $someotherpage but $page.

You would need to set the page in this case to the one you get the body from and set it back after to make it work in this case.

Something like this should work:

function renderArticle($article_page) {
    // ...
    $current_page = wire("page");
    wire()->set("page", $article_page);
    $out .= $article_page->body;
    wire()->set("page", $current_page);
    return $out;
}

Share this post


Link to post
Share on other sites

The page that originated the request is meant the one that is rendered, and that's not your article page.

Agreed: my article page is the page containing the field where the Hanna code exists.

That's why the behavior I observe don't look consistent with HannaCode module's documentation saying:

 The $page API variable available to your Hanna code represents the page where the Hanna code exists. It is possible for this to be different from wire('page'), which represents the page that originated the request.

And this behavior  would be great by the way, because this is probably what you expect when putting a Hanna code in a page field.

Thanks anyway for the suggestion. I will try it.

Share this post


Link to post
Share on other sites

Ah sorry I haven't really ever read the docu that far, seems like a bug cause I see code in there that sets $page to context specific. But I can't get it to work and it's always the same wire("page") and $page. 

I also noticed some strange behavior when using wire()->set("page", $somepage); and then use $page. So Ryan might have a look into this.

For example this code in a template

$p = wire("page");
wire()->set("page",$pages->get("/"));
$content .= "p1: " . $page->id;
wire()->set("page",$p);
$content .= "p2: " . $page->id;

is different as this:

$p = wire("page");
wire()->set("page",$pages->get("/"));
$content .= "p1: " . wire("page")->id;
wire()->set("page",$p);
$content .= "p2: " . wire("page")->id;

when used in a template for example basic-page.php.

Share this post


Link to post
Share on other sites

This turned out to be an issue with the order of variables returned by core TemplateFile::getArray. It was doing an array_merge which gave preference to API variables, preventing them from being overwritten. Maybe that's a good thing in general, but I don't think we want that limitation. I went ahead and changed it in dev. Now it gives preference to local variables, which enables Hanna Code to provide the behavior it was supposed to. 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks Ryan. I tested my $article_page case with the last dev version and it works just as expected now.

This really opens a huge potential for Hanna code regarding cross-fields referencing in a page independently of the rendering context.

  • Like 1

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 tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • 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
×
×
  • Create New...