Jump to content
Wanze

ProcessGoogleAnalytics

Recommended Posts

Hi!
Just finished my first module :)
This module adds a new "Google-Analytics" Page in your Admin-Panel and displays various Statistics from a Google Analytics Account.
It uses the JQuery plugin "jqplot" to display the charts.

post-582-0-13454000-1344773004_thumb.pngpost-582-0-53154400-1344773005_thumb.pngpost-582-0-49753600-1344773006_thumb.png

Github: https://github.com/w...GoogleAnalytics
Modules directory: http://modules.proce...ogle-analytics/

Features

  • Visits by Date (Chart)
  • General Statistics about Visits (Total visits, Visit duration, New visitors, Returning visitors etc.)
  • Demographics: Countries, Cities, Languages
  • System: Browsers, Operating Systems, Screen Resolutions
  • Mobile: Operating Systems, Screen Resolutions
  • Pageviews by Date (Chart)
  • Top Content
  • Traffic Sources: Keywords, Referral Traffic by Domain and URI
  • Choose a default date range displaying statistics: last 24 hours, 2 days, 1 week, 1 month etc.
  • Custom date range by setting a "start date" and "end date"

Requirements

  • Google Account and Analytics Account :P
  • A Project in the Google APIs Console
  • cURL

Installation

1) Create a Project in the Google APIs Console:

  • Create a new Project in the APIs Console: code.google.com/apis/console/
  • Under Services, enable the Analytics API
  • Under API Access: create an Oauth 2.0 Client-ID
  • Give a Product Name, choose "Web-Application", Domain doesn't matter
  • Enter a Redirect URI to the GA-Page in your Processwire Installation:
    http://yourdomain.com/processwire/google-analytics/

Notes:

  • The redirect URI must exactly match with the URL from the new "Google Analytics" page in Processwire. Open the Page and copy the URL from the address-bar (localhost does work too!)
  • The project created in the APIs Console can be reused for every Processwire installation using this module. You just have to enter more redirect URIs

2) Install the module:

  • Place the module's files in /site/modules/ProcessGoogleAnalytics
  • Install the Module via the Admin-Panel
  • Enter Client-ID and Client-Secret keys from the created project in the module config
  • Load the newly created page "Google-Analytics" and click on the button "authenticate"
  • Grant the module access to the Analytics Data
  • Choose a Google Analytics account (Domain) from the dropdown
  • Done: You should see the statistics. Check out the module config options for further customization

In order to let other users see the Google Analytics page, you must give their role access to the "ga-view" permission.

Ps. Processwire is awesome and so is this community! :)

  • Like 29
  • Thanks 1

Share this post


Link to post
Share on other sites

Awesome! I also wanted to do something similar but didn't really get into it. Looks very nice! Thanks for posting.

Would you mind to put it on modules.processwire.com and create a repository on github?

Share this post


Link to post
Share on other sites

Whoa! Looks amazing and very useful module. Will definitely try this soon!

Share this post


Link to post
Share on other sites

I just drooled on my keyboard.

I'll be installing this one on my sites definitely!

Share this post


Link to post
Share on other sites

Thank you guys!

In the meanwhile, the Project is on Github and the modules overview:

http://modules.processwire.com/modules/process-google-analytics/

https://github.com/wanze/ProcessGoogleAnalytics

I never used Github before and had to create an account first, thanks Soma for your Tutorial!

Still I'll have to explore git a bit more ;-)

Please let me know what you think and if it works for you!

One feature that is on the Roadmap:

Compare the statistics taken from the last month (Audience) with the previous month and show +/- percentage

  • Like 3

Share this post


Link to post
Share on other sites

Wanze, welcome to the forums!

Great start! I tried your module on my localhost and it seems to work, though I don't have any statistics here.

When I load the Google Analytics page for the first time I get several notices:

Notice: Undefined index: ga:returningVisits in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 227
Notice: Undefined index: rows in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 298
Notice: Undefined index: rows in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 299

But they dissapear after I refresh the page, so I guess it has something to do with caching.

Also after installation I get this notice untill I've filled all fields and saved:

Notice: Undefined index: accountId in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 877

And also for some reason it breaks page encoding (cyrillic symbols don't display properly).

Wanted to mention you can specify what modules are required by your module and what modules it installs in the array returned by getModuleInfo():

return array(
'title' => '',
'version' => 001,
'summary' => '',
'requires' => 'MarkupCache',
'installs' => 'MarkupCache', //not sure about this one
);

Not sure though whether it should require or instead maybe install MarkupCache, I guess it shoud just require it. See more here.

Thank you for your module! I've never dealt with GA before, and I guess now's the time :)

  • Like 1

Share this post


Link to post
Share on other sites

This is great! Really cool stuff going around lately!

Share this post


Link to post
Share on other sites

Just installed this one and it works like a charm! Really nice and very polished work. Very nice that it is already multilang friendly!

Few ideas for further development:

  • There are quite a lot stuff on screen. It might be nicer UI if you would use tabs instead of folding for main categories (audience, content, traffic sources)
  • Showing current month is what I usually want, but it would be nice to have ability to choose date range
  • Link to Google Analytics when you want to dive deeper into the analytics
  • Consider using strftime instead of date - that would allow local month names etc for other languages than English. Not necessary though, since one could always define numeric only dates (like 9.8.2012) http://www.php.net/manual/en/function.strftime.ph
  • Like 3

Share this post


Link to post
Share on other sites

Awesome module and really nicely produced! Thanks for making this.

I ran into a couple really minor things, but figured I'd mention them before I forget. :)

1. Saw a couple PHP notices at the top of the screen, but can't remember exactly at what part. However, I'm guessing anyone with debug mode on will see the same.

2. Getting an overflow on the search keywords screen:

post-2-0-05364600-1344521418_thumb.png

Great job with the module and the code.

  • Like 1

Share this post


Link to post
Share on other sites

Thank you all for testing and the feedback!

I'll fix the PHP warnings with the notices, maybe this will also sort out the

problem with cyrillic symbols.

2. Getting an overflow on the search keywords screen:

post-2-0-05364600-1344521418_thumb.png

Ryan, I guess this is caused by a long keyword without spaces?

Just installed this one and it works like a charm! Really nice and very polished work. Very nice that it is already multilang friendly!

Few ideas for further development:

  • There are quite a lot stuff on screen. It might be nicer UI if you would use tabs instead of folding for main categories (audience, content, traffic sources)
  • Showing current month is what I usually want, but it would be nice to have ability to choose date range
  • Link to Google Analytics when you want to dive deeper into the analytics
  • Consider using strftime instead of date - that would allow local month names etc for other languages than English. Not necessary though, since one could always define numeric only dates (like 9.8.2012) http://www.php.net/m...ion.strftime.ph

Great ideas!

Trying to implement all of this in the next versions.

I originally also wanted to use Tabs for the main sections, but I think

the charts have some problems rendering correctly if they're in a hidden div,

so I went with this simpler solution. But you're right, there is definitely too much on the screen right now!

Now it's time to find some examples using WireTabs :)

Share this post


Link to post
Share on other sites

Great! WireTabs are super simple and work just like those other wrappers. Also simpler solution might be to just collapse others than first section.

Share this post


Link to post
Share on other sites

It's also just fine to use jQuery UI tabs if you prefer. WireTabs are mainly useful for tabbing PW's Inputfields, which jQuery UI tabs don't let themselves as well to.

Share this post


Link to post
Share on other sites

Just updated the Module to version 1.1 on Github and Modules Section of Pw!

New Features / Optimizations

  • Better UI with tabs for the main categories (Audience, Content, Traffic sources)
  • New options section: You can change the date range for your Statistics
  • "strftime" used instead of "date" for the date range in header
  • Fixed PHP notice errors

There changed some module default config options + I added an option to set the format for the InputfieldDatetime fields. So I guess you should uninstall and install the whole module again to avoid errors.

Sometimes I'm not sure if use the right words for my lables and descriptions, as I'm not a native english speaker/writer.

So if anybody sees typo errors or a description that makes no sense, please tell me.

It's also just fine to use jQuery UI tabs if you prefer. WireTabs are mainly useful for tabbing PW's Inputfields, which jQuery UI tabs don't let themselves as well to.

I ended up using WireTabs, amazing simple to implement as everything with Processwire! =)

Wish you all a nice day (night or whatever), I'm going swimming now here :P :

http://www.bbc.co.uk...europe-10893835

  • Like 3

Share this post


Link to post
Share on other sites

Great update! I love the way it works with the tabs now. Not seeing the overflow issue anymore either. This covers about 90% of the things I use GA for. This module will get a lot of use for sure. :)

Share this post


Link to post
Share on other sites

Thank you Ryan, glad you like it!

Do you think I could implement the missing 10% somehow? :)

What do you think about resetting the custom dates?

Currently you have to check a checkbox to reset, afterwards the Module is using again the last month from today as date range (default behaviour).

Should this reset be done automatically after some time?

Share this post


Link to post
Share on other sites

I don't see any error on your screenshot, only notices and warnings. May because debug enabled? Wanze you don't have debug on?

Share this post


Link to post
Share on other sites

Nice module, but i got lots of errors, please look at the attachment.

Hmm for some reason the module could not fetch the statistics. I need to implement a check if the results are returned correctly as an array and display an error message otherwise.

Sevraf2, were you able to choose the GA Account from the dropdown before?

Have you customized the date range or any date format settings?

Can you do some checks in the module config options:

  • Client ID, Client Secret, API Key correct?
  • Google Analytics Account Id should now have a value like "ga:xxxxxxxx"

@Soma

I have debug mode enabled, but the statistics always came up fine ;-)

Will implement the check soon!

  • Like 1

Share this post


Link to post
Share on other sites

mmm after returning to the module page the notices and warnings disappeared...btw i customized the data format into d-m-Y

Share this post


Link to post
Share on other sites

mmm after returning to the module page the notices and warnings disappeared...btw i customized the data format into d-m-Y

That's because the results were getting cached. But you still don't see any Statistics, right?

I think there has to be an error in your setup somewhere. Tested also the date "d-m-Y", works fine here on my local installation.

Will check if Google reports back some error codes in case something went wrong with the query params...

Edit:

If you want to do some more testing, you should disable caching the output:

1) Delete the folders starting with "ga_" in site/assets/cache/MarkupCache

2) In the Module Options, set Cache Time to "0"

Share this post


Link to post
Share on other sites
Do you think I could implement the missing 10% somehow? :)

The scope of Google Analytics is so broad, I don't think I'd ever expect something outside the GA app itself to implement it. Take the Real Time features for instance. You've done a great job of implementing the most important and most useful stuff. If I had to wish for anything it would only be that I could get more detail on the referrers. Like when I see a new referrer show up, I'd love to click to see the URL where the referring link actually exists. Sometimes I can't even do this in GA since it strips URL variables... leaving me to grep my access log to find the actual referring URL. But if there's some way to see not just the domain, but the path too, that would provide the same level of detail present in GA.

What do you think about resetting the custom dates? Currently you have to check a checkbox to reset, afterwards the Module is using again the last month from today as date range (default behaviour). Should this reset be done automatically after some time?

I'm not sure what the best behavior would be here, as I'm guessing everyone has their own workflow and timeline they want to look at in GA. But I do know that the first thing I do when I get into GA is to set a date range. It's rare that I want to look at the last month or year. Usually I want the last 24 hours, last 2 days, last week, etc. I've often wished that GA had a select box where I could choose "last 24 hours" for instance, rather than having to select starting and ending dates.

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