Jump to content
OLSA

Module: ConfigurationForm (multiple fields container)

Recommended Posts

Hello for all,

ConfigurationForm fieldtype module is one my experiment from 2016.
Main target to build this module was to store multiple setup and configuration values in just 1 field and avoid to use 1 db table to store just single "number of items on page", or another db table to store "layout type" etc. Thanks to JSON formatted storage this module can help you to reduce number of PW native fields in project, save DB space, and reduce number of queries at front-end.

Install and setup:

  1. Download (at the bottom ), unzip and install like any other PW module (site/modules/...).
  2. Create some filed using this type of field (ConfigurationForm Fieldtype)
  3. Go to field setup Input tab and drag some subfields to container area (demo).
  4. Set "Name" and other params for subfields
  5. Save and place field to templates ("Action tab")

How to use it:

In my case, I use it to store setup and configurations values, but also for contact details, small content blocks... (eg. "widgets").

Basic usage example:

ConfigForm fieldtype "setup" has subfields:

"limit", type select, option values: 5, 10, 15, 20
"sort", type select, option values: "-date", "date",  "-sort", "sort"

// get page children (items)
$limit = isset($page->setup->limit) ? $page->setup->limit : 10;
$sort = isset($page->setup->sort) ? $page->setup->sort : '-sort';
$items = $page->children("limit=$limit, sort=$sort");

 

Screenshots:

Field setupSome page setupVariant SEO and setups fieldsCompact view option

Contact details (none compact view)Services using repeater and configform fieldtypeRepeater label as subfield value

 

Notes:

  • Provide option to search inside subfields
  • Provide multilanguage inputs for text and textarea field types
  • Provide option for different field layout per-template basis
  • Do not place/use field type "Button" or "File input" because it won't works.
  • Please read README file for more details and examples

Module use JSON format to store values. Text and textarea field types are multilanguage compatible, but please note that main target for this module was to store setup values and small content blocks and save DB space. Search part inside JSON is still a relatively new in MySQL (>=5.77) and that's on you how and for what to use this module.

Thanks:

Initial point for this fieldtype was jQuery plugin FormBuiled and thanks to Kevin Chappel for this plugin.
In field type "link" I use javascript part from @marcostoll module and thanks to him for that part.

Download:

FieldtypeConfigForm.zip

Edit: 14. August 2018. please delete/uninstall previously downloaded zip

Regards.

   
  • Like 19
  • Thanks 4

Share this post


Link to post
Share on other sites

Here are more details and some news about this module.

What's new (14. August 2018.):
- fix small bug
- search by subfields
- different layouts per-template basis

Examples:

1) 1 single field for configuration and setup instead 7 PW native fields

On "Home" administration page want to have global config options (stylesheet, development or production mode), and SEO settings fields.
On category pages need to have options to change number of children in list, provide option to select different layouts, and SEO settings fields.
Conclusion, need to have 7 fields: stylesheet (select), development (select or check), SEO fields (eg. title, description and robots), limit, layout.

Create field "setup" with all needed subfields:

field-setup-1.thumb.png.cd83abe872c74a369f22dd5087871f7e.pngfield-setup-2.thumb.png.56b8dba113a9032baaaa389d48417cec.pngfield-setup-3.thumb.png.08dc69b43a6f630ea813835cbf76d1b8.png

But also want to have different field layout inside Home and category pages.
For that we use "Compact view" inside template setup.
Result, same field but with different inputs and layouts.

layout-1.thumb.png.7f139c6063d9069d3f11c8bfe7657c6e.pnglayout-2.thumb.png.01a23e9c942401a0d8de7f5a8a69a43d.png

 

On site are dozen of categories and want to find where are used grid and where list layout.
Or, website is in still development mode and want to find NOINDEX categories, etc...


search-by-subfields-1.thumb.png.5551d4d98c4d402c3227edf550d988f0.png

 

2) Multiple different textareas on "basic-page" and "basic-page-2" templates using 1 single field
Task:
 - textarea1, textarea2 and textarea3 on basic-page template
 - textarea1, textarea4, textarea5 on basic-page-2 template
 - all that with 1 PW field

 Create field "content" with 5 textarea field types (textarea1...textarea5)
 
 Set Visibility condition like this:
 basic-page=textarea1, textarea2, textarea3
 basic-page-2=textarea1, textarea4, textarea5
 
 Inside Action tab add field to templates basic-page and basic-page-2.
 Later in page administration are only desired textarea inputs.

text-areas-1.thumb.png.636c0e7fb746c7a30f36e9c3769eb256.pngtext-areas-2.thumb.png.2296d1ffed301e4a6f8a8de684d4ef43.png

 
Search: find all pages where textarea1 contain word "Toronto"

 $items = $pages->find('content.textarea1*=Toronto');

Or in admin backend using lister:

search-by-subfields-2.thumb.png.bcffc5304210ca7f7cf3beae009a1c5c.png

In front side:

$selector = 'content.textarea1*=Toronto';
$items = $pages->find($selector);

if($items->count){
	echo "<h2>Find items: {$items->count}</h2>";
	echo "Selector:<pre>$selector</pre>";	
	foreach($items as $item){		
		echo $item->title .', template: '. $item->template->name;
		echo '<br />';
		
	}
}

search-by-subfields-3.png.9bbca688f6e31d6d649a66da5069c7cb.png

Note: this example is only for demostrations and I didn't test this in case of few thousands pages.

 

  • Like 5

Share this post


Link to post
Share on other sites

Great work! Thanks for sharing.

Unfortunately, I didn't have time yet to try this out, but I'll give it a go in the next couple of days.

I can imagine quite a few real-world usage scenarios for this.

  • Like 2

Share this post


Link to post
Share on other sites

Zdravo Sasa, kako je sunce u Crnoj Gori?  😄

I installed your module and played around a bit. Looks good so far.

Only thing I spotted: the PW width settings are not being displayed as intended, when I choose "compact view". In normal view, it's working fine.

And also, some elements are a bit too close to each other, when choosing compact view: (checkbox and radio labels)

compact-view.thumb.PNG.251c03bf1af2c8c1ad2920dffd21efdf.PNG

  • Like 1

Share this post


Link to post
Share on other sites

Dragane, odlicno, samo da je malo manje vruce ;)

CompactView is html table view and idea for that type of layout was to use it in cases where are inputs closely related (eg. some contact details), and inside repeaters because don't take too much space (can open few repeater items, and at the same time, view fields in all of them).

I missed to write in notes that PW Width value is not used inside CompactView layout.
Sorry but it's possible that I skiped to write and some other notes, and feel free to ask me anything that is not clear or confusing.

Fields what I used in almost 90% are: select, text, textarea, page and link. Radio and checkboxes very, very rarely (can't remeber), and in that case I prefer to use select.

Please can you try to add to the end of module css file (module  directory... site/modules/FieldtypeConfigForm/assets/css/admin.css) this few lines:

.CompactView .InputfieldCheckboxesStacked, .CompactView .InputfieldRadiosStacked {list-style:none;padding-left:0;}
.CompactView .InputfieldCheckboxesStacked input, .CompactView .InputfieldRadiosStacked input {margin-right:10px;}

, and after it refresh browser page (CTRL+F5) and check if it will be better?

Thanks and regards!

  • Like 3

Share this post


Link to post
Share on other sites

Yep, much better. I also removed the 12px font-size for the compact view label, it somehow looks weird to me if it's smaller than the rest, but that's just personal preference.

Thanks for clarifying that the width is ignored in compact view on purpose.

  • Like 1

Share this post


Link to post
Share on other sites
On 8/10/2018 at 7:34 AM, OLSA said:

Notes:

  • Provide option to search inside subfields
  • Provide multilanguage inputs for text and textarea field types
  • Provide option for different field layout per-template basis
  • Do not place/use field type "Button" or "File input" because it won't works.
  • Please read README file for more details and examples

May I suggest to simply exclude button and file inputs - it's kinda pointless to see them there as available input fields, when in fact they don't (yet?) work.

And the mulitlanguage part would be really really awesome. Most sites we build are multilang, so this feature would be almost a must-have, rather than a nice-to-have.

Did you post your module to the official PW module directory? https://modules.processwire.com/add/
That way, it would be easier for other people to find your module. And (afaik) this is a pre-requisite if you want people to use the "check for updates" feature in the PW-backend.

Zelim ti lep vikend 🙂

 

  • Like 2

Share this post


Link to post
Share on other sites

Zdravo Dragane,

I totally agree with you, and I'm aware of all imperfections, but I use it last 2 years in all my projects (multilanguage) and it's play important role in all of them.
News is that I am started with development of different version of that module and it's possible that I will include all suggestion in that version, or will do that in next release of current version, and after it post it to Github and in PW module directory.

Inputs like text and textarea are multilanguage, but labels are not because that part depends on jQuery FormBuilder plugin (in my case, I write labels in administration default language).

I really appreciate all the suggestions to make this module better and thanks for that!

  • Like 1

Share this post


Link to post
Share on other sites

Evo me opet 🙂

I encountered a strange problem today when I wanted to setup something with required fields:

I first hit the module's save-button, then I hit the PW field-save button. And PW can't save the field, because I get errors from the first field that is required (I don't want to prepopulate the fields or use placeholders).

This is some kind of a Catch-22 problem I guess 🙂

And also, I see JS errors in Chrome console:

config-errors-JS.thumb.PNG.e714fe59eff1b04f6f756b2619818c17.PNG

 

When I want to edit a page where I have this field inside, Tracy reports this error:

ErrorException: count(): Parameter must be an array or an object that implements Countable in /home/sitecom/www/mysite/site/modules/FieldtypeConfigForm/FieldtypeConfigForm.module:69
Stack trace:
#0 [internal function]: Tracy\Bar->Tracy\{closure}(2, 'count(): Parame...', '/home/zeixcom/w...', 69, Array)
#1 /home/sitecom/www/mysite/site/modules/FieldtypeConfigForm/FieldtypeConfigForm.module(69): count(Object(stdClass))
#2 /home/sitecom/www/mysite/wire/core/Wire.php(389): ProcessWire\FieldtypeConfigForm->___formatValue(Object(ProcessWire\Page), Object(ProcessWire\Field), Object(ProcessWire\ConfigForm))
#3 /home/sitecom/www/mysite/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___formatValue', Array)
#4 /home/sitecom/www/mysite/wire/core/Wire.php(413): ProcessWire\WireHooks->runHooks(Object(ProcessWire\FieldtypeConfigForm), 'formatValue', Array)
#5 /home/sitecom/www/mysite/wire/core/Page.php(1436): ProcessWire\Wire->_callHookMethod('formatValue', Array)
#6 /home/sitecom/www/mysite/wire/core/Page.php(1364): ProcessWire\Page->formatFieldValue(Object(ProcessWire\Field), Object(ProcessWire\ConfigForm))
#7 /home/sitecom/www/mysite/wire/core/Page.php(1116): ProcessWire\Page->getFieldValue('setup')
#8 /home/sitecom/www/mysite/wire/core/Page.php(1600): ProcessWire\Page->get('setup')
#9 /home/sitecom/www/mysite/site/assets/cache/FileCompiler/site/modules/TracyDebugger/panels/RequestInfoPanel.php(470): ProcessWire\Page->getFormatted('setup')
#10 /home/sitecom/www/mysite/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Bar.php(159): RequestInfoPanel->getPanel()
#11 /home/sitecom/www/mysite/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Bar.php(108): Tracy\Bar->renderPanels()
#12 /home/sitecom/www/mysite/site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module(1487): Tracy\Bar->render()
#13 /home/sitecom/www/mysite/wire/core/Wire.php(383): TracyDebugger->sessionHandlerDBAjaxFix(Object(ProcessWire\HookEvent))
#14 /home/sitecom/www/mysite/wire/core/WireHooks.php(825): ProcessWire\Wire->_callMethod('sessionHandlerD...', Array)
#15 /home/sitecom/www/mysite/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\ProcessWire), 'finished', Array)
#16 /home/sitecom/www/mysite/wire/core/ProcessWire.php(603): ProcessWire\Wire->__call('finished', Array)
#17 /home/sitecom/www/mysite/wire/core/ProcessWire.php(499): ProcessWire\ProcessWire->__call('finished', Array)
#18 /home/sitecom/www/mysite/wire/modules/Process/ProcessPageView.module(254): ProcessWire\ProcessWire->setStatus(16)
#19 /home/sitecom/www/mysite/wire/core/Wire.php(380): ProcessWire\ProcessPageView->___finished()
#20 /home/sitecom/www/mysite/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___finished', Array)
#21 /home/sitecom/www/mysite/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\ProcessPageView), 'finished', Array)
#22 /home/sitecom/www/mysite/index.php(56): ProcessWire\Wire->__call('finished', Array)
#23 {main}

Any ideas? Did you ever stumble across such a situation?

Edited by dragan
added Tracy Debugger error msg

Share this post


Link to post
Share on other sites

Hi Dragane,

sorry for the delayed response (I am on vacation until September 1st).

If that's  JS errors are in Chrome console inside field setup, that might be in relation with required attribute and Chrome browser (here are more details), but if you insert any values in setup "form" fields maybe you can "skip" that and PW will save field and it's subfields? Also, as a result of the first , maybe you have "empty" field (without subfields), and that cause second error (never noticed before, but I'll investigate that).

Here is one important detail that you probably didn't notice, and my fault because I didn't mention, required attribute is not in use in current version.

There are few options and buttons what are not in use and I didn't remove because my first plan was to use them all for fields (eg. "Required",  "Limit access..." ) or for new features.

Share this post


Link to post
Share on other sites

This module is great, very useful and i'm using it on a project; I guess my PHP version (7.2.10 ) doesn't like this: (FieldtypeConfigForm, line 69)

if(count($values)){

but this works

if(wireCount($values)){

 

  • Like 2

Share this post


Link to post
Share on other sites

Hey!
Thank you for this great module, I use it as part of a repeater item (for settings, to save some white space and grouping the settings).

Now I tried to echo the Value of a select option (Dropdown) like this:
{$item->grid_settings->gridsize->title}

gridsize is the name of my select field. And grid_settings is the name of my ConfigurationForm field (which contain multiple select fields). Item is the repeater item.

But this is not working. What Iam missing here?
Also is it possible to preselect an option?

Share this post


Link to post
Share on other sites

Hello @jploch

in case of select field, you can get only selected option value (and not title/text) or in your case:

$grid_size = $item->grid_settings->gridsize;

Share this post


Link to post
Share on other sites
On 9/27/2018 at 2:22 PM, jploch said:

Also is it possible to preselect an option? 

Preselect option, currently, only in case when you have option value as null "0", as example your "gridsize" field:

Label: "Grid size"

-- option value: 0, option text: Default
-- option value: 1, option text: Grid size 1
-- option value: 2, option text: Grid size 2

In that case, preselected value in admin backend would be "Default".
Later in your code:

if ($item->grid_settings->gridsize){
// not default (not preselected value)
...
} else {
// default
...
}

But there is and "mix" variant, example, some select field with name background:

label: "Background color"

-- option value: 0, text: Default
-- option value: black, text: Black
-- option value: orange, text: Orange

* preselected text : "Default"

Later in code:

<?php
// configuration form field "settings" with select subfield "background"
$background = $page->settings->background ? '-' . $page->settings->background : '';
?>
<div class="bgn<?php echo $background;?>">

* div can have css class values: bgn, bgn-black, bgn-orange

Regards.

  • Like 1

Share this post


Link to post
Share on other sites

Really like this module, using it to make a visual builder however I encountered that the uploading of files doesn't work. No errors is thrown.

It starts the ajax-upload but when it should be done it just disappear and the file isn't uploaded.

Currently debugging the issue. Will get back as soon as I find the issue.

But also wanted to see if anyone else encountered this?

Share this post


Link to post
Share on other sites

Sorry, above it says:

Quote

Do not place/use field type "Button" or "File input" because it won't works .

 

Share this post


Link to post
Share on other sites
Just now, gmclelland said:

Sorry, above it says:

 

Yes, I just read that! 

I'll dig into solving that 🙂 

Share this post


Link to post
Share on other sites

@OLSA Hey man, I just found your amazing module while looking for an easy way to add a bunch of settings to a Profile Configuration page and I am trully impressed. I've seen some other great modules which I initially planned to use but to have a drag&drop functionality would make the development much easier for me (maybe I am too lazy).

I am testing it now and will see how will it work. At least I can combine the file upload/image uplad default PW fields with the "custom field" of your module and avoid the need of adding image paths etc.

Thank you for this masterpiece!

  • Like 1

Share this post


Link to post
Share on other sites

After a few quick tests, I found it pretty straight forward to echo the content of text/textarea.

In addition to the present functions of the module, it would be great if we could set the default state of the field (open, closed) as well as to have some logic of fields appearance based on other fields value (like it is with regular fields)

Share this post


Link to post
Share on other sites
On 9/21/2018 at 9:32 PM, Macrura said:

if(wireCount($values)){

 

I had a similar issue, but in my scenario (with no module modifications) the line causing it was 58

if(count($values)){

I can confirm that changing the line to @Macrura correction eliminated the error in my logs.

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