Jump to content

Recommended Posts

Ok, now that files are flying like flies (heh heh), I think I will focus to next version of AdminBar, but will also try to implement Aloha Editor module.

I will start from Ryan's code and concept above. Idea is that Aloha Editor would play nice with or without AdminBar. If you have AB installed, then it would use the same UI.

Share this post


Link to post
Share on other sites

Current dev version of AdminBar gives a nasty js alert on IE9 (not sure about earlier ones): "Load jQuery first!". It happens occasionally when clicking "Edit page" link. Not everytime, but about 50% of times.

It comes from tiny_mce.js file. I changed that part from:

return alert("Load jQuery first!");

to

return false;

and everything seems to be running smoothly. I assume that jQuery is needed for those link & image modals? If so, then silent fail here should be ok, since it won't take long that jQuery gets loaded (those works in my tests even when I get the alert). IE9 seems to have many bugs related to how it loads javascript files, and this is probably just one of those. Whatever the reason is, it seems that occasionally in IE9 and using Adminbar, tinymce gets loaded before jQuery.

In the other news: for some reason removing pages from AdminBar works now (I haven't done anything, and it didn't work in 2.0). It redirects to /processwire/ after deleting (I think that is good solution here).

Share this post


Link to post
Share on other sites

mmm...i'm trying to use this adminbar but when editing a page i get this error:

Template '/home/processw/public_html/site/templates/' is not allowed

If i edit the page via admin it works.  :-\

Share this post


Link to post
Share on other sites

Ryan, I took your code and started taking it further. It is very good start and not much to do really. I have Aloha editor floating around my content already and I am starting to implement the saving.

<?php

    public function format(&$str) {
        if(!$this->page->editable()) return;
        $str = "<div id='fieldname' class='aloha-editable'>$str</div>";        
    }

Is there any easy way to get that id='fieldname' to textformatter? So does the textformatter know what is the field name that uses it? Fieldname is something that I wanna know, when I save the edited content, isn't it?

PS: testing this made me think that there probably will be some issues using Aloha on front and TinyMCE on the back. Not sure though? If they both provide clean enough output, then it will work. Need to test this well after this is ready.

PPS: http://drupal.org/node/1018352 (it seems to be much harder to implement on drupal - not a surprise though, but interesting read)

Share this post


Link to post
Share on other sites

Played more with Aloha:

  • Since Aloha makes only one instance for multiple editables (which is great for performance), it makes this harder to implement. We need to strip functionality based on what kind of field is edited (textarea or just text). We don't want to allow adding headers inside of header etc. There probably are methods on Aloha API that let us do that. If not, then we have to live with it or just use very bare bones version of Aloha (inline elements only).
  • Editing feels very fast and natural. Now I want to also drop images to the website :)
  • I already implemented this to play nicely with AdminBar - it adds new button to Adminbar, if you have it installed (Quick Edit). And after you start editing content, there appears second new button: "Save Aloha" which gives you a nice little alert with all the editable content.

Share this post


Link to post
Share on other sites
Is there any easy way to get that id='fieldname' to textformatter? So does the textformatter know what is the field name that uses it? Fieldname is something that I wanna know, when I save the edited content, isn't it?

I've just depreciated the Textformatter::format($str) function in favor of Textformatter::formatValue(Page $page, Field $field, $value). I guess I didn't consider the things we'd be using Textformatter for in the future. :) But it should be ready to go now. Just grab the latest commit and implement the 'formatValue' version rather than the 'format' version in your Textformatter module. You can now get the field name from $field->name.

Since Aloha makes only one instance for multiple editables (which is great for performance), it makes this harder to implement. We need to strip functionality based on what kind of field is edited (textarea or just text). We don't want to allow adding headers inside of header etc. There probably are methods on Aloha API that let us do that. If not, then we have to live with it or just use very bare bones version of Aloha (inline elements only).

I see what you mean, though am surprised they don't provide built in capability to deal with single-line (titles) vs multi-line (textareas) markup. We could always strip paragraph and heading tags from the single line fields.

PS: testing this made me think that there probably will be some issues using Aloha on front and TinyMCE on the back. Not sure though? If they both provide clean enough output, then it will work. Need to test this well after this is ready.

So long as they are both dealing with the same kind of markup tags, I think we'll be fine here. Though not positive.:)

I'm excited to see how this goes!

Thanks,

Ryan

Share this post


Link to post
Share on other sites
Title fields - I was too pessimistic, even one of their examples have different options for title

Not sure I understand? Looks like this is one giant field to cover the entire page. :) Pretty impressive with the 3 columns actually. That's not something I'm used to seeing in HTML. Definitely not something I've seen in TinyMCE. This 1-giant-field for the entire page is probably not something you'd see much of in the real world, beyond a demo.

Aloha seems pretty useful even if just used for multiline fields. Though it'd be great if it had some option to place limits on the markup a user can use, for single line fields at least. But I don't see anything like that, looking through their site. We can always just strip the block-level stuff.

Share this post


Link to post
Share on other sites

If you click the big "Moby Dick" header, then you can only add links, not change formatting at all. Exactly what we want to do with headers (probably many times want to disable links too...).

The 3 columns is simple stuff, using vendor specific css:

-webkit-column-width: 300px;
-webkit-column-gap: 30px;
-moz-column-width: 300px;
-moz-column-gap: 30px;
width: 960px;

Share this post


Link to post
Share on other sites
If you click the big "Moby Dick" header, then you can only add links, not change formatting at all. Exactly what we want to do with headers (probably many times want to disable links too...).

Pretty cool!  Somehow I completely missed that, thinking it was a background image or something.

The 3 columns is simple stuff, using vendor specific css:

Nice, I've not experimented with the multi-column stuff... looks interesting.

Share this post


Link to post
Share on other sites

Just realized that aloha.js is almost 1 meg javascript minified... it has jquery build in, but also ExtJS. That does complicates things (I had this first loading in admin also, and earlier version (I assume) of jQuery was messing things up...). It would be real problem on front end to make sure that your site jQuery or ExtJS (if you use either one) is always the same version than Aloha requires... There was aloha-nodeps.js included, but need to add ExtJS and jQuery separately then. It just feels damn bloated for such a "small" functionality (I really want to have quick edits and save).

This made me thinking of building super simple editor by myself (there is nice html5 API for that too). Or might add some other light weight editor (I don't consider aloha a light weight anymore)... Not sure though and will definitely take Aloha further and test it more (make it save stuff).

What do you guys think? What are the features you are expecting from "quick editing"? Just editing text & save? Strong, italics? Headers? Links? Images?

Share this post


Link to post
Share on other sites

Just realized that aloha.js is almost 1 meg javascript minified... it has jquery build in, but also ExtJS. That does complicates things (I had this first loading in admin also, and earlier version (I assume) of jQuery was messing things up...). It would be real problem on front end to make sure that your site jQuery or ExtJS (if you use either one) is always the same version than Aloha requires... There was aloha-nodeps.js included, but need to add ExtJS and jQuery separately then. It just feels damn bloated for such a "small" functionality (I really want to have quick edits and save).

I also was shocked about the 1meg. Quite a bummer. ExtJS alone is beyond imaginable, and that just for quick edits. Let alone the complications that can occur. Well it would be possible to run your site jQuery in a seperate namespace and make sure your JQ loads before Aloha ones... headache granted – Well in first place I was also thinking about doing something simple self brewn, that fits into PW. Just discovered Aloha few days ago. I thought it may usable but also sensed it may overkill and too akward to implement, use. Not to mention depend on it.

This made me thinking of building super simple editor by myself (there is nice html5 API for that too). Or might add some other light weight editor (I don't consider aloha a light weight anymore)... Not sure though and will definitely take Aloha further and test it more (make it save stuff).

What do you guys think? What are the features you are expecting from "quick editing"? Just editing text & save? Strong, italics? Headers? Links? Images?

Yeah images would be extasic.

Lists? Small? Paragraph?

Are you planning writing a wysiwyg in this case? Or using tinymce?

Also what are you seeing will be the way to define what fields are editable on page? Something that's controlled in by the template file would be cool.

BTW: I already hear a "Oooooh! my text is screwed, I copied from Word into the page!"

Share this post


Link to post
Share on other sites

I spend few hours last night to read about contenteditable and how to implement simple js rich text editor. It sounds simple (browsers have it built in, since IE 5.5 - then reverse engineered from there to other browsers). But (and pretty big but) - the implementation is very messy. Gotta respect TinyMCE & Co more, that is actually super messy stuff that different browsers provide (I tested just chrome, ff and opera) and amazed that there has been so little progress on that area. This being said I don't think I have time (or skills) to build solid rt-editor from scratch.

I started to look if there is any library that can clean the html (I found some stuff to clean word pasting) that different browsers provide and make them similar in each, but no luck there. Maybe I could loan some parts from other projects (if their licencing allows) if it possible. Not sure though.

If someone finds simple editor, that provides about the same markup and can be added to any element (not just textarea), that would be great. If not, I probably continue with Aloha and try to do my best with multiple jQuery versions.

Share this post


Link to post
Share on other sites
Just realized that aloha.js is almost 1 meg javascript minified... it has jquery build in, but also ExtJS.

Wow that's surprising... rather bloated for what it does. On the other hand, every one of their demos has loaded fast and I would have never guessed about the file size. So maybe it's not the issue that it appears to be at first, given that it's for admin rather than public users. I'm just thankful for browser JS caching.

When it gets down to it, all web-based rich text editors seem problematic for one reason or another. It's always a compromise… just the nature of the beast I guess.

Share this post


Link to post
Share on other sites

Yep. After reading more about how contentEditable/designMode work (most of the editors use designMode - textarea goes into iframe) and how buggy the support is, then it is not surprise that there are so much issues. Add in tons of features, many different use cases (copy from word, from another website, undo button etc), normal browser rendering differencies, then it will be clear that it's not a simple case. And aloha-editor does use contentEditable instead of designMode, which seems to be even more buggier.

But it seems that Aloha is the best (only inline editor?) there is currently so I will continue with that.

Share this post


Link to post
Share on other sites

It does look interesting–good find. I couldn't get their demo to work (in the latest Chrome, other than the nav bar at the top), but am curious about it. Have you tried it out or had any luck getting it to work?

Share this post


Link to post
Share on other sites

It does work. Not the whole page is editable, only left sidebar and bottom at the middle column. Editable areas have blue outlines.

Share this post


Link to post
Share on other sites

Strangely I couldn't get it to work before (must have been something up with my browser). It works great now. Seems like quite a nice solution they've got here. What's your opinion of this vs. Aloha?

Share this post


Link to post
Share on other sites

Not sure yet. After playing a while with Aloha the floating bar starts to annoy a little. The more I use the more I wish it wouldn't float. It's true that you can lock the aloha position, but you would do that always depending on the placement. "Always on top" feels more solid and it is what we (and our clients) have used to. Word doesn't have anything floating around.

This is just a gut feeling, but Mercury also feels like better coded, and better documented (not much, but there is nice annotated source: http://jejacks0n.github.com/mercury/annotated_source/mercury.html) it has cleaner licencing and uses only jQuery (where aloha uses jQuery & ExtJS). So far it feels like Mercury would be better, but it is more just a feeling than anything. I really need to dive deeper to know which one suits better.

Share this post


Link to post
Share on other sites

I'm on the same wavelength. I already after 1 minute of aloha, thought the floating thing is annoying... I really like the top bar of mercury. I would chose it. Just my 2 cents.

Share this post


Link to post
Share on other sites

I agree. I think Aloha is being marketed better, but Mercury seems like the better product based on my relatively brief experience with them. Though Aloha's massive size weighs heavily on my impression too. :)

Share this post


Link to post
Share on other sites

Few minor additions to AdminBarNew (I will soon switch that as a master and leave 2.0 adminbar as a legacy branch):

  • Only show add page button when adding pages is allowed (thanks Soma!)
  • Show lock icon with description text when editing is not allowed or page is locked - instead of hiding the bar totally
  • Added js files to bottom instead of head - will work even if you load your jQuery at bottom (and you might wanna do that for performance reasons)

Share this post


Link to post
Share on other sites

Added "adminbar" permission (other roles than superuser needs that, otherwise they won't see adminbar).

If anyone got the last version, you might wanna update. Just realized that it probably did show adminbar for everyone (guests too).

This (AdminBarNew branch) feels pretty stable now, but please report any issues to GitHub or here. I wanna keep this as slim as possible. Probably only new feature that I will add is logout-button that Soma suggested at GitHub. While testing aloha editor I realized that it is super simple to extend adminbar from additional modules, so that is the way I take with new ideas (and hopely others want to extend AdminBar too).

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 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
       
       
    • By Robin S
      Sanitizer EasySlugger
      Allows the use of the EasySlugger library as Sanitizer methods.
      Installation
      Install the Sanitizer EasySlugger module.
      Usage
      The module adds four new sanitizer methods.
      slugger($string, $options)
      Similar to $sanitizer->pageName() - I'm not sure if there are any advantages over that method. Included because it is one of the methods offered by EasySlugger.
      $slug = $sanitizer->slugger('Lorem Ipsum'); // Result: lorem-ipsum utf8Slugger($string, $options)
      Creates slugs from non-latin alphabets.
      $slug = $sanitizer->utf8Slugger('这个用汉语怎么说'); // Result: zhe-ge-yong-han-yu-zen-me-shuo seoSlugger($string, $options)
      Augments the string before turning it into a slug. The conversions are related to numbers, currencies, email addresses and other common symbols.
      $slug = $sanitizer->seoSlugger('The price is $5.99'); // Result: the-price-is-5-dollars-99-cents See the EasySlugger readme for some more examples.
      seoUtf8Slugger($string, $options)
      A combination of utf8Slugger() and seoSlugger().
      $slug = $sanitizer->seoUtf8Slugger('价钱是 $5.99'); // Result: jia-qian-shi-5-dollars-99-cents $options argument
      Each of the methods can take an $options array as a second argument.
      separator (string): the character that separates words in the slug. Default: - unique (bool): Determines whether a random suffix is added at the end of the slug. Default: false $slug = $sanitizer->utf8Slugger('这个用汉语怎么说', ['separator' => '_', 'unique' => true]); // Result: zhe_ge_yong_han_yu_zen_me_shuo_3ad66c4  
      https://github.com/Toutouwai/SanitizerEasySlugger
      https://modules.processwire.com/modules/sanitizer-easy-slugger/
    • By Robin S
      If you've ever needed to insert links to a large number of files within CKEditor you may have found that the standard PW link modal is a somewhat slow way to do it.
      This module provides a quicker way to insert links to files on the page being edited. You can insert a link to an individual file, or insert an unordered list of links to all files on the page with a single click.
      CKEditor Link Files
      Adds a menu to CKEditor to allow the quick insertion of links to files on the page being edited.

      Features
      Hover a menu item to see the "Description" of the corresponding file (if present). Click a menu item to insert a link to the corresponding file at the current cursor position. The filename is used as the link text. If you Alt-click a menu item the file description is used as the link text (with fallback to filename if no description entered). If text is currently selected in the editor then the selected text is used as the link text. Click "* Insert links to all files *" to insert an unordered list of links to all files on the page. Also works with the Alt-click option. Menu is built via AJAX so newly uploaded files are included in the menu without the page needing to be saved. However, descriptions are not available for newly uploaded files until the page is saved. There is an option in the module config to include files from Repeater fields in the edited page. Nested Repeater fields (files inside a Repeater inside another Repeater) are not supported. Installation
      Install the CKEditor Link Files module.
      For any CKEditor field where you want the "Insert link to file" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "LinkFilesMenu" to the "CKEditor Toolbar" settings field.
       
      http://modules.processwire.com/modules/cke-link-files/
      https://github.com/Toutouwai/CkeLinkFiles
×
×
  • Create New...