Jump to content
adrian

Tracy Debugger

Recommended Posts

It's 4 decimals here:

timer('timer A');
$view->package = getPackages(1, 'random')->first();
bd(timer('timer A'));

Result:

"timer A : 0.0047" (16)

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

  • Like 1

Share this post


Link to post
Share on other sites
It's 4 decimals here:

Thanks @tpr for the confirmation of decimal places.

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here :)

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

Thanks - corrected now!

Share this post


Link to post
Share on other sites

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

  • Like 1

Share this post


Link to post
Share on other sites

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

Right - it comes down to when your version is initially defined vs the one in this module. When I tested re-defining one of these shortcut methods, it was in a template file, which is after this module, which is why I added the option to disable these as needed.

Share this post


Link to post
Share on other sites

New "Method Info" panel to give a quick rundown of each method and their available aliases/shortcuts:

post-985-0-49902900-1455484178_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here :)

Yeah. Saving a few keystrokes is almost never a worthy trade to code clarity :D

Share this post


Link to post
Share on other sites
t();
sleep(1);
bd(t());

$timer = Debug::timer();
sleep(1);
bd(Debug::timer($timer));

result:

1.0
in ...\site\modules\TracyDebugger\TracyDebugger.module:286
"1.0000" (6)
in ...\site\modules\TracyDebugger\TracyDebugger.module:286

Share this post


Link to post
Share on other sites

Very nice module! For some reason I get an empty list for Database Queries. Is that part supposed to contain something? Or should I enable it somehow?

Share this post


Link to post
Share on other sites

@matjazp - can you please see what happens if you specify different sleep intervals. I am occasionally getting 1.0 etc, but changing the sleep value usually results in something with 4 decimal places.

@Ipa - I expect you might have debug mode turned off. That feature currently needs it turned on, although I'll see if it makes sense (or is possible) to get that to work without it on.

On another note, the current version has a new debug mode badge which I think is a very useful reminder:

post-985-0-90390300-1455555359_thumb.png

Also, I have dealt with the issue of incorrect location reporting when calling the TD:: or shortcut/alias methods, so location reporting is now on by default. I think it's a handy addition. For those of you who are updating, you'll need to set this manually, so check the "Show Location" checkboxes in the module config settings.

post-985-0-58464700-1455556190_thumb.png

This means that there is really no reason to ever call the native Tracy methods, so I have removed that info from the first post and the Github ReadMe.

  • Like 2

Share this post


Link to post
Share on other sites

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

Share this post


Link to post
Share on other sites

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

I understand that round() converts a number to a float before rounding, but I don't understand how you are getting a rounded result of: 1.0 for the Tracy timer - what actual value would ever get rounded to 1.0 - it should remove the decimal place completely and leave just: 1 - shouldn't it?

I feel like I am missing the problem here somehow - sorry for being dumb. Do you have any suggestions on how to fix what you are seeing? 

Share this post


Link to post
Share on other sites

A quick update - I have added a row of buttons to various parts of the PW admin at the bottom of the PW panel.

The big news though is that I found out the FireLog() actually works with Chrome too. You just need this browser extension:

https://github.com/MattSkala/chrome-firelogger

https://chrome.google.com/webstore/detail/firelogger-for-chrome/hmagilfopmdjkeomnjpchokglfdfjfeh

This is awesome for debugging AJAX calls.

  • Like 1

Share this post


Link to post
Share on other sites

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

  • Like 1

Share this post


Link to post
Share on other sites

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

  • Like 1

Share this post


Link to post
Share on other sites

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:
 
1)
Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.
post-4029-0-75411800-1455661528_thumb.pn
 
2)
Show Debug Bar option: a select or two checkboxes please :)
  • Show on public frontend only
  • Show on admin only
  • Show on both
  • Do not show
Currently I am only using it on the public frontend so it is just an obstacle on the admin.
 
3)
email option:
Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."
 
thanks again!
  • Like 1

Share this post


Link to post
Share on other sites

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg:

echo number_format(0.12, 4)

results in: 0.1200

Why do you want to display the extra zeros? I still don't see why "round" isn't working for you.

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

I think this is a very useful addition - stay tuned - hopefully coming soon!

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

It doesn't allow for breakpoints and step-throughs. Its features are:

Logging

  • dump() to DOM
  • barDump() to the debugger bar
  • log() to file
  • fireLog() to the console (both Chrome and Firefox)
  • objects and arrays are presented in a fully expandable tree interface

Error reporting

  • Visualization of errors, exceptions, warning, notices etc with a full expandable and linked Call stack, which I find incredibly helpful in isolating the source of the error.
  • Can be to DOM or debugger bar
  • Automatic emailing of errors in production mode

Timing

  • Total execution time
  • Logging of custom calls for sections of code

System Info 

  • Details on php and apache versions
  • Max memory allocation for the page
  • Number of includes files, classes and traits

ProcessWire Information

  • Access to all the info from the Debug Mode Tools on the front-end via the PW panel in the debugger bar
  • Extra sections to the PW panel with details of the current page, its template, the fields of this template
  • Debug Mode indicator - nice reminder/warning in case you forget to turn it off once the site is live
  • Links to various context relevant places in the admin, as well as general admin links

Hope that helps to answer your question. I am looking for feature suggestions, like @matjazp's idea for showing all available variables. I will probably also add functions and classes too. I am also looking to include some other Tracy plugins, like performance monitoring panels.

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:

1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

attachicon.giftracy-height-2016-02-16.png

2)

Show Debug Bar option: a select or two checkboxes please :)

  • Show on public frontend only
  • Show on admin only
  • Show on both
  • Do not show
Currently I am only using it on the public frontend so it is just an obstacle on the admin.

3)

email option:

Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."

thanks again!

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I have added the option to disable the bar on the backend. I went with just two checkboxes, one for the frontend, and one for the backend. I think this works well and I agree, the module is often not needed in the backend, although I am really enjoying using it for module development - it's so nice to be able to dump variables to the debugger bar, or console when it would otherwise be impossible to get them to display without logging to a log file.

I have changed the description for the email address - thanks for picking that up.

I have also added options to disable the Methods Info panel and the DebugMode Indicator - users upgrading will need to revisit your config settings to enable these.

  • Like 2

Share this post


Link to post
Share on other sites

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg: echo number_format(0.12,4) results in: 0.1200

Yes, of course :-) I was just commenting the difference between results from Tracy and PW timers and not "requesting" to be the same. Sorry for not making that clear. I was thinking like this: if you have multiple timers, than it might be visually better to see them aligned ...

Share this post


Link to post
Share on other sites

I upgraded to the latest version and I get 

in_array() expects parameter 2 to be array, integer given

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

Share this post


Link to post
Share on other sites

I upgraded to the latest version and I get 

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

Sorry about that - it was due to the change in that setting from being a single checkbox to an array with two options. The error should go away after saving the config settings again, but to ease the update, I have added a check that will prevent the error.

Share this post


Link to post
Share on other sites
Thank you adrian!

How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:



Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160


I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

  • Like 1

Share this post


Link to post
Share on other sites
Thank you adrian!
 
How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:
Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160
I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

Sorry - I didn't check non-superusers after the recent change to the Show Debugger Bar settings. The latest version (just committed) should fix that new error!

PS, I'll be adding this to the modules directory in the next couple of days, so updates will be easy via the PW Upgrade module (http://modules.processwire.com/modules/process-wire-upgrade/).

  • Like 1

Share this post


Link to post
Share on other sites

Yesterday I had a "Bad gateway" error, perhaps nginx-related, but the new version seems to fixed this too.

Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

Share this post


Link to post
Share on other sites
Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

Take a look at: https://processwire.com/talk/topic/8410-module-toolkit/ - among other things, it lets you export a module along with all its settings and install again, already configured. It is still alpha/early beta for some features, but I do hope to get it finalized soon.

Back to Tracy:

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

Share this post


Link to post
Share on other sites

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

"PW's debug mode doesn't really change error reporting anymore". Can you please explain it a bit more? I do not quite get this.
 
About "superuser only mode": the module should also support non-superuser debugging too. What happens when we want to debug while logged in as another user+role? Why should we miss Tracy in this case? :) The more control we have in this area is the better, I suppose.

Share this post


Link to post
Share on other sites
1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

attachicon.giftracy-height-2016-02-16.png

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I should have checked "my" css before asking this question, sorry for this. I use a "framework" called Responsee 3 which happens to change the display property of <img> to "block". Changing it back to "inline" or "inline-block" fixes is the issue.

I do not know if you want deal with this issue or not, but you might be able to address this by targeting Tracy's <img> tags to set "inline" or "inline-block" !important on them, just in case... As far as I can see, Tracy itself uses a lot of !important rules as well. Maybe the developers of Tracy should apply this, and it is out of the scope of your module.

EDIT: "inline" or "inline-block"

Edited by szabesz

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