Jump to content
kixe

Fieldtype Select External Option

Recommended Posts

Get the last version:

From the first view a simple select dropdown Fieldtype. But what is different?
Rather than the option field in the modul settings you will find some setting fields to define a source (datatable or field) from where you can pull the options (value and label).

I found this very useful when I had to put 250 options in a select field (which I provide in frontend too) and needed this connected and congruent to another more complex table. So now I can make changes in the main table and the select field will take over these changes.

You can define the following in the settings:

  • datatable
  • tablecolumn for (value) should be integer
  • tablecolumn for (label)
  • dependance (value or label)
  • order ascending or descending

Here we go:
https://github.com/k...electExtOption/
(updated 10.03.15 Version 1.0.2 with Multiselect Option)
(updated 11.03.15 Version 1.0.3 with Select Inputfields in Settings)

Edited by kixe
added links to github and modules directory
  • Like 7

Share this post


Link to post
Share on other sites

Very cool - definitely has some similarities with: https://processwire.com/talk/topic/8803-module-fieldtypeselectrelation/ but the ability to draw from any type of DB table is super cool and really flexible - I love it and can see several uses for it already :)

Any thoughts of making it support ASM multiselect?

This could then replace http://modules.processwire.com/modules/fieldtype-templates/ and https://processwire.com/talk/topic/9167-create-a-field-for-selecting-fields/?p=88679

  • Like 2

Share this post


Link to post
Share on other sites

Thaks for your remarks. Since I pull the options directly from the database table it is a bit different from the other stuff.
I added MultiSelect Fields. :)

post-1246-0-76937000-1426003392_thumb.jp

Share this post


Link to post
Share on other sites

Awesome to have the multi options.

A couple of things. 

  • Instances of page_id should be pages_id
  • Are the defaults supposed to work if not entered? They don't seem to - even if I change $value = 'page_id' to $value = 'pages_id' in the getExtOptions function, it still gives me "Column doesn't exist in table"
  • With this new version I am getting "TemplateFile: SQLSTATE[42S22]: Column not found: 1054 Unknown column 'sort' in 'order clause'

Share this post


Link to post
Share on other sites

Hi,

Thanks for this...

Do you have the project somewhere on Github?

Just an observation: In your $db query, Although you are properly escaping and sanitizing values, maybe you should consider using prepared statements too?

  • Like 1

Share this post


Link to post
Share on other sites

@adrian
Thanks for your help.

  • Yes it should be 'pages_id'. Anyway it was ment more like a placeholder. Maybe I will leave it out.
  • Yes in general the defaults should work. :)  I will check this.
  • It was a bit tricky to prevent from SQL Error exception, but I solved this with checking against an array of column names.
    And this beautiful API: $this->db->getTables()
  • You receive this SQL Error maybe if you didn't deleted the field where you have set the fieldtype. Since the module extends FieldtypeMulti the DatabaseSchema has changed. You should solve this by creating a new field. Tell me if it is working then.


@Kongondo
thanks for your post.

  • Like 1

Share this post


Link to post
Share on other sites

Aah...how could I miss that :-), thanks.

As for prepared statements, here's a couple of posts. 

https://processwire.com/talk/topic/3515-processwire-24-compatibility-for-modules/

https://processwire.com/talk/topic/5842-pointers-for-using-pdo/

https://processwire.com/talk/topic/4691-can-i-use-my-own-database-table-in-processwire/

You can also grep 'prepare' in core files to see how Ryan does it. You can also have a look in my Matrix module.

Share this post


Link to post
Share on other sites
You receive this SQL Error maybe if you didn't deleted the field where you have set the fieldtype. Since the module extends FieldtypeMulti the DatabaseSchema has changed. You should solve this by creating a new field. Tell me if it is working then.

 

That fixed it!

 

Everything seems to be working again now - just a pesky notice:

Notice: Object of class WireArray could not be converted to int in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 105

Share this post


Link to post
Share on other sites

Version 1.0.3
seems to work proper now. Changed all Inputfields in Fieldsettings to select.
post-1246-0-64092500-1426042548_thumb.jp

  • Like 2

Share this post


Link to post
Share on other sites

Awesome enhancements - this is very cool!

Still getting one notice:

Notice: Undefined variable: v in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 109

Can I make one suggestion - if the option label field is blank, could the label use the value field?

PS Is there any reason for the "type (int)" part of this description "Choose a column of type (int)." ? Why can't I use a text field? I am guessing it is just suggestion, and while it is generally a good idea, there are often reasons this is not convenient.

Share this post


Link to post
Share on other sites

adrian,

many thanks for your interest and help. I pushed Version 1.0.4 on github and a readme.md too. Should work stable now.

your remarks

  • I forgot to define an array. Its done.
     
  • Your suggestion:
    I disabled a preselection but field defaults of 'Option Value' and 'Option Table' are for both the first column of the selected table even if nothing is selected.
     
  • Yes there is a reason. The Class extends FieldtypeMulti. In the Database Schema of FieldtypeMulti values are defined as type (int). I don't want to change this. One of the intention I had when I started was to store the values as slim as possible. Now it is easy to create any database table with more than 2 columns to process the input in the way you want it. No need to run in problems by changing the database schema.
     

Share this post


Link to post
Share on other sites

Now another new notice:

Notice: Undefined index: option_table in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 145

You really need to turn on debug mode, or at least check your php error log :)

I see why you went with integers for the value - it makes sense to stay with the schema of FieldtypeMulti - I hadn't thought of that. But when using a non-PW DB table, when outputting the label of the selected value on the front end of your website, how are you going to get the value you want to display? This will require an SQL query to retrieve, right? For some devs this is no problem, but for others it may be too technical. Do you think you could include a method for rendering the label on the front end, based on the stored value?

I am thinking that you should be able to do:

echo $page->selectextoption;

and get the label of the selected value, rather than the stored value. What do you think?

Share this post


Link to post
Share on other sites

Stupid me. I turned on debug mode in wire instead of site folder. :P

For my use it is enough because I need only a unique ID for further processing. But in general you are completely right. There should be an api variable to get both value and label from external tables. I will try to solve this.

Access tables depending to PW is easy. For example if you choose 'templates' as source table the API is like:

$templates->get($page->selectextoption)->name

Returns a string if InputfieldSelect in use and array for InputfieldAsmSelect and InputfieldSelectMultiple.

  • Like 1

Share this post


Link to post
Share on other sites

Yep - I see that it totally works with PW tables. Thanks for looking into an option for non PW tables.

I am actually wondering if you might be able to do something like:

$page->selectextoption->db_field_name

and be able to return the value from any field (column) for the row that contains the selected integer ID value? This could work with both PW and non PW tables. Some examples of what you could return with this.

PW fields table:

$page->selectextoption->id = 1
$page->selectextoption->name = title
$page->selectextoption->label = Title
$page->selectextoption->flags = 13

a non PW table (maybe a list of country codes):

$page->selectextoption->num_code = 276
$page->selectextoption->iso3 = DEU
$page->selectextoption->name = Germany

I think this would be much more powerful than just returning the value and label fields.

I think it might also be nice to be able to magically return the selected value and label without knowing what the fields are, so:

$page->selectextoption = 1
$page->selectextoption->selectedLabel = Title (assuming the field I chose for the label was the title field)

Of course you can't use "Label" in this last example because "Label" is a field name in some PW tables, hence my use of "selectedLabel", but there might be a better option. Does that make sense?

Thanks for your hard work on this - it's going to be very useful!

  • Like 1

Share this post


Link to post
Share on other sites

Ups, this looks strange  $page->selectextoption returns always the fields value (string or array in case of InputfieldAsmSelect and InputfieldSelectMultiple). I cannot follow. ???

I found another solution to access all values of all columns of the source table depending on the field value ($page->selectextoption) label included.


Use the following API

// call the module
$getdata = $modules->get('FieldtypeSelectExtOption')

// will find the first or only field of type SelectExtOption in your page
$getdata->row();

// will find a specific field of type SelectExtOption in your page, useful if more than one field of same type in template
$getdata->row('myfield');

// will find a specific field of type SelectExtOption in a page found by selector string
$getdata->row('myfield','selectorstring');

// will find the first or only field of type SelectExtOption in a page found by selector string
$getdata->row(null,'selectorstring');

Output will be an Array with the stored value like ($page->selectextoption) as key and whole information about the row in the databasetable belonging to this value.

Example
Field Settings

  • Inputfieldtype = 'InputfieldAsmSelect'
  • Source Table = 'pages'
  • Option Value = 'id'
  • Option Label = 'name'

Selected Values in Frontend

  • 'admin'
  • 'user'

Output

array (size=2)
  2 => 
    array (size=10)
      'id' => string '2' (length=1)
      'parent_id' => string '1' (length=1)
      'templates_id' => string '2' (length=1)
      'name' => string 'admin' (length=5)
      'status' => string '1035' (length=4)
      'modified' => string '2015-01-29 06:37:43' (length=19)
      'modified_users_id' => string '41' (length=2)
      'created' => string '0000-00-00 00:00:00' (length=19)
      'created_users_id' => string '2' (length=1)
      'sort' => string '15' (length=2)
  29 => 
    array (size=10)
      'id' => string '29' (length=2)
      'parent_id' => string '28' (length=2)
      'templates_id' => string '2' (length=1)
      'name' => string 'users' (length=5)
      'status' => string '29' (length=2)
      'modified' => string '2011-04-05 00:39:08' (length=19)
      'modified_users_id' => string '41' (length=2)
      'created' => string '2011-03-19 19:15:29' (length=19)
      'created_users_id' => string '2' (length=1)
      'sort' => string '0' (length=1)

Does this help? It is working already. I will check a little bit and than upload to github.

New Version on github.

Edited by kixe

Share this post


Link to post
Share on other sites

Hey kixe - thanks for making progress on this. Maybe my example was confusing? When I wrote: $page->selectextoption, the "selectextoption" in my example is the name of my field.

I am not sure how your new code works, and I don't have much time today, but perhaps you can get some ideas from:

https://github.com/somatonic/FieldtypeDimension/blob/master/FieldtypeDimension.module or https://github.com/adrianbj/FieldtypePhone/blob/master/FieldtypePhone.module

or ProFields Table if you have access to it.

Then again it's early here and I need to get back to work so maybe I am not sure exactly how your new setup works.

Share this post


Link to post
Share on other sites

For single values ok, but what do you recommend in case of multiple values? Like this?

$page->selectextoption->3->id = 1
$page->selectextoption->3->name = title
$page->selectextoption->3->label = Title
$page->selectextoption->3->flags = 13

$page->selectextoption->29->id = 1
$page->selectextoption->29->name = title
$page->selectextoption->29->label = Title
$page->selectextoption->29->flags = 13

For now I prefer this

$data = $modules->get('FieldtypeSelectExtOption')->row(null,'id=245');

$data['29']['country'] = Germany

Share this post


Link to post
Share on other sites

I think I am maybe confused, but shouldn't it behave like other PW muilti fieldtypes. That is, you should be able to do:

foreach ($page->selectextoption as $selectedoption) {
    echo $selectedoption->id //returns 1
    echo $selectedoption->name // returns title
}

//OR

$page->selectedoption->first()->id

I don't really understand why you need to look up $data['29']. I am assuming 29 is the integer that has been stored and is what $page->selectextoption would currently return if using a single select field. In the case of a single one you would just return the corresponding db fields as properties of the field, like my example a couple of posts above. If it's a multi-select field, then it should return an array of results that you can foreach through or grab a specific index (first, eq, last).

Am I missing something?

Share this post


Link to post
Share on other sites

Adrian, thanks a lot for your interest and your comments.
 


$page->selectextoption = 1
$page->selectextoption->selectedLabel = Title (assuming the field I chose for the label was the title field)

I was a little bit confused about that. If selectextoption is a instance of WireData or any Helper Class how could this work?

Thanks for the hints with FieldtypeDimension and FieldtypePhone.
I find it a bit tricky to instantiate class objects with flexible properties. I will try. I am thinking about the following, depending on your recommendation.
 

// selectextoption is the name of our field

$page->selectextoption // returns WireData Object
$page->selectextoption->value // returns the stored integer value
$page->selectextoption->label // returns the label value

// to prevent a conflict between 'label' and a column in the datatable named 'label'
$page->selectextoption->data // returns array(columnname => rowvalue) of the datatable
// or better a class
$page->selectextoption->data->columnname // whereas columnname presents the name of any column in the datatable

What do you think?
I will put a dev branch on github for further development. But weekend first ...

Share this post


Link to post
Share on other sites

pushed Version 1.0.6 on github dev-branch.
Works now with the API Adrian recommended:

for single values
//selected value (int)
$page->myfield->value
// selected label
$page->myfield->label
// associative array with column => value of depending datatable row
$page->myfield->row

muliple values can be called with WireArray API
examples:
$page->myfield->last()->row['land']
$page->myfield->first()->row['id']
$page->myfield->eq(3)->value

To prevent conflicts with datatable column names like 'data' I decided to access the values via $page->myfield->row['data'] instead of $page->myfield->data. 'data' is an reserved property of  the WireData object.

Please check out and comment. Thanks

  • Like 3

Share this post


Link to post
Share on other sites

This is getting cooler and cooler :)

A few more comments / suggestions.

In ASM Select mode, everything seems to be working fine, but I am getting this notice:

Warning: Invalid argument supplied for foreach() in //site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 312

You should probable change your DB queries to use PDO and prepared statements. Here is a note from Ryan (https://processwire.com/talk/topic/3768-processwire-dev-branch/?p=36787) - at some point  procedural mysqli functions will no longer be supported - I am not sure when, but better to be ahead of things (I know there lots of modules out there that need updating).

The $page->myfield->row['land'] approach seems to work just fine. It's a shame it won't work as $page->myfield->land, but I as you mentioned, I guess the issue is $page->myfield->data, which would be a common requirement.

I haven't time to investigate right now to see if I can find a workaround, but I don't think it really matters - what you have is easy to use and an awesome way to access data from all sorts of DB tables - brilliant!

  • Like 3

Share this post


Link to post
Share on other sites

I made some changes. Seems to work stable now. I didn't change DB queries to use PDO until now, but it is on the top of the list.

Share this post


Link to post
Share on other sites

Unfortunately this latest version results in nothing being saved for the field value, no matter whether I use single, multiple, or ASM :(

Some more new thoughts:

  • I think you need that note back that mentions that you need to save the page to populate the options dropdowns.
  • I'd love to see checkboxes and radio buttons added as Inputfieldtype options.

Thanks again for working on this!

Share this post


Link to post
Share on other sites

Adrian, thanks for your remarks and help to push this forward.

  • It doesn't work in the latest devs. It works until 2.5.16. not later! No problem with master 2.5.3. There are changes in InputfieldSelect.module where I hook in.
    The new setAttribute() method converts object values to string. I try to get a solution. Maybe Ryan should check this too.
    Edit 20-03-15: added PW Version Switcher to enable hook for older versions on dev branch.
  • I thought about adding a Javascript which will save the page after the datatable is selected. Maybe a note is enough for now.
  • I put this on the list. List is getting longer.... Hey you gave me a lot of homework. :P
Edited by kixe
  • Like 1

Share this post


Link to post
Share on other sites

Hey - I just went to see if I could help you figure out a solution and I see your dev branch already has one and it is working great for me now on latest dev version.

Awesome job!

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