Jump to content

Recommended Posts

would it be possible to incorporate an existing news section of a site to the blog profile?

  • Like 1

Share this post


Link to post
Share on other sites

So i'm a newbie in PW and make my first steps into deep.

so i've tried to translate this great addon to german....so far so good.
 
But the Top Menu Bar in Backend ( Dashboard Posts Categories Tags Authors Settings )

seems to cant get translated...so my question:

did i not get it or are there some strings hard coded in this module?

EDIT: worked the first one out....PW is so easy to learn great stuff... ;)

done a pull request: https://github.com/kongondo/Blog/pulls

Great Admintool

Featurerequests could be like described above:

- publish from/until feature (so you've get a eventcal option with dashboard, too without much effort or have a second addon)

- in Dashboard -> Overview could the Archive view linked to a row below with lists the posts in the clicked month?

- a blog addon that i used in another CMS has widget for "older + newer" topics - it's like "recent posts" but little different (maybe i find the time to contribute this by my self if i was more familiar with PW)

- what's about META tags like description and keywords?

i've seen some "automatic" functions for create them but let them overwrite from the author...

function makemetadescription ($thestring) {

$the_description = stripslashes($thestring);
$the_description = str_replace('"', ' ', $the_description);
$the_description = str_replace("'", ' ', $the_description);
$the_description = str_replace('\'', ' ', $the_description);
if (strlen($the_description) > 160) {
if(preg_match('/.{0,160}(?:[.!?:,])/su', $the_description, $match)) { $the_description = $match[0]; } //thanks to thorn

if (strlen($the_description) > 160) {
$pos = strpos($the_description, " ", 120);
if ($pos > 0) {$the_description = substr($the_description, 0, $pos); }	
}
}
//$the_description = ' '.$the_description;
$the_description = trim(str_replace(' ',' ',$the_description));

return (' '.$the_description);
}

function makemetakeywords ($thestring ) {

$the_keywords = $thestring;
if (strlen($the_keywords) > 100) {
if(preg_match('/.{0,100}(?:[.!?:,])/su', $the_keywords, $match)) { $the_keywords = $match[0]; } //thanks to thorn
if (strlen($the_keywords) > 100) {
$pos = strpos($the_keywords, " ", 100);
if ($pos > 0) {$the_keywords = substr($the_keywords, 0, $pos); }	
}
}	
$bad = array(
'\'', /* / */ '"', /* " */	'<', /* < */	'>', /* > */
'{', /* { */	'}', /* } */	'[', /* [ */	']', /* ] */	'`', /* ` */
'!', /* ! */	'@', /* @ */	'#', /* # */	'$', /* $ */	'%', /* % */
'^', /* ^ */	'&', /* & */	'*', /* * */	'(', /* ( */	')', /* ) */
'=', /* = */	'+', /* + */	'|', /* | */	'/', /* / */	'\\', /* \ */
';', /* ; */	':', /* : */	' ', /* */	'.', /* . */	'?' /* ? */
);
$the_keywords = str_replace($bad, ',', $the_keywords);
$the_keywords = str_replace(',,,',',',$the_keywords);
$the_keywords = str_replace(',,',',',$the_keywords);

return (' '.$the_keywords);
}
  • Like 1

Share this post


Link to post
Share on other sites

Some more Tweaking....

- tags are burned words in SEO maybe buzzwords or something is better use actually?

- tag pages should be noindex,follow per default? (Since newbee where is the best PW practise to setup such things)

Share this post


Link to post
Share on other sites

Kongondo,

Regarding blog_date field. I get the feeling it is designed to be the date/time that the blog post is published, but from what I can see it gets set when the post is first created and doesn't automatically change after that. I might be misunderstanding your use of the field, but I would like to see it change automatically when the post is published and not change after that - maybe even disable user editing of it?

I know we often draft up several posts at a time and publish them later. I don't think we should have to manually adjust this field when publishing the post.

Another thought for you - have you considered integrating this module:

http://modules.processwire.com/modules/schedule-pages/

or the functionality from it into the blog posts tab? This would make WP users feel at home. Thanks for considering.

blog_date field

You are right. It should be about the post publish date. I don't think this will be difficult to implement - I'll just steal and modify the code here by SiNNuT and Soma :D. I'd still like to leave a manual override (i.e. not disable user editing of it); I envisage cases where a post is published 'by mistake' and has to be recalled for later publication. 

Scheduled Pages

I'll have a think about this one. I can see the potential.

Thanks for your ideas!

  • Like 1

Share this post


Link to post
Share on other sites

Currently it looks like the excerpt length is hardcoded to 450 characters - perhaps adding an option for people to set this themselves would be a good idea? In the meantime, for anyone that wants to change this, find the line

Thanks for filing this in GitHub. I currently have this working on my local install. Added a 'blog_excerpt' integer field to the 'blog' template. Will also enable editing via the 'Settings' tab in ProcessBlog. Due to the nature of this module, for existing installs (i.e. if you've already installed ProcessBlog) you will have to manually create the field; The module will not attempt to modify existing fields; the risk of corrupting/loosing your data means it's not worth it :-). I'll post a notice here once I have updated the module, thanks.

Share this post


Link to post
Share on other sites

would it be possible to incorporate an existing news section of a site to the blog profile?

fenton,

Good question. It's something I've been discussing with some people. Currently, the only way to achieve this is to clone the module and modify it (typically paths and selectors) to read your news section pages (i.e. the fields). Obviously, that is not ideal or for everyone. However, Blog is meant for, er blogging. So, another solution is needed. The current idea is to create a separate (but similar) skeleton module that is highly configurable and adaptable to different needs such a news site, etc. At the moment, this is still an idea. There is no ETA yet :-)

Cheers.

  • Like 1

Share this post


Link to post
Share on other sites

So i'm a newbie in PW and make my first steps into deep.

so i've tried to translate this great addon to german....so far so good.

But the Top Menu Bar in Backend ( Dashboard Posts Categories Tags Authors Settings )

seems to cant get translated...so my question:

did i not get it or are there some strings hard coded in this module?

EDIT: worked the first one out....PW is so easy to learn great stuff... ;)

done a pull request: https://github.com/kongondo/Blog/pulls

Great Admintool

Featurerequests could be like described above:

- publish from/until feature (so you've get a eventcal option with dashboard, too without much effort or have a second addon)

- in Dashboard -> Overview could the Archive view linked to a row below with lists the posts in the clicked month?

- a blog addon that i used in another CMS has widget for "older + newer" topics - it's like "recent posts" but little different (maybe i find the time to contribute this by my self if i was more familiar with PW)

- what's about META tags like description and keywords?

i've seen some "automatic" functions for create them but let them overwrite from the author...

mr-fan

First, welcome to PW and the forums! Happy to hear Blog is of some use to you. Thank you for your suggestions

Translatable Strings

Apologies for my oversight! Thanks for the pull request. I'll have a look and update.

Publish from/until feature

See my response to @Adrian above. I'll have to think a bit more about this although it is a good idea I think. I just have to think about how to best implement it.

Archive - linked to row below with list of month's posts

Not sure about this one. The Posts tab already shows the lists of posts sorted by date

Meta tags, etc.

Not sure I follow what you mean?

Tags vs buzzwords

I don't think buzzwords will work :-)

noindex, nofollow

The best way to find stuff on these forums/PW site is to search using Google. E.g. noindex nofollow site:processwire.com

See this example: https://processwire.com/talk/topic/3928-meta-robots-on-individual-pages/?p=38483

Thanks!

Share this post


Link to post
Share on other sites

Updated to version 1.0.1

Several strings made translatable as per mr-fan's pull request (thanks!)

  • Like 1

Share this post


Link to post
Share on other sites

Apologies. version 1.0.0 of module was installed at /site/templates/Blog/ ...that should be /site/templates/ProcessBlog/ If updating the module within the PW Admin, this will write to this latter path... You will need to manually remove the former folder :-)

Share this post


Link to post
Share on other sites

Thanks for the Link for the robots - it's a thing that i missed until now - and it seems to implement easy like most everything in PW ;)

i will work further - thanks for this great addon.

PW is almost very peferct to my need or rather beeing so flexible to fit it.

Best Regards mr-fan

Share this post


Link to post
Share on other sites

Awesome work! Now, what if i needed to have 10 separate blogs like this on the same site?  >:D

  • Like 1

Share this post


Link to post
Share on other sites

.......Now, what if i needed to have 10 separate blogs like this on the same site?  >:D

Seriously? If yes, out of the box, no. But with some trickery, you can have MarkupBlog output posts from only a particular author, assuming each author has their own blog. I am just thinking out loud here. If this is a feature request, I'd like to have more details but also hear what others think :-)

Glad you like the module. :D

  • Like 2

Share this post


Link to post
Share on other sites

Seriously?

Yes, seriously  :( unfortunately I am working on just such a site right now. It's for a business that has 10 separate locations (pseudo-franchises, which are more or less independent) and they will all need to have their own separate blogs with their own URLs and their own tags, categories and archives. 

So far I've used a method where all the blogs have different templates in PW which all point to the same template file (which is based on Ryan's blog profile) but I've made the template file dynamic so the names of all the fields are built at run-time based on a naming convention. For example: tags-location1-name, tags-location2-name... etc. instead of just having 1 tags field. And all those suffixes are stored in a special hidden field in the root page of each location.

Don't mean to derail this thread, just wanted to point out a situation where more than 1 individual blog is needed and how much work it can take to set up something like that. 

Again, big thanks for your work, it's going to save me a lot of time on many projects!

Share this post


Link to post
Share on other sites

......just wanted to point out a situation where more than 1 individual blog is needed and how much work it can take to set up something like that. 

Yeah, something to think about for the future... :-)

Share this post


Link to post
Share on other sites

Update: Blog version 1.1

Read below before updating.

For new installs, proceed as normal

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

Changelog

1. Added new widget 'Post Author' - @adrian idea, thanks.

- This widget allows you to add a post's author's biography with each post. You can add it before or after a post (or wherever you wish). See example in updated 'blog-post.php'

example: 

$blog = $modules->get('MarkupBlog');
echo $blog->postAuthor();

- The widget can be enabled/disabled in the 'Settings' Tab of ProcessBlog. It is enabled by default

- Updated the CSS to style the widget

Screen

post-894-0-20359800-1401445817_thumb.png

2. Made 'posts truncate length' configurable - @looeee idea, thanks.

- This is for when you want to render a 'post summary' - e.g. as seen on /blog/posts/.

- Was previously hard-coded to 450. Default is now 450 where no value is specified

- Can be configured either on the page /blog/posts/ or 'Settings' Tab of ProcessBlog

UPGRADING

As I have said previously and repeat here (just in case you missed it :D) a module of this kind must not be altering your data if you've already installed it or where there are potential conflicts. 

Therefore, to upgrade, some manual input is required. Once we hit a lock-down on new features, then this requirement will fizzle out...

A. Author Widget

1. This comes with a new template without a template file. 

- Create a template called 'blog-widget-basic'

- Give it a tag 'blog' and a label 'Blog Widget: Basic' //just for consistency with other blog templates

- Add the field 'blog_summary' save. Then within the template (i.e. click on the upward arrow of the field), change the description to 'Widget Description' in the modal that opens up. Save...

- Still on the edit template view, under the 'Family' tab, specify 'No' under 'May pages using this template have children?' and 'Yes' to 'Can this template be used for new pages?' Save...

- Copy over the updated blog.css to /site/templates/css/ (this assumes you haven't made any custom changes to this file!!!)

2. Post Author page

- Under /blog/widgets/ create a new page called 'Post Author' and assign it the the above template ('blog-widget-basic')

- In the 'Widget Description' field enter a description, e.g. 'Renders Post's author biography.' Save...

The Author Widget should then automatically appear under 'Settings' in the Widgets section in ProcessBlog

B. Post Excerpt Length

1. Add Field to Template

- In the template 'blog-posts', add the field 'blog_quantity'. Save. Change the field's description to 'Posts truncate length'. Save

C. Update Blog to version 1.1

In PW, now update the module to version 1.1. This will copy over the new module files (ProcessBlog.module and MarkupBlog.module) and their related files.

Note: installer will not run again! So, don't worry :D

All done; now go write a post about how cool ProcessWire is  :P  O0

  • Like 5

Share this post


Link to post
Share on other sites

Hey kongondo - great improvements.

I have another suggestion for a widget for you :)

On the main posts page, I like having a thumbnail of the first image to the left of the summary text. Of course you could use the first image from the images field, but I think it would be more appropriate to use the first image embedded in the post - domdocument or even a regex does the trick nicely. You could maybe even have a "feature image" field which could be used for this purpose, or perhaps enable tags on the images field and have people enter "feature_thumb" or something like that in the tag field for the image they want to use as the thumbnail - this might be the simplest and most flexible approach and will also require no duplication of images.

Share this post


Link to post
Share on other sites

....I have another suggestion for a widget for you :)

On the main posts page, I like having a thumbnail of the first image to the left of the summary text. Of course you could use the first image from the images field, but I think it would be more appropriate to use the first image embedded in the post - domdocument or even a regex does the trick nicely. You could maybe even have a "feature image" field which could be used for this purpose, or perhaps enable tags on the images field and have people enter "feature_thumb" or something like that in the tag field for the image they want to use as the thumbnail - this might be the simplest and most flexible approach and will also require no duplication of images.

OK, I'll wait for a pull request from you  :P  ;) .....

I'll have a think...but I'll work on the auto-publish-date feature first...

Edit:

Show me an example post please, thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites

Comments on/off?

Been thinking about a new feature. Ability to turn on/off comments both on a per post basis and on a Blog-wide basis. So, if a post has comments turned off, the user gets the usual 'Comments not allowed for this post' or something similar. Additionally, maybe also a feature to turn-off submitting of new comments on a post when approved comments hit a certain number, say '100'. What do you guys think?

Need to think a bit more about how best to implement this... :-)

  • Like 4

Share this post


Link to post
Share on other sites
Show me an example post please, thanks.

This should give you an idea of what I mean:

post-985-0-65264000-1401463010_thumb.png

On another note, I like being able to only display the Recent Posts when viewing a single post. I don't see much value in having it on the blog home page because the recent posts are there already.

As for comments - all those options sound great!

Share this post


Link to post
Share on other sites

Blogwide there is only one option -> ignore blogpagesettings and overwrite this settings but not change it...if one switch back to comments=on the blogpagesettings are already there? Don't know this is to do in the PWWay...

Share this post


Link to post
Share on other sites

Blogwide there is only one option -> ignore blogpagesettings and overwrite this settings but not change it...if one switch back to comments=on the blogpagesettings are already there? Don't know this is to do in the PWWay...

Exactly. so, the logic, in order of ascending precedence (i.e. 3 > 1, etc.) could probably go like this:

1. Comments are ON by default.

2. On each 'post' page (/blog/posts/my-post/), will include a checkbox: 'check to disable comments for this post'. This will ignore #1

3. On some settings page or on the 'posts' page (/blog/posts/) have a checkbox or similar that says: 'disable comments on all posts'. Ignore #1 & #2

So, #3 is 'greatest' and will ignore #1 and #2 but will NOT change their settings; checked boxes (#2) will remain checked and unchecked ones (#1) will remain unchecked but their 'directions' will be superseded by #3 .

#################################  EDIT #################################

Oops warped thinking on precedence above!!! It should be the other way round! See edits below..

So, the logic, in order of ascending precedence (i.e. 3 > 1, etc.) could probably go like this:

1. Comments are enabled by default everywhere.

2. On the 'comments' page (/blog/comments/) have a select that says: 'disable comments on all posts/disable new comments on all posts'. Ignore #1 but respect individual post's settings (#3)

3. On each 'post' page (/blog/posts/my-post/), will include a select: 'disable comments on this post/disable new comments on this post/always enable comments on this post'. This will ignore #1 & 2. This is like a get() in ProcessWire: it is explicit and ignores 'hidden' status.  

So, #3 (individual post setting) is 'greatest' and will ignore #1 and #2.

#################################  END EDIT #################################

Btw, you will notice very soon that there's very little 'do this the PW way' - in many cases, there is no PW way :D The system is so versatile yet powerful you will be amazed... :-)

  • Like 3

Share this post


Link to post
Share on other sites

i will try to learn fast....;) i'm already amazed and i only see the surface! i've to less time to dive into all the sourcecode...

Share this post


Link to post
Share on other sites

Had an oops moment in my post #47 above; edited it :D (sort of a note to self; feel free to ignore  ;)  :P )

Share this post


Link to post
Share on other sites

Fantastic work, kongondo. Your module is much needed for those of us who don't want to spend a lot of time stripping out the markup on Ryan's (equally awesome) blog module.

One question: I notice that blog posts have this url: www.domain/blog/posts/my-post-here

Have you considered any approach which might remove "/posts/" from that URL? My existing blog doesn't have the extra segment and I'd love to keep it that way, if possible.

I've also been thinking I could remove it via htaccess.

  • Like 2

Share this post


Link to post
Share on other sites

..........One question: I notice that blog posts have this url: www.domain/blog/posts/my-post-here

Have you considered any approach which might remove "/posts/" from that URL? My existing blog doesn't have the extra segment and I'd love to keep it that way, if possible.

I've also been thinking I could remove it via htaccess.

Hi FuturShoc. Glad you like the module.

I thought about this a lot, even with the /site/blog/.... URL, where others would prefer /site/my-awesome-post/...but decided to leave it to the user (for now at least...), if they so wish, to manipulate the URL segments... :-)

UPDATE:

Feature now available in Blog version 2

Edited by kongondo

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

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

Create an account

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

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

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