Jump to content

Recommended Posts

Hi @kongondo

For the moment I made some temporary additions to the MediaManagerActions.php file, so that it saves the title in all lang tabs. I added this lines to the code:

actionEdit()

foreach ($this->languages as $lang) {
		$p->title->setLanguageValue($lang, $sanitizer->text($media['title'])); //temporary by Nukro
}
//$p->title = $sanitizer->text($media['title']);

 

actionCreateMedia()

foreach ($this->languages as $lang) {
	$p->title->setLanguageValue($lang, $this->actionRenamer($title, $titleFormat)); //temporary by Nukro
}
//$p->title = $this->actionRenamer($title, $titleFormat);// @see @todo in actionRenamer()

 

I made this because my customer needs it urgently.

 

Greetings Nukro

  • Like 1

Share this post


Link to post
Share on other sites

Hi @kongondo

I am getting 

Empty file upload result

error upon upload. The file got uploaded though.

I am running 0.0.9

 

Thanks

Rudy

Share this post


Link to post
Share on other sites

Hi @Rudy. I think I have seen that error before in PW 3.X. I am not sure whether it is related to the PW version or if it is related to memory maxing out.

  • My guess is that your file is an image file? If so, then it is probably a large image and PW chokes on the thumb creation...due to memory issues.
  • Is the file added OK to your Media Manager library, i.e. it has a proper title, etc?
  • Were you uploading the single file or multiple files?

Please clarify these issues so that I can investigate further, thanks.

Share this post


Link to post
Share on other sites

Thanks for the lovely module, kongondo!

Before I commit, could you tell me if updating an existing image will create a new asset that must be re-linked, or can I overwrite an existing image and have all the proper associations update automatically?

(Sorry if this was already addressed, I tried to search for the answer but my keywords (overwrite/replace/existing) each only came up with talk of upgrading the module itself.)

Share this post


Link to post
Share on other sites

Hi @creativejay,

Thanks for your interest in Media Manager. Yes, that sort of update is supported. Change once, update everywhere  - no need to re-link; (but you would have to update any image variations yourself, of course). Please see point #5 in this post. Thanks.

Share this post


Link to post
Share on other sites

Hi @kongondo

Does the $config->pagefileSecure setting work with your module together? I tried it and it looks like it always blocks the access for guest users also when page(media) is published.

 

From a blog post about pagefileSecure:

Quote

"Added support for secured pagefiles. Now unpublished or non-public pages may have their files (in /site/assets/files/...) protected from direct URL access. You need to add $config->pagefileSecure = true; to your /site/config.php in order to enable this capability. Files become secured when the page is not accessible to the 'guest' role. Beyond roles, this also includes securing files for Unpublished pages. "

 

I have the feeling that it blocks always because the media pages live under the admin where no "guest" user has access? Am I right? Would it be possible to write a hook or something to support the pagefileSecure together with the Media Manager pages/files?

 

Greetings Nukro

Share this post


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

I tried it and it looks like it always blocks the access for guest users also when page(media) is published.

Isn't that exactly what $config->pagefileSecure is meant to do? According to the blog post you reference, it says the 'guest' role will not be able to directly access those files. In addition, I see this from the docs:

$config->pagefileSecure bool When used, files in /site/assets/files/ will be protected with the same access as the page. Routines files through a passthrough script.

Protection will match the same access as the page. I probably don't get your use case but it seems you want to have your cake and eat it too :lol:^_^. Do you want to secure your Media Manager media from guests? If yes, then the config setting is doing its job. MM files are secured from the public (guests).

I am guessing though that you want certain users with certain roles to still have access, no? In that case all you have to do is create a role, say 'view-mm-files' and add it to user(s) you want to have access to the files in the frontend. Then, head over to the respective MM media templates i.e. (media-manager-audio, media-manager-document, media-manager-image and media-manager-video) and under their Access Tab under 'What roles can access pages using this template (and those inheriting from it)?', under the column 'View Pages' check the box for 'view-mm-files (see screen below)'. That's it. No hook needed :). Those users (when logged in, of course) should be able to view protected files.

For the backend (i.e. use/view Media Manager) we already have the permission 'media-manager'. Just add that to the role you've created for your users, e.g. the 'view-mm-files' (as well as going through the above process of giving that role view access in the respective templates )and they should be able to both access Media Manager and see the media. 

 

 

mm-role-pagefilesecure.png

Edited by kongondo

Share this post


Link to post
Share on other sites

@kongondo

Sorry I somehow get confused now. To my understanding the pagefileSecure works like this:

pagefileSecure ON

      (The news template for example, which holds the image/file field has view access for guest users activated)

  • Guest User can't access unpublished/trashed image/document file with the direct url to it. 
  • Guest User can access published image/document files with the direct url to it.

      

      (the media-manager templates which holds the image/file field hasn't view access for guest users)

  • Guest User can't access any image/document file that comes from the media manager with the direct url to it.

 

pagefileSecure OFF

Guest User can access any(published/unpublished/trashed) image/document file (also the ones from the media manager) with the direct url to it (also the ones from the media manager).

Share this post


Link to post
Share on other sites

I somehow managed to delete the original post here when editing it :'(. Rather than rewrite it here, and since it was to feed into a write-up in the Media Manage docs, I might as well write it there. So, that's what I'll do. I'll find some time today and write that, er, write-up. I'll post a link here afterwards...

Edited by kongondo
Fat finger moment deleted my post!
  • Like 1

Share this post


Link to post
Share on other sites
2 hours ago, Nukro said:

Guest User can access any(published/unpublished/trashed)

A quick btw, in ProcessWire, by default, no users except for logged-in Superusers can view unpublished pages. 

Edited by kongondo

Share this post


Link to post
Share on other sites

Not true, any logged in user that has edit/view access can view a unpublished page not only superusers.

Add a page and upload a image. The image is in assets folder now and anyone can view that file in browser if you have the path. Even if you trash the page or unpublish page. This is where pageFilesecure comes in to avoid that.

Share this post


Link to post
Share on other sites

So i think thats the problem when enabling pageFilesecure. The files suddenly cant be accessed even if published and should be accessible for a guest user cause the pages under admin are protected. Im not sure how MM works. But maybe giving guest access to MM templates in admin could solve that but not sure what the consequences are.

  • Like 1

Share this post


Link to post
Share on other sites
20 minutes ago, Soma said:

Im not sure how MM works

Quick response lest I accidentally delete my post again! :lol:

There's two methods to access MM media (when pagefileSecure is off):

1. Indirect access; via its FieldtypeMediaManager API: $media = $page->your_media_manager_field; Returns a MediaManagerArray object. This will work regardless of the 'guest' setting in an MM template

2. Direct access: using normal PW API to reference the MM pages by their templates : $pages->find("template=media-manager-image, limit=10"); This will not work for guests unless access is granted in the template 'media-manager-image'

Keeping this short since I will be writing about this later tonight in MM's docs.

Share this post


Link to post
Share on other sites

Hi @kongondo

I have an suggestion about a new feature addition for replacing media. Would it be difficult to add a Message/Popup when the user is replacing media? At the moment it just replaces the media without a Warning Message or something like that. It would be a nice addition, since it is a risky move to let the users not know, that they have changed something, because they would replace media without noticing it. Also my customer become aware of this.

Greetings

Nukro

Share this post


Link to post
Share on other sites
3 hours ago, Nukro said:

At the moment it just replaces the media without a Warning Message or something like that.

Hi @Nukro,

Hmm, the default setting is to skip duplicate media. So, if media is being replaced the user must have set it so in the settings. A warning popup would just be an extra, to affirm what they've already set. I am not sure it will be easy/practical to implement since uploading is done via Ajax. I'll have a think. [Edit: should be easy enough as a checkbox to confirm before hitting upload :)]

By the way, I was not able to finish my write-up as promised in a previous post. I am determined to do this by the end of this week. Thanks for being patient with me.

Edited by kongondo
Clarification
  • Like 1

Share this post


Link to post
Share on other sites
On 27.2.2017 at 4:33 PM, kongondo said:

 [Edit: should be easy enough as a checkbox to confirm before hitting upload :)]

Hi @kongondo

Have you found some spare time to implement this feature?

Greetings Nukro

Share this post


Link to post
Share on other sites

Hi @Nukro,

I am afraid not. It's on my todo list though. Hope you can wait a bit longer, thanks.

Share this post


Link to post
Share on other sites

Hi Kongo,

 Does the capability exist that allows the admin user to select from the media manager if the standard file/image field types are being used elsewhere?

So for clarification, I am using a file and image field type and would like the ability for the user to select from both the default or the media manager gallery. This will allow me to use the existing fields without losing any of the images that already live in the assets folder.

Edited by RyanJ
I updated this and removed my original issue as it was user error.

Share this post


Link to post
Share on other sites

I'm interested in this module for a particular site but for it to be most useful I'd need to get all existing files into the manager first and then update fields to use it rather than the current file/images fields.

Is the module able to scan the contents of assets/files and copy them to wherever Media Manager accesses them from? Or does it do that automatically when you install it?

Share this post


Link to post
Share on other sites

Hi @Tyssen,

Thanks for your interest in Media Manager.

On 21/04/2017 at 6:29 AM, Tyssen said:

Is the module able to scan the contents of assets/files and copy them to wherever Media Manager accesses them from? Or does it do that automatically when you install it?

No, not at the moment. The module creates its own fields for the 4 media types (audio, document, image and media). Each media item is a hidden page in the admin under respective media manager parent pages. I have been mulling adding this type of scanning functionality but haven't made a decision yet. Having said that, the module can currently scan /site/assets/MediaManager/uploads/

Please let me know if I can be of further help.

  • Like 1

Share this post


Link to post
Share on other sites

Media Manager version 010  (released 28/04/2017)

Happy to announce the latest release of Media Manager.

Changelog

  1. As per this request, added option to confirm duplicate media overwrite on upload. This, obviously, only works when the setting Duplicate Media is set to overwrite existing media with the one being uploaded. If you have that option selected, you will see a new option 'Always confirm when replacing/overwriting duplicate media' in the Duplicate Media sub-section. Tick that and save if you want to use this option. On the Uploads Tab you should now see a 'Confirm Overwrite' checkbox toward the top right of that page. Unless that checkbox is ticked, you will not see 'Start' upload buttons.
  2. Made various strings used in success/error messages in JavaScript translatable

This latest version is now available for download

Screens

'Always Confirm Overwrites' setting

media-manager-confirm-duplicate-overwrite-setting.thumb.png.2d5d0cb287cf89361a2353e7b4e4adec.png

'Confirm Overwrites' checkbox unchecked

media-manager-confirm-duplicate-overwrite-1.thumb.png.743fb7418f0c92abb8f2503dbe05983d.png

'Confirm Overwrites' checkbox checked

media-manager-confirm-duplicate-overwrite-2.thumb.png.373662bbee913d43e2ff8822b2f27f13.png

Edited by kongondo
Added Screens, etc
  • Like 4

Share this post


Link to post
Share on other sites
On 7.1.2017 at 6:28 PM, kongondo said:

Hi @Rudy. I think I have seen that error before in PW 3.X. I am not sure whether it is related to the PW version or if it is related to memory maxing out.

  • My guess is that your file is an image file? If so, then it is probably a large image and PW chokes on the thumb creation...due to memory issues.
  • Is the file added OK to your Media Manager library, i.e. it has a proper title, etc?
  • Were you uploading the single file or multiple files?

Please clarify these issues so that I can investigate further, thanks.

Similar problem here, version 0.10

Empty file upload result

The first test images were uploaded without any problem. Then I tried to upload a bunch of images. Part of them were uploaded successfully, but not all.

Now:

1. i can't upload image files, also no small ones

2. files are not added to the library (but saved in the assets folder)

3. i'm trying to upload single files

Share this post


Link to post
Share on other sites
21 minutes ago, Metaphora said:

Similar problem here, version 0.10

Hi @Metaphora. Sorry about the problems you are experiencing. It's a bit difficult to debug this one. Can't tell whether the problem is because of your ProcessWire version, or the image type or the image size or your server environment.

  1. Are you able to test using the exact same images using ProcessWire 2.7? I am assuming you are using ProcessWire 3.x. 
  2. Are you testing locally or remotely? If the latter, do you notice any difference if you test locally?
  3. Server environment?
25 minutes ago, Metaphora said:

also no small ones

I am not sure what you mean by 'small ones'? Do you mean size of file or dimensions?

28 minutes ago, Metaphora said:

files are not added to the library (but saved in the assets folder)

Do you mean the assets folder and not a sub-folder? What are your upload settings? E.g. upload and add immediately to library or upload to be added later to the library after review?

Share this post


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

Hi @Metaphora. Sorry about the problems you are experiencing. It's a bit difficult to debug this one. Can't tell whether the problem is because of your ProcessWire version, or the image type or the image size or your server environment.

  1. Are you able to test using the exact same images using ProcessWire 2.7? I am assuming you are using ProcessWire 3.x. 
  2. Are you testing locally or remotely? If the latter, do you notice any difference if you test locally?
  3. Server environment?

I am not sure what you mean by 'small ones'? Do you mean size of file or dimensions?

Do you mean the assets folder and not a sub-folder? What are your upload settings? E.g. upload and add immediately to library or upload to be added later to the library after review?

1. PW version 3.0.61

2. local server

3. PHP Version 7.0.8 / Apache/2.4.18 (Ubuntu)

Quote

I am not sure what you mean by 'small ones'? Do you mean size of file or dimensions?

I tried small images (file size and file dimension), to make sure it's not a memory problem.

Quote

Do you mean the assets folder and not a sub-folder? What are your upload settings? E.g. upload and add immediately to library or upload to be added later to the library after review?

Image is uploaded to a mediamanager sub folder, also a thumbnail is generated.
Upload mode = default values
Upload without review.

Share this post


Link to post
Share on other sites
3 hours ago, Metaphora said:

Image is uploaded to a mediamanager sub folder, also a thumbnail is generated.
Upload mode = default values
Upload without review.

That's strange. Point #3 contradicts point #1. Media is only uploaded to that sub-folder if in the setting After Uploading you have selected option 3 (i.e., to keep media in a temporary folder until they have been reviewed). If you have option 1 or 2, the media is uploaded directly to the Media Library. Please confirm the option you have selected in this setting, just in case you are looking at a different setting from the one I am referring to, thanks.

Edit: Please also confirm that you have the latest version (005) Jquery File Upload

Edited by kongondo

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

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

Create an account

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

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
×
×
  • Create New...