Jump to content

Recommended Posts

Any plans to pull in a users Gravatar based on their email address? Just like these forums do?

I built some very basic Gravatar functionality into a bigger (site-specific) module recently - please feel to use it: Gravatar.module gist on Github

  • Like 1

Share this post


Link to post
Share on other sites

Actually FieldtypeComments already has built in support for Gravatar. Never tried it though and don't know how to use it. I have looked at the code but can't figure this out. I also don't have a Gravatar account so can't test anyway. Anybody knows how to use this and willing to help us out with this? Hopefully Ryan will also see this. Thanks.

  • Like 2

Share this post


Link to post
Share on other sites

@kongondo Thanks for the module. Great work.

Having a look I noticed there is no featured image option for the posts.

It is quite common to add a featured photo at the top of a post and to have it on the side or top of each post listed on the blogs home page.

Is that something you are looking to add or is there a way to add it to renderPosts()?

  • Like 1

Share this post


Link to post
Share on other sites

@Dazzyweb,

Thanks for reminding me about this. Actually the feature had previously been requested by Adrian but I never got round to it :-). I was not sure how best to implement it but taking up your renderPosts() suggestion and coupled with Adrian's ideas, I have now come up with a workable solution. I will post an updated Blog version in its GitHub dev branch in the next couple of hours for testing, suggestions, etc.

  • Like 1

Share this post


Link to post
Share on other sites

Upcoming update: Blog version 2.1.0. (dev)

Summary of Changes: Added 'Small' Posts Featured Image setting

EDIT: Note that the implementation of this feature has slightly changed. See this update:

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

As requested, Blog version 2.1.0 now includes a 'featured image' setting that can optionally be used when displaying a summary of posts (i.e. small/summarised/truncated posts). I haved added this to the dev branch for testing and comments, thanks.

It is implemented by including a third argument/parameter to renderPosts(),i.e.

renderPosts($posts, $small = false, Array $featuredImage = null)

Only if $small = true and $featuredImage is also specified, does the setting kick in. $featuredImage must be an array of options to apply to the featured image as described below:

  • First, renderPosts() will look for the first image with the default or specified tag (see below) in the post's blog_images field
  • If no image found, it will then look for the first image embedded in blog_body (i.e. the body of the post). Here it uses PHP's DOMDocument class.
  • if we find an image, we output it in ,<div class=post-body> just before the truncated post text (see screens below). The image is given the class <img class='post-small-featured-image'>
  • If no image found, nothing is output and we move to the next post...etc...

The above means that you can mix and match where your featured image will come from...

The default image options are:

//default featured image options
$defaultOptions = array(
			'width' => '',//no width manipulation if this blank
			'height' => '',//no height manipulation if this blank. Note, if size is true and both width and height > 0, use size() instead
			'alt' => 'description',//defaults to $image->description. Otherwise other stated field on the page, e.g. = 'title'
			'tag' => $this->_('featured'),//string: image tag to look for in blog_images			
			//size: image will be resized to exact dimensions -> $img = $image->size($x, $y)
			//where $x = 'width' and $y = 'height'
			'size' => false,//if 'size' = true AND both width and height > 0, this kicks in
);

Above are self-explanatory but let me clarify a few things regarding the order of implementation.

You don't have to specify any/all options if you are happy with the defaults, so you can do...

//render a limited number of summarised posts + show featured image
$featured = array('tag'=>'thumb', 'width'=>350, 'alt'=>'title');

$content = $blog->renderPosts("limit=5", true, $featured);
echo $content;

For featured blog_images

In descending order, the order of image dimension manipulations for a featured image coming from blog_images as set in your $featuredImage options will be processed as follows (note: only one manipulation takes place! i.e., if, elseif, else...)

(see what these mean in the Images docs)
  • size = true AND width > 0 AND height > 0: $thumb = $image->size($x, $y);//where $x=stated width and $y=stated height
  • width > 0: $thumb = $image->width($x);//where $x=stated width
  • height > 0: $thumb = $image->height($y);//where $y=stated height
  • No height AND no width stated: $thumb = $image;/i.e. original image output at original dimensions
Also:
  • alt: defaults to '$image->description'. If anything else is specified, then alt = $page->field where field is the given value in alt. e.g. if 'alt'=>'title', alt=$post->title
  • tag: defaults to 'featured' but will take any string you specify in 'tag'=>'mytag'.
 
For embedded images
  • These are not subject to ProcessWire image methods. So there are no width, height manipulations
  • If height and/or width > 0 is specified in $featuredImage options, these will be output in the img tag.
 
In both cases, of course, you can still use CSS to control image dimensions and position.
 
Some examples
 
If you pass the following options to $featured in renderPosts("limit=5", true, $featured);
 
/*will get first blog_images with tag='thumb'. Image width will be resized to 350, height proportionately calculated and post->title will be alt (i.e., post page's title). No size() applied since not specified so also height ignored. So no need to specify it here!*/
$featured = array('tag'=>'thumb', 'height' => 300, 'width'=>350, 'alt'=>'title');

/*same as above except image height resized to 300 and width auto calculated*/
$featured = array('tag'=>'thumb', 'height' => 300, 'alt'=>'title');

/*$image->size($x, $y) applied*/
$featured = array('tag'=>'thumb', size=>true, 'height' => 300, 'width'=>350, 'alt'=>'title');

/*no manipulations; original image output since no height and width specified with size. alt=$post->caption. So no need to specify size here!*/
$featured = array('tag'=>'thumb', size=>true, 'alt'=>'caption');

/*output first embedded image giving it height and width dimensions - In this case will only work if blog_images does not contain an image tagged 'featured'*/
$featured = array('height' => 300, 'width'=>350, 'alt'=>'title');

/*output first embedded image. In this case, doesn't matter if you tagged your blog_images or not*/
$featured = array('tag' => '');
Note:

If you will be using blog_images to hold your featured image, you will have to enable use 'tags' in the field's settings (Detail's tab). I have decided not to enable this setting by default when Blog is installed since 'featured image' is an optional thing.

This will not work with images embedded using Hanna Code since such will be output when page is rendered. To make things as light as possible, DOMDocument above looks in the blog_body html string retrieved from the database. If anybody has other thoughts please let me know, thanks.

 
 
I will update Blog docs when this is committed to master.
 
Thanks for testing.
 
Screens (with custom CSS styles applied to img.post-small-featured-image)
 
Float left
post-894-0-79294700-1413848937_thumb.png
 
Float right
post-894-0-03144500-1413848940_thumb.png
 
Top, no float
post-894-0-87608500-1413848942_thumb.png
Edited by kongondo
  • Like 3

Share this post


Link to post
Share on other sites

Thanks Kongondo. Blog module is just getting better and better.

BTW I've had the issue in the past where I've needed a "featured image" with each post.
Using your older Blog Module, I've just told editors that the first image in the images field will be the featured one and it's worked perfectly.

They know they can reorder images as required so have very few probs that way.

  • Like 1

Share this post


Link to post
Share on other sites

I just tested it and it works fine thanks.

I wanted the featured image above the headline so I am just wondering what the best way is to customise the output / markup a little more.

For example I would like the featured image to be above post-headline and maybe the post-byline below the post-body.

I know I could go in and change the renderPosts() method but would prefer not to change the plugin to do this.

Share this post


Link to post
Share on other sites

Featured image above post-headline

I'll mull over this one but can probably add a position=>above//below in $featuredImage options. Just to be sure, you mean something like this or this or this yes?

post-byline below the post-body

This one I am not sure about whether I want to change the current behaviour..

Share this post


Link to post
Share on other sites

Just a heads up. 

I installed the blog module and it looks and worked great.

ONE HUGE ISSUE HOWEVER...

- as this module adds a few fields to the users interface screen (display name, bio etc) when I fill in an actual display name and save it and then log out and try and log back in the admin area I'm unable to. Unable to reset password by any means.

No clue why this would happen but I've tested it twice. I'm running version 2.5.2

Luckily I had recent backups of my dbase to recover or else this would have left me high and dry.

Has anyone else seen this issue as its a big one in my eyes

Share this post


Link to post
Share on other sites

Shouldn't layout be left to devs template preferences? I like my modules not to assume any layout prefs.

Also, any plans to email admins for new comments?

Share this post


Link to post
Share on other sites
Chris,

This is a total stab in the dark here, but any chance you also had either the AutoName or PageRenameOptions module installed?

There was a bug in both that allowed for system template names to be changed - would only happen to the user template if the title field was added (it's not there by default, but it is added with this module).

The bug has been fixed on both modules as of today, so if that was the issue, make sure you update those modules and everything should be fine.

The good thing to know is that it would have just been a matter of opening up PHPMyAdmin to see the name of the user in the database - log in with that and you'd have been fine.

So very sorry if it was one of those modules that caused the problem, but glad you managed to restore things ok.

If not, I'll defer to kongondo.

  • Like 1

Share this post


Link to post
Share on other sites

Just a heads up. 

I installed the blog module and it looks and worked great.

ONE HUGE ISSUE HOWEVER...

- as this module adds a few fields to the users interface screen (display name, bio etc) when I fill in an actual display name and save it and then log out and try and log back in the admin area I'm unable to. Unable to reset password by any means.

No clue why this would happen but I've tested it twice. I'm running version 2.5.2

Luckily I had recent backups of my dbase to recover or else this would have left me high and dry.

Has anyone else seen this issue as its a big one in my eyes

@Chris,

Sorry about your troubles. This is very strange. It has not been reported before nor have I experienced it. Blog does not touch your PW 'user' credentials at all. Please clarify a few things:

  1. Can you confirm what version of Blog you are running?
  2. It may sound silly, but confirm when you are trying to log back in, are you using your username or Blog's display name?
  3. Do you get any error messages when you try to log back in? What are those messages?
  4. Are you logging back in as an Admin?

Share this post


Link to post
Share on other sites

Shouldn't layout be left to devs template preferences? I like my modules not to assume any layout prefs.

Also, any plans to email admins for new comments?

  1. Yes ; isn't that what this module is already doing?  O0
  2. No  :P......Here's why... :-[  ;) {also see the G thing...}

post-894-0-98235300-1413929474_thumb.png

  • Like 2

Share this post


Link to post
Share on other sites

Upcoming Update: Blog version 2.1.1 (dev)

Update as per request to allow user to control position of featured image  - either above post-headline or below post-body. Default is, if present, output featured image below post-body.

To output a featured image above the post-headline, include the 'key'=>'value' pair 'position'=>'above' in the $featuredImage options array, .e.g.

$featured = array('tag'=>'thumb', 'width'=>550, 'position'=>'above');
echo $blog->renderPosts("limit=5", true, $featured); 

For new readers, also refer to the original Blog 2.1.0 post above. Feature available in the dev branch for testing, thanks.

Screenshot

post-894-0-86242200-1413934637_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

OK, I have had a rethink in respect of the second request here (post-by line below post body) and the first issue here... :-). Similar to renderComments() where you can customise comments' visibility status texts, I am working on making the currently hard-coded 'posted by', 'posts 1 to 1 of 20', 'view more', etc (including their visibility and position where applicable) customisable.

The 3rd argument of renderPosts() will now be Array $options and will cater for various aspects of the rendered post. If you have any requests please post them here and I will consider them, thanks.

Share this post


Link to post
Share on other sites

@kongondo

I have installed 2.0.2 and am working on the frontpage of my site. The two latest news items are shown like this.

<div class="block-group">
	<div class="block width100">
		<?php
			$blog = $modules->get("MarkupBlog");
			echo $blog->renderPosts("limit=2", true);
		?>
	</div>
</div> 

 Is it possible to print them next to each other. Perhaps call items twice? Call 1st item, then skip 1st and call 2nd item

<div class="block-group">
	<div class="block width50">
		<?php
			$blog = $modules->get("MarkupBlog");
			echo $blog->renderPosts("limit=1", true);
		?>
	</div>
	<div class="block width50">
		<?php
			$blog = $modules->get("MarkupBlog");
			echo $blog->renderPosts("limit=1", true);
		?>
	</div>
</div>

Share this post


Link to post
Share on other sites

@toothpaste,
 
Yes, it is technically possible to call items twice but wholly unnecessary :-). Btw, if you did that, there is no need to call $modules->get('MarkupBlog') twice. Calling it once is enough on the same template file. Anyway, back to the issue. You can easily achieve what you asked - having two posts (or 3 or 10 or whatever) side by side by just using CSS. All blog posts are wrapped in divs as follows:

 <div class="posts">
    <div class="post">Post number 1</div>
    <div class="post">Post number 2</div>
    <div class="post">Post number 3</div><!-- etc, etc. -->
</div><!-- end parent div.posts--> 

  
What you want to do is to target the div.post with CSS to make them float side by side. Now, directly targeting div.post in your CSS may obviously affect other instances of div.post elsewhere (e.g. in blog-post). So, what you want to do is probably to wrap div.posts in your custom div like so:

<div id="wrapper">
  <div class="posts">
    <div class="post">Post number 1</div>
    <div class="post">Post number 2</div>
  </div><!-- end parent div.posts-->
</div><!-- end parent div#wrapper-->

You can then easily target each div.post with your CSS.

Share this post


Link to post
Share on other sites

@kongondo Thanks for all your work on the blog module and responsiveness to any requests.

It would be great to be able to customise and control the output of the posts a bit more since there are many possibilities of how a post could be displayed or certain elements of a post displayed somewhere else on the page.

For example I might want to put the post headline at the top of the page on a featured banner photo then have the actual post shown lower down in the main body of the page. At the moment this doesn't seem possible.(this was one option I was thinking about for a blog I am making now)

Another thing I have been thinking about is how I would be able to add for example social media like buttons to each post when several posts are listed on a page or how I could put like buttons somewhere on a post other than at the very top or bottom of a single post shown.

Share this post


Link to post
Share on other sites

@dazzyweb,

I don't follow: 

For example I might want to put the post headline at the top of the page on a featured banner photo then have the actual post shown lower down in the main body of the page. At the moment this doesn't seem possible.(this was one option I was thinking about for a blog I am making now)

Are you talking about a full post as output e.g. in blog-post.php or are you talking about summary of posts, e.g. on blog-posts.php? If the latter, I have already implemented that as per your request yesterday. What is a featured banner photo in this case? Where is it coming from? Can you show me some examples/illustrations please?

Another thing I have been thinking about is how I would be able to add for example social media like buttons to each post when several posts are listed on a page or how I could put like buttons somewhere on a post other than at the very top or bottom of a single post shown.

Without jQuery or similar you can't at the moment. Again, are you talking truncated ($small) posts or full posts or full listed posts (e.g. on blog.php)? I'd like to see some illustrations/examples though... :-)

Share this post


Link to post
Share on other sites

Are you talking about a full post as output e.g. in blog-post.php or are you talking about summary of posts, e.g. on blog-posts.php? If the latter, I have already implemented that as per your request yesterday. What is a featured banner photo in this case? Where is it coming from? Can you show me some examples/illustrations please?

I mean as in blog-post.php whereby the post headline for the post can be extracted and inserted into a main photo  but removed from the rest of the post something like these examples shown here. https://www.heartinternet.uk/blog/article/were-sponsoring-confconf-2015 or here http://wplift.com/best-free-wordpress-themes-oct-2014 This can also be seen to work on small posts like here: http://wplift.com/

Without jQuery or similar you can't at the moment. Again, are you talking truncated ($small) posts or full posts or full listed posts (e.g. on blog.php)? I'd like to see some illustrations/examples though... :-)

I was talking about both in a way. With small posts something like this: https://www.heartinternet.uk/blog and full listed posts something like this http://wplift.com/best-free-wordpress-themes-oct-2014

Share this post


Link to post
Share on other sites

The problem with a module like this is that it is unlike WP with its many themes which have different layouts :D..

For #1: I think you can easily pull that off with CSS. What I will need to add however, is the option to also output a featured image for a full single post [blog-post.php] (currently I have implemented this for $small posts only). Same as the current implementation, one will have the choice for that to be output either above the post-headline or below the post-body. In your case you'd probably go for 'above' post-headline and using CSS you can place your headline on top of the featured image. I'll try show you example CSS on how to do it...

For #2: I will need to think about how those can be implemented (forum any/all ideas welcome, thanks!). I think it is an important feature. This will probably have to be implemented on the GUI side. It will have to be configurable, i.e. what social media sites to show, their icons, etc...This feature may have to wait for a while though...I want to get it right... :-)

Thanks for the ideas.

  • Like 1

Share this post


Link to post
Share on other sites

I am not sure if this is possible and maybe a bit of work to implement but I imagine a 2 textareas where the markup can be customised for the post or posts.
One for full posts (blog-post.php) and one for truncated posts ($small).

In each of these textareas html and short codes or variables could be entered which represent different parts of the post such as [featured] and [post-headline] etc...

Then this is output with renderPosts()
 

Share this post


Link to post
Share on other sites

kongondo, to answer some of your questions in regards to the blog changing username...

  1. Can you confirm what version of Blog you are running? - ANSWER: 2.0.2
  2. It may sound silly, but confirm when you are trying to log back in, are you using your username or Blog's display name? ANSWER - YES USING PROPER USERNAME NOT BLOG DISPLLAY NAMES
  3. Do you get any error messages when you try to log back in? What are those messages? ANSWER - NO ERRORS
  4. Are you logging back in as an Admin? ANSWER - YES

Here's what I found doing more research...

 

When I go and edit a user after installing the blog the Display Name is now required field which is fine. When you add a name ie. John Doe it actually changes the actual name field (the actual username field).

 

So as an example I had a user whos username was 'test555' I changed their Display Name (required by the blog) to be Jane Doe and low and behold it changes the actual Name (username) to jane-doe so it's actually renaming the username.

 

I saw a mention of this item: AutoName or PageRenameOptions module installed which they are so I'll try updating those and report back to see if that fixed anything

 

 

 

 

Share this post


Link to post
Share on other sites

happy to report that by upgrading to latest Page Rename Options that this bug has been fixed for me. It was a bit scary when actual usernames were being modified when you added/edited your display name and I couldn't gain access but this update to version 0.1.4 seems to fix it. This would have been a serious issues for my clients to say the least.

Thanks for that insight Adrian, appreciate it!!

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