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 Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      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 apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...