Jump to content
justb3a

Module: Image Extra

Recommended Posts

hey, I didn't forget about these issues, just had to finish a client project first. sorry  :mellow: I added the fix for the missing javascript, please pull the develop branch. 

  • Like 3

Share this post


Link to post
Share on other sites

Thanks a lot for this modules. I used it in several projects and it always worked fine for me.

Today I ran into a strange bug. The Image Extra fields don't seem to be created in the database.

When I check the orientation field, or any other extra field it says:

SQLSTATE[42S22]: Column not found: 1054 Unknown column 'field_backgroundImages.orientation' in 'field list'

during page creation.

I looked up the the corresponding mysql table and yes, there is no field created.

could this be connected with the multilingual support? I set up a multilingual site on which english is not the default lang.

Thanks for your help.

Share this post


Link to post
Share on other sites

@pmichaelis: I don't think that it has to do with the multilingual site, this always works fine for me. And it doesn't matter whether english is the default language. `english` is just a label. Could you please try to rename the field so that it doesn't contain camelCase (capital letters)? For example field_backgroundImages to field_background_images. Have a look at the description: "Any combination of ASCII letters [a-z], numbers [0-9], or underscores (no dashes or spaces)." I don't  know whether this is the reason but I would like to give it a try. 

Edit: Tested it using a camelCaseField without any problems. Using two languages "default" and "english". But my system is case insensitive  ;). Which PW version do you use?

  • Like 1

Share this post


Link to post
Share on other sites

Could you please try to rename the field so that it doesn't contain camelCase (capital letters)?

Thank you! Your were right about the field renaming. Using PW 2.7.2. by the way.

Works like charm.

Share this post


Link to post
Share on other sites

Thank you justb3a for a wonderfull module of yours! It is indeed a nice tool to use instead of a Repeater or PageTable when they are an overkill.

I got similar issue as this. I understand your answer below, but I wish I could not use multilangual fields, even if I have Language Support and 2 languages installed. Is it possible?

My sites are often unilingual, but I do create additional language for admin to be able to work in default English admin interface, as all support you can get is in English (or should I say American to honor the creator of PW). I found no other way to do this (is there any?)

Share this post


Link to post
Share on other sites

I wish I could not use multilangual fields, even if I have Language Support and 2 languages installed. Is it possible?

My sites are often unilingual, but I do create additional language for admin to be able to work in default English admin interface, as all support you can get is in English (or should I say American to honor the creator of PW). I found no other way to do this (is there any?)

I added an option to disable multi-language fields. In field settings for Image Extra Fields there is a new checkbox "Disable multi-language fields?". Please pull branch develop to get this new feature.

btw: branch develop is ProcessWire 3.x ready but it needs a  bit more testing before I'll  create a new release.

  • Like 2

Share this post


Link to post
Share on other sites
It took some time but now it's possible to use a textformatter e.g. markdown parser. This is only available in branch develop for PW3.x.

There is a little issue due to focus textareas, I created a PR to solve this.

How to use it: go to field settings, enter some other fields, save. Reopen ImageExtra tab, now you can see a table below in which you can define one textformatter for each extra field. All installed text formatters will be listet in this dropdown.

post-2759-0-92009200-1464860053_thumb.pn

  • Like 4

Share this post


Link to post
Share on other sites

Is ImageExtra working in repeaters? I can't save the description and caption fields and also not delete the image. (see screenshot)

I use ImageExtra with an image slider on the same website and it is working fine. :)  But in this repeater it's not ...

So it seems I can't use an image in a repeater in this website?

(This would spoil the plan  :( )

Any ideas?

Thanks!

post-3713-0-84386400-1465725415_thumb.jp

Update:

Not sure if this has to do with ImageExtra at all. The whole repeater doesn't seem to work. If I put text in a text-field and save: the text is gone after saving. Don't know what is wrong here ...

Update: 

The problem is that these field dependencies don't work in repeaters. 

Sorry for blaming the Module  :rolleyes:

Thanks for the great work!

Share this post


Link to post
Share on other sites

hi @Henrik, glad you figured out yourself what caused the problem. I just wanted to test images in repeaters again. But I've got a lot of pages out there which are using images containing image extra fields inside repeaters!

  • Like 1

Share this post


Link to post
Share on other sites

I don't know if this is a known issue, but the orientation dropdown isn't working with the new image field from PW 3.0 and 2.8.
I tried the develop branch, but had no luck.

Anyway thx for this great module!

Edit: I just found out, that the dropdown is working in grid view, but not in list view
Edit2: none of the extra fields is working in list view

Share this post


Link to post
Share on other sites
On 11/12/2015 at 1:00 PM, adrian said:

Sorry for the delay in getting back to you regarding the error - I still need to look at this again, but for now I have a new problem for you :)

It looks like the Page Link option isn't working properly - it just shows a text input with "0" as the value.

Screen Shot 2015-11-12 at 9.59.43 PM.png

If I load "InputfieldPageListSelect.min.js" in the module, then it works as expected.

Screen Shot 2015-11-12 at 9.59.56 PM.png

Hello, would you mind to point how to do this, I get this very same error.

Thanks.

Share this post


Link to post
Share on other sites

My first time using this module - very cool. :)

For custom "additional" fields it would be nice to be able to set a field label as well as the field name, so field labels in the page editor can have spaces instead of underscores, etc. Maybe the field labels could be defined in the same table that is used for selecting TextFormatters?

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, Robin S said:

My first time using this module - very cool. :)

For custom "additional" fields it would be nice to be able to set a field label as well as the field name, so field labels in the page editor can have spaces instead of underscores, etc. Maybe the field labels could be defined in the same table that is used for selecting TextFormatters?

Big +1 for this - sometimes it can be very hard to explain what should go in a field without a label.

  • Like 2

Share this post


Link to post
Share on other sites

I thought about this feature as well from time to time :). There is a new version 1.0.1 which fixes some PHP7 issues and adds the possibility to set custom labels for each extra field. It also supports multi-language usage. Furthermore I changed the way the extra fields (form) are rendered. Now you can click a tab and briefly hold (aka long-click) it and all extra fields will switch to that language. And I removed the checkbox for the caption field. If it was set, it will be added as first item in the `other fields` input field.

Screen Shot 2016-10-05 at 17.07.25.png

 

Screen Shot 2016-10-05 at 17.07.09.png

 

  • Like 6

Share this post


Link to post
Share on other sites

This looks awesome @justb3a - thank you!

While you're on a roll, I don't suppose you'd like to add the ability to define the width of custom fields so we can float them on one line?

The other thing that would really help would be an options type field with select/radios/checkbox options.

Sorry, I know that's a lot - just a wishlist :)

  • Like 1

Share this post


Link to post
Share on other sites
5 minutes ago, adrian said:

While you're on a roll, I don't suppose you'd like to add the ability to define the width of custom fields so we can float them on one line?

haha, I tried this today but $field->columnWidth = 50; has been ignored. So I guess I need to change the whole markup, wrap the fields inside a list or something like that. Today I just wanted to finish the other feature and didn't investigate further. But I keep it in mind. Furthermore I won't add another column for the widths of a field, I would prefer to set it to 50. Otherwise I've to add one more column to define the number of rows the textarea should be – for each field.

 

13 minutes ago, adrian said:

The other thing that would really help would be an options type field with select/radios/checkbox options.

I know... There is a github issue for this as well. For now I got no good idea how the interface / structure could look like – it has to be as easy as possible for the user to add / remove / manipulate the fields. Maybe a simple input field where the user is able to add all option fields (comma-separated). Once the module settings has been saved one more table could appear. In this table the user could be able to set a type (select, radio, checkbox) and the options (comma-separated input). But what about multi-language labels and options? ??? This would blow up the whole settings a lot... If you have a good idea, just let me know!

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for your thoughts on those.

I have a couple of weird things for you.

Now even with description field rows set to 0 I still get a label for the Description field.

Also, the input>text fields are now textarea fields - I think it looks kinda weird when you only want simple setting entries.

Screen Shot 2016-10-05 at 10.02.49 AM.png

Share this post


Link to post
Share on other sites

Thanks @justb3a for the updates, it's getting better and better!

There's a PHP notice in the new release:

PHP Notice: Undefined index: otherField in .../site/modules/ImageExtra/ImageExtra.module:992

If you use Tracy Debugger it's easy to spot.

Share this post


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

I have a couple of weird things for you.
Now even with description field rows set to 0 I still get a label for the Description field.
Also, the input>text fields are now textarea fields - I think it looks kinda weird when you only want simple setting entries.

You're right. The check whether to show the description label or not missed a condition. Since adding the opportunity to add textformatters I changed InputfieldText to InputfieldTextarea. Textformatters like Newlines to Unordered List doesn't make that much sense if you aren't able to add line breaks. I added a condition: all fields default to InputfieldText except the fields which got a textformatter assigned. I'm not that happy with the layout/styles right now. I need to invest some more time optimizing the layout.

3 hours ago, tpr said:

There's a PHP notice in the new release:

You're right, too. I missed the following scenario: checked captionField but added no otherField.

The fixes are merged into the master branch :)

  • Like 3

Share this post


Link to post
Share on other sites
5 minutes ago, justb3a said:

Since adding the opportunity to add textformatters I changed InputfieldText to InputfieldTextarea. Textformatters like Newlines to Unordered List doesn't make that much sense if you aren't able to add line breaks.

I understand the thinking here, but agree with @adrian that often you want a single line input rather than multi-line. I know you want to avoid an overly-complicated interface but perhaps there could a "Rows" input for additional fields like for the Description field?

Share this post


Link to post
Share on other sites
1 minute ago, Robin S said:

I understand the thinking here, but agree with @adrian that often you want a single line input rather than multi-line. I know you want to avoid an overly-complicated interface but perhaps there could a "Rows" input for additional fields like for the Description field?

But:

9 minutes ago, justb3a said:

all fields default to InputfieldText except the fields which got a textformatter assigned

I am pretty happy with this solution - works for me anyways!

Share this post


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

 

10 minutes ago, justb3a said:

all fields default to InputfieldText except the fields which got a textformatter assigned

I am pretty happy with this solution - works for me anyways!

Myself, I add SmartyPants and HTML Entity Encoder textformatters to all text fields.

  • Like 1

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By ukyo
      FieldtypeFontIconPicker
      v.0.1.6
      Fix FieldtypeFontIconPicker sanitizeValue() v.0.1.5
      Added uikit icon select support (required AdminThemeUikit), because uikit icons not working standalone. v.0.1.4 :
      Fix issue FontIconPicker inside repeater v.0.1.3 :
      FontAwesome updated to 4.7.0 v.0.1.2 :
      Little Corrections Some works about icon pickers inside repeater via ajax load v.0.1.1 :
      FontAwesome updated to 4.6.3 v.0.1.0 :
      Custom CSS file url support Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.9 inside dev branch
      Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.8
      FontAwesome 4.5 update, Improvements and Performance updates Important ! After update module check your input settings, because i changed input attribute names (This will only effect input options, like theme, category). Changed loading icon method from input:hidden to select>optgroup>option, added module js file for load and correct icon picker container many changes…. v.0.0.7
      FontAwesome updated to 4.4.0 v.0.0.6
      Missed... array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.5
      Fix for oldest pw versions (Assets file loding scripts moved to inputfieldfonticonpicker module) v.0.0.4
      Array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.3
      Small z-index problem solved v.0.0.2
      MarkupFontIconPicker added v.0.0.1
      Start Point FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.0 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Example :
      if($my-icon-field) echo "<i class='my-prefix-{$my-icon-field}' />"; Hook Before Render Example This example using /site/templates/admin.php file for hook
      wire()->addHook('InputfieldFontIconPicker::beforeRender', function($event) { if(!$event->return) return; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) $inputName = ""; if(isset($event->object->attributes['name'])) $inputName = $event->object->attributes['name']; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) if($inputName == 'icon_picker') { /** * Load your custom icons function file * Your array need to be same format with Icons/FontAwesome.php or Icons/Ionicons.php * Also you can pass directly an array */ wireIncludeFile('MyCustomIconFile'); // Set icons as $icons variable $icons = MyCustomIconsArray(); // Set your options $return = array( 'attributes' => array( 'category' => '', 'theme' => 'fip-grey', 'empty-icon' => 1, 'empty-icon-value' => '', 'icons-per-page' => 20, 'has-search' => 1 ), 'icons' => $icons ); // Return the event $event->return = $return; } $event->return; }); MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Screenshots - InputfieldFontIconPicker input settings



      Screenshots - InputfieldFontIconPicker page edit views


       
      Github Repo
    • By Xonox
      After some years with a website working perfectly, Page Clone started to display some strange behaviour:
      1. When cloning some pages, it takes forever. The waiting icon is displayed but the page never appears. Only after I refresh the tree page, the new page appears:

      2. The other thing is that some pages can't be copied. The pages have the same templates but the users are able to copy some and other don't. It gives this error:

      (the URL is .../page/clone/?id=76376&login=1)
      Does someone have a clue why this is happening. I can't find any real difference between the pages that I'm trying to copy.
      One more thing: If the user is a super user, he's able to copy every page without problems.
      I think both errors might be related. Thanks!
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • 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.4.2
      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
       
       
×
×
  • Create New...