Jump to content
kongondo

Visual Page Selector (commercial page picker module for ProcessWire)

Recommended Posts

17 hours ago, mikhail said:

Though I can see already that I will need to make adjustments to how large you are showing the thumbnail images in listing view, in addition to the width of the additional column.

OK. Suggestions? However, I noticed that in Thumbs Grid view, if for some reason ProcessWire fails to properly create an image thumb 260px high, some crazy-wide images will be displayed. I ran into this in Media Manager which I am currently upgrading. I have made changes there and will do so in VPS as well.

17 hours ago, mikhail said:

There is also a bit of a weird UI thing happening with a line showing through the title field (Firefox, Win10) in the following non-listing view-

That is weird! I'll have a look. I don't have Win10 though... (blissfully stuck on Win7 :))

Share this post


Link to post
Share on other sites

Suggestions?  Sure- here's my particular use-case which highlight the reasons why I would need to modify VPS's admin behavior-

I am using this for panoramic images that I create. So they are much wider than they are tall. This means that in thumbnail-list view the default preview images have very little height to them, making it more difficult to see what they are. I would need to at least double the present width in order to make the images easier to identify.

Also in "list view"- one can add columns to the right to include field data such as name, title etc. In my case, I use three columns of data- the image "TITLE" ( short unique ID's ~10 char), a relatively short (~20 char) category, and a proper NAME (~70+ char). When I include these fields, the added columns are presently evenly spaced. Resulting in a much wider column than necessary for the TITLE, a wider column than is necessary for the CATEGORY, and a column that is too small for the NAME (causing it to wrap). Perhaps a way to designate percentage widths for these columns would be a great addition?
 

Capture.JPG

Share this post


Link to post
Share on other sites

Regarding the odd UI "bug" I showed. I am using the UIKit Admin style. Perhaps that might be the source of it?

Share this post


Link to post
Share on other sites
55 minutes ago, mikhail said:

default preview images have very little height to them, making it more difficult to see what they are. I would need to at least double the present width in order to make the images easier to identify.

Going forward, I have been thinking for adding the 'resize' slider like in ProcessWire's image field so that the user can select their default preview size.

55 minutes ago, mikhail said:

Perhaps a way to designate percentage widths for these columns would be a great addition?

I wanted to implement this in the last version but ran out of time. I would like to incorporate the input for the percentage widths right within or next to the respective column definitions (in the asmSelect). I'll have a think, thanks

50 minutes ago, mikhail said:

Regarding the odd UI "bug" I showed. I am using the UIKit Admin style. Perhaps that might be the source of it?

I use the same theme, although I test in all themes. I'll test some more, starting with FF.

 

Share this post


Link to post
Share on other sites

Great fan of the module! However, I haven't yet gotten it to work for non-superusers. The modal for selecting pages aborts with an error »ProcessWire: Unrecognized path« and »The process returned no content.«

Now I guess it has to do with them not having the required permissions to access the root Admin page, but is there another way to allow editors to use the module?

Share this post


Link to post
Share on other sites

Me again. Sorry for wasting your time 🤡Everything is working as expected now.

I overlooked the vps permission and only now found it — after stumbling through this support thread.

Share this post


Link to post
Share on other sites
2 hours ago, d'Hinnisdaël said:

Great fan of the module!

Glad you like it 🙂

2 hours ago, d'Hinnisdaël said:

Everything is working as expected now.

Good to hear you got it sorted.

2 hours ago, d'Hinnisdaël said:

after stumbling through this support thread.

Not so great on my part then 🙁. It seems I should be more clear that this thread exists 🙂.  Docs are also here. They do mention the vps permission in the very first chapter.

Share this post


Link to post
Share on other sites

Hi @kongondo, Hope all is well!

Running into a couple of glitches here with VPS, and these were discovered in a meeting yesterday, more or less watching the client/users interacting with the field and having to sort of 'apologize' for the complexity and/or the peculiarities of the field.

To sum up the current issues:

(1)

It seems that when adding an item to the field, there is some sort of ajax save going on (?) - this is contrary to a standard page field where the stored value of the field is not modified until the page is saved. The issue here is that the frontend is possibly updating to reflect that saved state of the field, prior to the user having a chance to save the page. 

An example use case illustrating why this is a problem would be say if your field is being used for selecting slides for a slider. The user may want to add slides, remove others, reorder the slides, possibly edit the slides all prior to wanting these changes to be reflected in the front end. With the current behavior, the newly added items appear on the front end prior to the user saving the page, and they found this to be unexpected behavior.

(2)

Users are still confused about the process of adding items from the lister.

One issue is that they don't know when/if an item is selected, as there appears to be no indicator of that at the row level, so they would select something, then inadvertently unselect it in a vain attempt to get some visual feedback that the item they want is selected; Once they have an item selected, they need to scroll to the top of the modal window, and hit the plus button to get the item to add to the field. Not sure how else this could be handled but it is something they also have to remember rather than it being intuitive.

(3) the process of removing items is also a 2 step process – they have to trash the item, then hit the remove button; this is fine, and as long as i add instructions on the top of the field it should be ok; But maybe there should be some visual feedback once they have 1 or more items selected for trashing that they now need to click the X button to actually remove them – saving the page with those items marked for trash (which would be the images field behavior) does not seem to remove them, so this inconsistency between similar looking fields is also causing confusion among the users.

Currently I don't know of any better way than this field to allow these users to select items (such as images, videos, or other image driven content). The ability for them to use a lister to select items is great, and once you get used to the steps, it's basically fine, though some small tweaks that might address some of the current concerns could be nice polish for this.

But currently the fact that items are pushed to the front end without users saving is the biggest issue that I need to resolve for this particular project/scenario..

Share this post


Link to post
Share on other sites
1 hour ago, Macrura said:

there is some sort of ajax save going on

That's correct. We use Ajax to avoid reloading the page (and potentially losing other unsaved work on the page).

1 hour ago, Macrura said:

The issue here is that the frontend is possibly updating to reflect that saved state of the field

Yes, it does.

1 hour ago, Macrura said:

With the current behavior, the newly added items appear on the front end prior to the user saving the page, and they found this to be unexpected behavior.

I'll have a think.  It would have to be configurable (in the field's settings) in order to preserve backward compatibility.  This means the default behaviour will be the current behaviour.

 

1 hour ago, Macrura said:

they don't know when/if an item is selected, as there appears to be no indicator of that at the row level, so they would select something

There are two visual indicators. One, the background of the selected (table) row is highlighted (light grey). The total number of items selected are shown at the top of the results. Maybe the light grey background is too subtle? Which Admin Theme are you using? 

1 hour ago, Macrura said:

Once they have an item selected, they need to scroll to the top of the modal window, and hit the plus button to get the item to add to the field

I got this feedback RE Media Manager as well. The only solution I could think of was floating add and remove buttons. I haven't gotten round to coding one yet.

1 hour ago, Macrura said:

saving the page with those items marked for trash (which would be the images field behavior) does not seem to remove them,

Yes, you are right, marking items for removal alone will not remove them.

1 hour ago, Macrura said:

so this inconsistency between similar looking fields is also causing confusion among the users.

I get your point, but I am not sure how to deal with this one. I don't want to change the behaviour now and break backward compatibility. I'll have a think whether to make this configurable as well, i.e. current behaviour (2-step process) versus "marked/selected image will be deleted on save";

Share this post


Link to post
Share on other sites

is there any way to add an attribute to the items that are added by ajax save so i can do a check on the front end, and that would solve that.. not sure, just thinking out loud.. Maybe i need to hook somehow..

This is using AdminThemeUIKit; i will check again to see if the background changes on this one.

Share this post


Link to post
Share on other sites
7 minutes ago, Macrura said:

This is using AdminThemeUIKit;

That's what I am using as well. I remember going back and forth with the background colour and settled for the grey to "fit the surroundings".

9 minutes ago, Macrura said:

is there any way to add an attribute to the items that are added by ajax save so i can do a check on the front end, and that would solve that.. not sure, just thinking out loud.. Maybe i need to hook somehow..

No there isn't and it still wouldn't work since the details are saved in the database like any other Pagefield. Reloading the page will just load what's already in the database. Making this configurable is the way to go. You would still see the added items in the inputfield, but if you reloaded the page without saving, the changes would be lost. How soon do you need this?

Share this post


Link to post
Share on other sites

no huge rush, configurable sounds cool.. thanks!

  • Like 1

Share this post


Link to post
Share on other sites
5 hours ago, Macrura said:

no huge rush, configurable sounds cool.. thanks!

OK, we have #1 configurable and working fine (Ajax Save Yes/No). The page is added to the inputfield but not saved to the field. Such pages can be re-positioned, edited, etc, just like the other saved pages. In the frontend, they do not show up since they are not saved to the field yet. On save, the pages are added to the field. If the page is manually reloaded without saving, these pages are not saved to the field. The only snafu is that when the pages are added to the modal, in case one is not using "Close Modal On Add Page", there is no visual indication (the light grey background on table rows or if using Thumbs View, the greenish border) that the pages are in the field, which sort of makes sense because they are not yet saved to the field. However, I think they should be presented as if they are in the field. I'm not sure how to resolve this atm. Thoughts? 

Thanks. 

  • Like 1

Share this post


Link to post
Share on other sites
4 hours ago, kongondo said:

The only snafu is that when the pages are added to the modal, in case one is not using "Close Modal On Add Page", there is no visual indication (the light grey background on table rows or if using Thumbs View, the greenish border) that the pages are in the field, which sort of makes sense because they are not yet saved to the field. However, I think they should be presented as if they are in the field. I'm not sure how to resolve this atm.

sounds tricky... not sure about that;  don't want to make it too hard for you, so hopefully this doesn't present issues... I do see the underlying snafus with the modal being a separate process which needs to communicate with the page and the field specifically to display status of the items in the lister... but i don't know enough about how that's working;

in the case of these users that i'm working with, they are flexible enough that if i explain how something works, they can handle some small amount of quirkiness here and there, so i can just let them know that the list won't really reflect which items are already in the field...

Share this post


Link to post
Share on other sites

Visual Page Selector version 006  (released (18/02/2019)

Happy to announce that the latest release of Visual Page Selector is now available for Download/Purchase.

Thanks to suggestions by @Macrura, this version includes a number of improvements one of which will require clients to relearn one thing (sorry).

Changelog

  1. Ajax vs Manual Save: You can now choose whether pages added to inputfield should be immediately saved to the pagefield (via Ajax) [the default behaviour] versus have them added in a sort of "pending state". If the latter, pages will be added to the inputfield (for visual purposes) but will not be saved to the pagefield until the page you are editing is manually saved. In the modal, visually, the pages are presented as if they are in the field (i.e. similar to pages saved in the field). In the inputfield, a pending page behaves like other pages saved in the field; they can be reordered, edited, etc. This feature has several advantages including the fact that changes can be made to the page without immediately being reflected in the frontend. Please note that reloading the page being edited without saving will discard pending pages!  The setting is in the Input Tab  (Modal Settings) when editing the field.
  2. Trash Icon: VPS Inputfield (Thumbs View) now behaves like a PW image field in relation to deleting pages in the page field. To delete an image from a PW image field, the process simply involves marking an image for deletion by clicking on its trash icon and saving the page. Previously, VPS (Thumbs View) has required two steps (in multi-page fields); first to mark an image for deletion by clicking on its trash icon and finally clicking on the remove icon (x). In single page fields, there was no icon altogether. It required clicking on the remove icon (x). Hence, these similar actions behaved differently from each other and from PW image fields (which VPS in Thumbs View seeks to emulate and enhance). With this update, VPS now behaves similar to PW image fields across the board. To remove pages from a pagefield using VPS, simply click on their trash icons and save the page. We have removed the remove icon (x). Unfortunately clients will have to be re-taught about this change but I think the benefits outweigh the inconvenience. 
  3. Modal Lister View: We've improved the visibility of pages selected for adding to a VPS inputfield. The light grey background did not provide enough contrast. We've gone for a light red (pink?). 
Edited by kongondo
  • Like 4

Share this post


Link to post
Share on other sites

wow awesome, thanks a million! Will get this downloaded and installed and let these particular users know, they will be happy!

Edit:  So how do i get this, i can't seem to find my order number, or the email receipt i was sent.. Also, i think my subscription expired?

Share this post


Link to post
Share on other sites
On 2/18/2019 at 5:46 PM, Macrura said:

So how do i get this, i can't seem to find my order number,

Please check your PM.

On 2/18/2019 at 5:46 PM, Macrura said:

i think my subscription expired?

In that case, you'll need to renew it here using the details I've sent you.

Thanks.

Share this post


Link to post
Share on other sites

Can't trash items in version 6 –  click trash on the item, save and it stays put.

Share this post


Link to post
Share on other sites
49 minutes ago, Macrura said:

Can't trash items in version 6 –  click trash on the item, save and it stays put.

That's very strange. It works here. PW version, PHP version?

Share this post


Link to post
Share on other sites

@Macrura

As you can see, it works here:

vps-version-003-inputfield-trash.thumb.gif.cd033e62e5a121688f64d54168e8cf08.gif

 

Does your version look like mine above? It needs JavaScript to work. I have a feeling your browser is serving the cached JavaScript files rather than the updated ones. Please clear your browser cache and/or test in incognito. Thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites

thanks, ok yes that was it, i force reloaded the page  (not in modal) and was able to uncache the js.

Share this post


Link to post
Share on other sites
14 minutes ago, Macrura said:

thanks, ok yes that was it, i force reloaded the page  (not in modal) and was able to uncache the js.

😉👍

Share this post


Link to post
Share on other sites

Very strange display issue here...

Images display correctly in list view...

2019-06-04_19-34-46_g7hzf.thumb.jpg.56b90b4335d5b94087ad0734afdee7c8.jpg

... but some images fail in thumbnail view:

2019-06-04_19-34-10_2x26e.thumb.jpg.c108877e6c92a476ecc5df3dbf0e438e.jpg

Any ideas?

Share this post


Link to post
Share on other sites
15 minutes ago, dynweb said:

Any ideas?

My mistake sorry. It is definitely related to this identical issue reported for Media Manager 🙂. I'll sort it out ASAP.

Thanks for reporting.

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