Jump to content

Recommended Posts

You won't find anything specific to Blog. I suggest you search the forums at large for something like this:

'limit page editing to the user that created that page'

https://processwire.com/talk/topic/3271-can-i-limit-page-editing-to-the-user-that-created-that-page/

Read that whole thread and modify the autoload module to suit your needs. 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks! I edited my question above to include the link to the discussion whose module I used.

I'm reaaaaally close! Of course not as close as I thought I was about 5 hours ago.. XD

Share this post


Link to post
Share on other sites

Regarding "Related Posts", I have been able to implement this using one line of code :-), OK, not quite but I have chosen a different route from the previously suggested code. Thanks for the inspiration and ideas though!  I will wrap this in a new renderRelatedPosts() method in MarkupBlog. In case you are wondering, the most important line of code is this:

$related = $pages->find("template=blog-post, blog_categories=$page->blog_categories, blog_tags=$page->blog_tags, id!=$page->id, limit=3, sort=-blog_date");

I'll post details later but I will make this configurable in the new method, i.e. add options to find related posts by 'tag' OR by 'category' OR 'by both tag AND category'. There will also be an option for limit as well as sort, i.e. if limiting, e.g. to 3 related posts, what's the criteria for your '3 most important related posts'? The default will be 'most commented on related posts' sort by latest posts (blog_date).

Then, similar to the 'Related Categories', 'Related Tags' and 'See also' output that you can see in the demo Blog template files running on the left hand side navigation, one will simply need to use the method renderNav() to display Related Posts as follows in the template file 'blog-post.php':

$subNav .= $blog->renderNav(__('Related Posts'), $related);

Just wanted to post these ideas before I finalise the code in case there is something I am missing? Thanks.

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

Sounds good!

In my installation I deactivated comments, that's why I havn't though about the option 'most commented on related posts' (but I really like the sort option). I have not that much blog posts so I need the following combination: find related posts by 'both tag AND category', by 'category' and by 'tag' (in that order) to fill my list.

  • Like 1

Share this post


Link to post
Share on other sites

Good catch; sorting by 'most commented on related posts' cannot be the default since not everyone will have activated Blog Comments. I have changed the default to sort by latest post...

Share this post


Link to post
Share on other sites

Update: Blog version 2.3.2
 
Additions
Thanks to idea by @justb3a, I have added a new method renderRelatedPosts() to MarkupBlog.  The method returns a PageArray of posts related to the post currently being viewed or the specified blog post/page. (if related posts found, otherwise returns null). It takes four arguments as follows:


renderRelatedPosts(Page $post = null, $relatedBy = null, $limit = null, $sort = null) 

1. $postThe post whose related posts will be returned. Defaults to the current page if none specified
 
2. $relatedBy: This sets the criterion for determining how other posts are related to the current post. There are 3 possible options here:
 
a. $relatedBy = 1: posts are related by both tags AND category. This means that in order to be considered as related to the specified post, the posts to be returned must have at least one tag and at least one category in common with the specified post. This is the default relation criterion.
 
b. $relatedBy = 2: posts are related by tags ONLY. Means that at least one tag has to match the specified post's tags.
 
c. $relatedBy = 3: posts are related by categories ONLY. Means that at least one category has to match the specified post's categories.
 
3. $limit: Number of related posts to retrieve. Defaults to 3 posts.
 
4. $sort: This determines the related posts to prioritise in the find. It is especially useful when you set a $limit. It defaults to sort by blog_date DESC, meaning latest posts. You can use any other valid ProcessWire sort value, e.g. sort by title, sort by 'most commented on posts' [see example below], sort by random, etc.
 
The method returns no markup and its output can be used in a variety of ways.
 
Examples

#RELATED POSTS

##1. used in conjuction with MarkupBlog's renderNav()
##similar to 'Related Categories' in the left-hand navigation in demo Blog 'blog-post.php' template file

//CALL THE MODULE - MarkupBlog
$blog = $modules->get("MarkupBlog");

//use defaults. Related posts limited to 3, related to this post by BOTH tags AND categories, ordered by blog_date DESC
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts());

//use renderNav() markup
echo $related;

//find the 'most commented on' posts related to this post by category
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts(null, $relatedBy=3, null, '-blog_comments.count'));

//find 7 posts, ordered Alphabetically by title, related to this post by tag
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts(null, $relatedBy=2, $limit=7, 'title'));

##2. used outside blog-post.php or even outside Blog pages

$post = $pages->get(2550);

//find 5 random posts related to the specified post by BOTH tags AND categories
$related = $blog->renderNav(__('Related Articles'), $blog->renderRelatedPosts($post, null, $limit=5, 'random'));

//find the 3 'least commented on' posts related to the specified post by tags
$related = $blog->renderRelatedPosts($post, $relatedBy=2, null, 'blog_comments.count');

//find 3 posts related to the specified post by tags AND categories
$related = $blog->renderRelatedPosts($post);

//use custom markup
foreach($related as $r) echo $r->title . '<br>';

Screenshot
post-894-0-13002400-1422301690_thumb.png
 
Currently in dev branch only for testing.

  • Like 2

Share this post


Link to post
Share on other sites

Here's a quick question...

I have the URL structuring set up as option 1

So blog/posts/post but would like to change to blog/post

Can I just move the posts out of the post parent page. Or would I be right in assuming it would be better to use a htaccess rewrite and rewrite blog/posts/post to blog/post ?

Thanks all

Share this post


Link to post
Share on other sites

Is this already live? Are you not able to reinstall and select style 2?

Share this post


Link to post
Share on other sites

Having a problem uninstalling. When you uninstall you have to manually delete fields etc, BUT as you have already uninstalled you cannot access blog-> cleanup.

Could you please add a link or text above uninstall to ask "Would you like to delete the fields as well?"

as I cannot now reinstall:

SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'blog-author-30' for key 'name_parent_id'

Tried manually deleting everything in the database but still get this error

Thanks

Share this post


Link to post
Share on other sites

Having a problem uninstalling. When you uninstall you have to manually delete fields etc, BUT as you have already uninstalled you cannot access blog-> cleanup.

Well this is not true...at least not if you followed the instructions to the letter  ;).

The instructions are very clear. There is no need to manually uninstall anything in Blog 2. Uninstall is a two step process

(i). Use the Cleanup first

(ii) Uninstall the module

https://github.com/kongondo/Blog#uninstall

Uninstalling Blog is a two-step process. If you are logged in as a superuser, you will see a Blog menu item called Cleanup. It will lead to a screen with info about all the Fields, Templates, Pages and Role you are about to delete. It will also list the Blog Template Files that, if you wish, you can also delete. This utility is also useful when you want to try out the different Blog styles without uninstalling the whole Blog module. It returns Blog to the state similar to when you first installed the module. Of course, in case you want to remove Blog as well, just go ahead and uninstall in the normal way but AFTER you have cleaned-up.

To remedy your situation, you need to delete the role 'blog-author'. 

Share this post


Link to post
Share on other sites

I'm fully aware its a two step process. However I forgot about the cleanup and clicked uninstall. This is about usability and this is not usable. Considering the average user is not expected to look at the uninstall page to uninstall a module with a button called uninstall on it.
 

"Uninstall this module? After uninstalling, you may remove the modules files from the server if it is not in use by any other modules.

Uninstall

This will also uninstall other modules - MarkupBlog, BlogPublishDate"

Where does it say anything about Cleanup here?

I have already deleted the role blog-author and still get the same error. I tried deleting everything manually, twice and still get this error.

I have checked every table and field I can think of and cannot find blog-author-30.
 


 

Share this post


Link to post
Share on other sites

There should be a link back to the Cleanup which is external from the 2nd step of the install process.

1. Uninstall.
2. Install.

3. See install failure due to not cleaning up.

4. Cannot reach Cleanup page as not installed. I would put the cleanup page with the install page so it can be accessed.

5. Manually delete everything, if you miss one thing, you have to start all over again.

Solution: Create a separate link to the cleanup page highlighting the SQL syntax to drop all relevant data.
 

  • Cannot install Blog fields. Some field names already in use. These are: blog_body, blog_categories, blog_comments, blog_comments_view, blog_comments_max.

  • A role called 'blog-author' already exists!

  • Due to the above errors, the install wizard did not run. Make necessary changes and try again.

  • SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'blog-author-30' for key 'name_parent_id'

    this is after manually uninstalling and deleting everything 4 times now.

    During the install it stops halfway through saying the field already exists from the >>>CURRENT<< install attempt.

    How could it? I checked the fields it references, deleted the field and ran it again. It now says a different field already exists.

Share this post


Link to post
Share on other sites

I think with all complicated systems, and this is considerably more complicated that your average little textformatter, it is always worth reading all relevant documentation before doing anything drastic.

I speak as one who has often messed up because I didn't! :)

Like all those times in front of clients I ranted and raved because yet again, the huge tape machine in our studio was not working! 

Only for the maintenance man to come all the way up to the top floor just to turn the mains switch on.

Oops.

Share this post


Link to post
Share on other sites

This is about usability , no rants and raves and it's a very simple solution.

With all complicated systems we code and focus on documentation and quirks later which stops adopt-ability. I code to make it fool-proof. It saves a lot of time in support etc later on.

Share this post


Link to post
Share on other sites

Update: Blog version 2.3.3

In addition to the very clear instructions on how to uninstall Blog (README), I have added an even clearer textual reminder/warning in Blog's module configuration screen to first run the in-built Cleanup Utility before uninstalling the module. 

post-894-0-70552800-1422577885_thumb.png

Committed to master...(including the new renderRelatedPosts()method discussed a couple of posts up.)

See next post about a utility to help when disaster strikes, aka, despite the very visible new warning text and despite the clear instructions you somehow find yourself with Blog components left in your hands having made the mistake of first uninstalling Blog and now you can't reinstall it without going through some very tedious manual cleanup....

  • Like 1

Share this post


Link to post
Share on other sites

DISCLAIMER:

The Blog Module already provides an in-built Cleanup Utility that enables you to remove all its components. As per the instructions in the module's README, which must be thoroughly read before using the module (as instructed in the first post in this thread and in various other places), in case you wish to uninstall Blog, you FIRST have to run the Cleanup Utility whilst logged in as a Supersuser. Further, as of this writing, a clear warning text is now visible right above the uninstall button in Blog's module configuration screen reminding you of this fact. Failure to follow the correct uninstall routine means that you will not be able to reinstall Blog until you (often manually) delete all the leftover components (that the Cleanup Utility would have removed for you) - a tedious, frustrating and painful exercise. 

In case, for some reason, you did not adhere to the above instructions, I am providing in the link below code to help you automatically remove any Blog leftovers in order for you to reinstall the module (if you wish, of course) or in case you just want to clean up. 

On install, Blog stores the IDs of its main pages in its configuration settings. Uninstalling Blog means those settings are lost. Hence, if using this code, the only way to find Blog pages is by their templates which in some cases, may not be very foolproof. This and others issues are documented in the utility code linked to below. 

This code is provided as is, with no obligation on my part, without any warranty, implied or otherwise. In plain English; whilst I have thoroughly tested the code, you will be using it at your own risk for which I will bear no responsibility :-).

The code should ONLY be used in case you reversed the uninstall procedure; otherwise use the normal procedure (see README) to uninstall Blog.

Link: blogCleaner

Instructions:

  1. Back up your database and template files
  2. Log in as a Supersuser
  3. Copy and paste the Cleaner code in the link above at the very top of a template file
  4. Save the template file
  5. On the frontend, visit a page that uses that template file
  6. The Cleaner's screen will be loaded
  7. Tick the checkbox to agree you 'know what you are doing, etc..'
  8. Complete the questions about the type of Blog you had before the uninstall
  9. Run the Cleaner
  10. If no errors found a success message will be displayed
  11. In your Admin, check that things went OK (and if need be  re-run the Cleaner)
  12. Restore the template file in #3 to its previous state
  13. Save the template file
  14. Reinstall Blog (optional :-))

Screens

post-894-0-32132500-1422580593_thumb.png

post-894-0-86703200-1422580594_thumb.png

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

PS: I hope none of the above comes across as rude or forceful. I'll read this again in the morning just to be sure or in case someone PM's me, whichever is the sooner :-). I will then amend as appropriate.

  • Like 2

Share this post


Link to post
Share on other sites

I have a series of blog posts on my blog.php.

It's just rendering a preview image, date, title and summary.

I want to control the order of the posts but neither 

sort=-date

or

sort=sort

is working when added to my two selectors.

         <!-- CENTRE COLUMN - MAIN -->               
          <div class="small-12 medium-9 large-9 columns ">
                <!-- START Nested Column containing featureimage and post-summary -->            
                    <?php $blogposts = $pages->find("template=blog-post"); foreach ($pages->find("template=blog-post,") as $b) {
                    echo "
					   <div class='row row-spacer'>
					     <div class='small-12 large-6 columns'><img src={$b->blog_images->first()->url} /></div>
					     <div class='small-12 large-6 columns'>
						 <div class='posts-date'>{$b->blog_date}</div>
						 <h3><a href='$b->url'>{$b->title}</a></h3>
						 {$b->blog_summary}</div>
					   </div>
					";
					} ?>
                <!-- END Nested Column containing featureimage and post-summary -->    
          </div>

Share this post


Link to post
Share on other sites

You can only sort by fields that exist in that template or internal properties (e.g., sort). There is no field called 'date' in the template 'blog-post'...unless you added it yourself? Otherwise, the following should work.

I don't know why you had two $pages->find()? Did you also add the field 'blog_summary'?

<!-- CENTRE COLUMN - MAIN -->               
<div class="small-12 medium-9 large-9 columns ">
    <!-- START Nested Column containing featureimage and post-summary -->            
        <?php $blogposts = $pages->find("template=blog-post, sort=-blog_date, sort=sort");

        foreach ($blogposts as $b) {
	        echo "
			   <div class='row row-spacer'>
			     <div class='small-12 large-6 columns'><img src={$b->blog_images->first()->url} /></div>
			     <div class='small-12 large-6 columns'>
				 <div class='posts-date'>{$b->blog_date}</div>
				 <h3><a href='$b->url'>{$b->title}</a></h3>
				 {$b->blog_summary}</div>
			   </div>
			";
		}
		?>
    <!-- END Nested Column containing featureimage and post-summary -->    
</div>

Share this post


Link to post
Share on other sites

@Kongondo

Thanks for the quick reply. I assumed the Date field was called date. As you point out, it's actually "blog_date". 

I've installed Somas Helper Field Links and this has made the field names more obvious.

I don't know why you had two $pages->find()

I'm not sure either. I don't do this in my current projects and I wondered if it was a legacy piece of code. Clearly just an error though.

Did you also add the field 'blog_summary'?

Yes, we use it for a tiny summary on the blog overview page. You probably have something like this native now but this is an older version of Blog Module I've yet to update.

Also, wanted to apologise for the abrupt request for help in the original post. My client is presenting this at 10AM this morning and informed me 30 mins prior to the meeting that they needed the posts in a particular order. The order had been fine for the past few days. Anyway, thanks again.  ^-^

Share this post


Link to post
Share on other sites

Hi Kongondo. I attempted to comment on a blog post and was redirected to [root]/#CommentForm which just booted me back to the home page.

My blog-post.php template file contains only the following code regarding blog comments:

$blogOut = $modules->get("MarkupBlog");

and

echo $page->blog_comments->render();

echo $page->blog_comments->renderForm(); 

$numComments = $page->blog_comments->count();

Here's the markup that the site outputs for the form.

<div id='CommentForm' class='CommentForm_new'>
<h3>Post Comment</h3>
<form id='CommentForm_form' action='./#CommentForm' method='post'>
	<p class='CommentForm_cite'>
		<label for='CommentForm_cite'>Your Name</label>
		<input type='text' name='cite' class='required' required='required' id='CommentForm_cite' value='' maxlength='128' />
	</p>
	<p class='CommentForm_email'>
		<label for='CommentForm_email'>Your E-Mail</label>
		<input type='text' name='email' class='required email' required='required' id='CommentForm_email' value='' maxlength='255' />
	</p>
	<p class='CommentForm_text'>
		<label for='CommentForm_text'>Comments</label>
		<textarea name='text' class='required' required='required' id='CommentForm_text' rows='5' cols='50'></textarea>
	</p>
	<p class='CommentForm_submit'>
		<button type='submit' name='CommentForm_submit' id='CommentForm_submit' value='1'>Submit</button>
		<input type='hidden' name='page_id' value='1449' />
	</p>
</form>
</div><!--/CommentForm-->

Without changing the module I'm not sure how to fix this. I checked the Settings in Blog Admin but nothing seems to control the form directly.

Share this post


Link to post
Share on other sites

Not sure what funkiness is going on there. Have a look at the demo blog-post.php. All you need to render both comments and the form is MarkupBlog's method renderComments() (form will only be displayed if the page uses the template blog-post).

$blog = $modules->get("MarkupBlog");
echo $blog->renderComments($page->blog_comments);
Edited by kongondo

Share this post


Link to post
Share on other sites

Thanks Kongondo. I replaced my code with yours, but the result of attempting to post a comment is the same.

Share this post


Link to post
Share on other sites

Aah, I think I know what is happening....It is not directly related to Blog but the settings of your comments field. Edit the field blog_comments. Go to..

Admin > Setup > Fields > Edit Field: blog_comments. Go to the Details tab. In the second row on that settings page, under Redirect after comment post?, I think you have that checkbox checked. Read the info there and decide whether you want to have it redirect or not. 

Share this post


Link to post
Share on other sites

I hadn't checked all those settings before! Redirect after Comment was not checked, and playing with the settings there had no effect. The comment is not posted and the user ends up on the site front page (/#CommentForm).

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