Jump to content
adrian

Tracy Debugger

Recommended Posts

update: i still (or again) think that this feature would be very helpful!

for example i need to create some fields via api for my new module. it would be great to test this via the console. one window to create the field, one to delete it. that way i could test things very quickly without losing track.

what do you think, @adrian ?

edit: i solved it by implementing 2 methods in my module and then calling them from 2 different browser instances (1 on default browser, 1 on incognito) like this:

// default
$m = $modules->get('mymodule');
$m->tmp_create();

// incognito
$m = $modules->get('mymodule');
$m->tmp_delete();

the methods look like this:

public function tmp_create() {
    $log = $this->wire->log;
    
    $field = new Field();
    $field->type = $this->modules->get('FieldtypeTextarea');
    $field->name = 'test';
    $field->save();

    $msg = "field {$field->name} successfully created";
    $this->message($msg);
    $log->save('rocknotes', $msg);

    d('done tmp_create');
}

public function tmp_remove() {
    $this->deleteField('test');
    d('done tmp_remove');
}

i like this approach even more because i can write the code in my IDE now :)

sorry for my monologue

  • Like 1

Share this post


Link to post
Share on other sites

I usually use url parameters to create/remove such fields (eg. ?name=myModule&action=addFields and &action=removeFields). You can open two browser tabs and just hit F5 in each to add/delete.

  • Like 2

Share this post


Link to post
Share on other sites

thanks for the input tpr,

do you create a template file for that? something like /templates/_sandbox.php or which url do you call?

Share this post


Link to post
Share on other sites

The module url, eg.

http://domain.com/admin/module/edit?name=myModule&action=add_fields

The use $this->wire('input')->action == 'add_fields' .... . No need for template.

  • Like 1

Share this post


Link to post
Share on other sites

thank you tpr, i was not familiar with that pages. now i am :)

@adrian what do you think of hiding the tracy bar on mobile? at least a checkbox for that? :) in my case it would totally be enough to hide it based on screen width. if you don't think that's a good idea let me know and i'll add it via css on my own. i would prefer this to be built in though because it annoys me on almost any project.

  • Like 1

Share this post


Link to post
Share on other sites

Hi @bernhard,

Sorry for the delay here - been hectic catching up with everything after getting back.

I haven't played around too much yet, but I don't think it's going to be possible to have multiple console windows without hacking the Tracy core. If you want a quick preview of how it might work, change this line: https://github.com/adrianbj/TracyDebugger/blob/930b738e988239ac71fd76c23d565ba7dc091eeb/tracy-master/src/Tracy/assets/Bar/bar.js#L137

to:

        var win = window.open('', Date.now(), 'left=' + offset.left + ',top=' + offset.top

It's just a quick hack to give each new window a different name. I am sure there will be side-effects though, so don't get too used to it ;)

Perhaps the better solution would be to implement my idea of adding a snippet manager to the console so that you could save and load (from a dropdown or similar) lots of different code snippets. You could run one, then easily load another one. I just need to figure out a nice interface for this so it's easy to find the snippet you are looking for when there are lots of saved snippets.

 

On 10/30/2016 at 1:33 AM, bernhard said:

what do you think of hiding the tracy bar on mobile? at least a checkbox for that? :) in my case it would totally be enough to hide it based on screen width.

I am happy to do something along these lines, but I am not sure I would want to lose the option for having the debug bar if I need it. Perhaps it could be toggled disabled be default (so it just shows that red power button like it does when you use the Tracy Toggler panel button or the Disable Tracy button in the Panel Selector. Do you think that would work for your needs?

  • Like 2

Share this post


Link to post
Share on other sites
On 11/2/2016 at 5:23 AM, adrian said:

Do you think that would work for your needs?

May I join in? :) I think hiding it completaly is a valid request. When solely working on ftontend design, it just gets in the way on cramped display lik a mobile view. So maybe a "hide once / sticky hide" option in this case too?

"multiple console windows vs snippets" Probably they are not the same. Snippets are pre made, but Bernhard is making up the snippets on the go and he wants Tracy to remember them, as fas as I get it, which would be useful for sure. We could even save them as snippets, should they happen to be useful :P Note, I'm not saying I badly need these features, I just wanted to point out a few things here.

Edited by szabesz
typos
  • Like 1

Share this post


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

I am happy to do something along these lines, but I am not sure I would want to lose the option for having the debug bar if I need it. Perhaps it could be toggled disabled be default (so it just shows that red power button like it does when you use the Tracy Toggler panel button or the Disable Tracy button in the Panel Selector. Do you think that would work for your needs?

i think that woulb be totally enough and if that is simpler, i would be totally happy with that :)

12 hours ago, adrian said:

Perhaps the better solution would be to implement my idea of adding a snippet manager to the console so that you could save and load (from a dropdown or similar) lots of different code snippets. You could run one, then easily load another one. I just need to figure out a nice interface for this so it's easy to find the snippet you are looking for when there are lots of saved snippets.

you brought up a new idea: what if the code restore feature that you implemented remembered the window/tab somehow? do you think that would be possible? i guess a simple solution would be to store it based on the url path in a cookie.

another idea, and a short explanation why i think that this would be useful:

in the last weeks i found myself often do something like this:

$m = $modules->get('mymodule');

$m->upgrade(1,2); // test upgrade from version 1 to 2
$m->upgrade(2,1); // test downgrad from version 2 to 1

i then have to (un)comment one of those lines repeatedly...

i think a history would be quite nice! simpler and maybe easier and more efficient than a snippet library (or similar in many cases):

2016-11-02 19_03_53-Greenshot Editor.png

just put a comment in the first line and it would save it to the history. :) what do you think?

  • Like 2

Share this post


Link to post
Share on other sites

Thanks for all those ideas @bernhard and @szabesz - 

14 hours ago, szabesz said:

So maybe a "hide once / sticky hide" option in this case too?

You can already hide the debug bar by clicking the "x" at the far right of the bar, so I think that covers the "hide once" requirement. As for sticky - you need a way to restore, which is what the toggle button does, so I think I'll go for the toggled off by default on phone sized screens.

3 hours ago, bernhard said:

i think a history would be quite nice!

I like the history idea and I wonder if an additional "Save Snippet" button could complement this such that snippets are automatically saved to history each time that first comment line is changed (maybe the last 5), and saved more permanently to a snippets library if you click the save button?

Anyway, these are on my list and hopefully I can get to them shortly.

Thanks again for the input!

  • Like 2

Share this post


Link to post
Share on other sites

good idea with the snippet button! my suggestion would be:

case1: code that does NOT get stored anywhere

echo 'no comment at first line, no save';

case2: code that goes to history, but NOT to snippets. that would be for some kind of code you need multiple times for a limited period of time (eg developing a module). you could change your code as often as you want, it would only show up ONCE in the history, saying "update module XY 1 -> 2". the list could be limited to around 5 - 10 items.

// update module XY 1 -> 2
$m = $modules...
$m->upgrade(1,2);

case3: when you click on an icon or the like in the list of historical codes, you could make a snippet out of this code. eg "update module XY 1 -> 2 (icon: create permanent snippet)"

// my awesome snippet
// do stuff for all pages under parent XY
foreach($pages->find('parent=XY, ...

i think the snippets and codes should always show up only once in the list and hold the last executed code. if you want to apply slight modifications you could just update the comment in the first line (like creating a new branch on github)

// my awesome snippet - TEMP CHANGE XYZ
// do stuff for all pages under parent XYZ
foreach($pages->find('parent=XYZ, ...

after the change you could rename the comment and overwrite your old snippet

  • Like 2

Share this post


Link to post
Share on other sites

Hi @adrian

I've been noticing something odd when dumping the $page variable inside a hook. I've noticed it when hooking several different methods, but take this hook for example:

$this->pages->addHookAfter('saveReady', function($event) {
	$page = $event->arguments('page');
	bd($page, 'page');
	bd($page->name, 'page->name');
});

In this hook $page should be the page that is ready to be saved - let's say I am saving the Home page. But when I save the Home page in the admin, the dumped $page variable is for the "Edit" page (ProcessPageEdit). Which is weird, but what makes it weirder is that the subsequent dump of $page->name shows "home" not "edit". Any ideas on what is going on here?

dump.png

Share this post


Link to post
Share on other sites

https://github.com/adrianbj/TracyDebugger/issues/6

As noted in the issue, we discovered it is due to the use of LIVE dumps that I introduced as default for bd() a few weeks ago. I was hoping for a workaround because it is so much more efficient, but as you'll see if you read the linked posts, I might have to wait for that pull request to be finalized. I might have to revert to normal dumps until then. I'll investigate a little more in the next couple of days and fix one way or the other. For right now, you can instead use /Tracy/Debugger::barDump() inside your hook and you should be fine.

  • Like 2

Share this post


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

For right now, you can instead use /Tracy/Debugger::barDump() inside your hook and you should be fine.

I'm not sure what's the right way to use that. This gives me: syntax error, unexpected '/'

$this->pages->addHookAfter('saveReady', function($event) {
	$page = $event->arguments('page');
	/Tracy/Debugger::barDump($page);
});

Do you remember which version of Tracy Debugger you introduced the Live dumps? Might be easier for me to roll back to an older version.

Share this post


Link to post
Share on other sites

Hi @Robin S and everyone. I have turned off live dumping by default for the bd() method and added a new bdl() or barDumpLive() method. You can choose which you want to use knowing that bdl() will ignore maxDepth and maxLength settings (thereby dumping the full contents of an object etc) and will be much faster to render the output, but at least for now, it has the side effect of sometimes dumping the wrong object as noted above. bd() will always dump the correct object, but obviously slower and limited by the maxDepth and maxLength settings. 

As noted in the links referenced in this issue (https://github.com/adrianbj/TracyDebugger/issues/6), there may be a way to make live dumping always reliable in which case I will combine the methods again.

Let me know if you have any problems.

  • Like 4

Share this post


Link to post
Share on other sites

Hi @adrian,

I'm getting an issue where bd() causes an error when used in a ready.php hook triggered from a PageTable field. For instance, if I have saveReady hook, and the page is saved from the "Add New" procedure in PageTable I get:

Error: Uncaught Error: Call to undefined function bd() in ...\site\assets\cache\FileCompiler\site\ready.php:46

Edit: False alarm. I saved the module config and the issue is gone.

Edited by Robin S
Issue resolved

Share this post


Link to post
Share on other sites

Hi everyone,

I have just added the ability for the PW Info and Console panels to reference the page that is being edited, rather than the Admin > Pages > Edit page (which is generally not a page you'd actually want info about or want to run scripts on). Note, that without this enabled, the screenshots below would be showing the admin edit page with ID: 10.

Screen Shot 2016-11-12 at 8.03.54 AM.png 

Screen Shot 2016-11-12 at 8.05.34 AM.png


This option is disabled by default to avoid any confusion, but I would recommend that everyone will probably enjoy having this enabled.

Screen Shot 2016-11-12 at 8.01.36 AM.png

This idea has been brewing for a little while, but this thread (https://processwire.com/talk/topic/14745-debugging-images/) prompted me to try it out because @microcipcip needed more details about images in the admin because there is no viewable page on the front-end.

Please let me know how you find this and if you have any problems!

 

  • Like 5

Share this post


Link to post
Share on other sites

Looks like the latest version of TracyDebugger 3.5.1 always seems to show up in the backend even though it is unchecked in the TracyDebugger settings.  PWDebugMode is off.  3.5.0 works fine.  I'm on ProcessWire 3.0.45.  Hope that helps

  • Like 1

Share this post


Link to post
Share on other sites
54 minutes ago, gmclelland said:

Looks like the latest version of TracyDebugger 3.5.1 always seems to show up in the backend even though it is unchecked in the TracyDebugger settings.  PWDebugMode is off.  3.5.0 works fine.  I'm on ProcessWire 3.0.45.  Hope that helps

+1

  • Like 1

Share this post


Link to post
Share on other sites

@gmclelland and @Zeka - sorry about that - should be fixed in the latest version.

Please let me know if you have any other troubles!

Share this post


Link to post
Share on other sites

For those of you who like using the SessionHandlerDB module, I have just implemented a fix (thanks to David Grudl over at Nette) for the whitescreen issue that was happening with a Modules > Refresh and some other actions when your php.ini had output_buffering set to off / 0

As far as I can tell the only outstanding issue with SessionHandlerDB is calling bd() from the Console panel - this still doesn't work, but in most cases d() is better from here anyway.

  • Like 1

Share this post


Link to post
Share on other sites

Another update which now also fixes bd() and all other calls from the Console Panel when the SessionHandlerDB module is installed - the AJAX bar will be immediately updated now.

I think we can now declare that there are no outstanding issues with that module, but please let me know if any of you come across anything I have missed!

  • Like 1

Share this post


Link to post
Share on other sites

A few more updates to mention.

1) Tracy now correctly reports warnings/notices coming from PW's file/image AJAX uploads

3b03f504-ccea-11e6-82c2-cdc55f9b147e.png

For those following the thread on CustomUploadNames and on Github, not only did Ryan make some changes in the PW core to make this work, but David Grudl over at Nette also added a workaround that now allows Tracy to report errors from vanilla JS ajax calls, even if they don't call xhr.getAllResponseHeaders(); which should help with debugging your own vanilla js ajax calls as well.

 

2) Easy toggle for Strict Mode

Not sure how many of you have played with the Strict Mode config setting. It turns notices and warnings into errors and shows a full expandable stack trace. For example, here is the above notice in Strict Mode. Clicking on the "source" and "arguments" on the entries further down the call stack can be very helpful!

Screen Shot 2016-12-29 at 11.36.21 AM.png

This is great, especially for AJAX notices/warnings which are often harder to dig into. 

The catch has always been that Strict Mode will halt your scripts for these notices/warnings, which can often be painful when you are early into something complex and just want to get it working before dealing with these. Now on the Panel Selector panel the new toggle button makes it easy to turn on Strict Mode when needed (note this is only available if Strict Mode is off in the module config settings):

Screen-Shot-2016-12-29-at-11.28.19-AM.png

 

3) Time and memory of Console Panel code

I recently added time and memory of the code run in the console panel. Note the 11.59ms and 0.07MB at the bottom of the output. This could be very handy if you want to test the performance of different selectors or loops.

Screen Shot 2016-12-29 at 11.43.44 AM.png

 

Hope you guys find these new additions useful!

  • Like 4

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By horst
      ---------------------------------------------------------------------------------------------------------------------------------
        when working with PW version 2.6+, please use Pim2, not Pim!
        read more here  on how to change from the older to the newer version in existing sites
      ---------------------------------------------------------------------------------------------------------------------------------
      PageImage Manipulator, API for version 1 & 2

      The Page Image Manipulator is a module that let you in a first place do ImageManipulations with your PageImages. - And in a second place there is the possibility to let it work on any imagefile that exists in your servers filesystem, regardless if it is a 'known PW-image'.

      The Page Image Manipulator is a Toolbox for Users and Moduledevelopers. It is written to be as close to the Core ImageSizer as possible. Besides the GD-filterfunctions it contains resize, crop, canvas, rotate, flip, sharpen, unsharpMask and 3 watermark methods.



      How does it work?

      You can enter the ImageManipulator by calling the method pim2Load(). After that you can chain together how many actions in what ever order you like. If your manipulation is finished, you call pimSave() to write the memory Image into a diskfile. pimSave() returns the PageImage-Object of the new written file so we are able to further use any known PW-image property or method. This way it integrates best into the ProcessWire flow.

      The three examples above put out the same visual result: a grayscale image with a width of 240px. Only the filenames will slightly differ.

      You have to define a name-prefix that you pass with the pimLoad() method. If the file with that prefix already exists, all operations are skipped and only the desired PageImage-Object gets returned by pimSave(). If you want to force recreation of the file, you can pass as second param a boolean true: pim2Load('myPrefix', true).

      You may also want to get rid of all variations at once? Than you can call $pageimage->pim2Load('myPrefix')->removePimVariations()!

      A complete list of all methods and actions are at the end of this post.
       
      You may also visit the post with tips & examples for users and module developers.


      How to Install
      Download the module Place the module files in /site/modules/PageImageManipulator/ In your admin, click Modules > Check for new modules Click "install" for PageImageManipulator Done! There are no configuration settings needed, just install and use it. Download    (version 0.2.0)
      get it from the Modules Directory History of origins

      http://processwire.com/talk/topic/3278-core-imagemanipulation/


      ----------------------------------------------------------------------------------------------------------


      Page Image Manipulator - Methods

      * pimLoad  or  pim2Load, depends on the version you use!

      pimLoad($prefix, $param2=optional, $param3=optional)
      param 1: $prefix - (string) = mandatory! param 2: mixed, $forceRecreation or $options param 3: mixed, $forceRecreation or $options return: pim - (class handle) $options - (array) default is empty, see the next method for a list of valid options! $forceRecreation - (bool) default is false It check if the desired image variation exists, if not or if forceRecreation is set to true, it prepares all settings to get ready for image manipulation
      -------------------------------------------------------------------

      * setOptions

      setOptions(array $options)
      param: $options - (array) default is empty return: pim - (class handle) Takes an array with any number valid options / properties and set them by replacing the class-defaults and / or the global config defaults optionally set in the site/config.php under imageSizerOptions or imageManipulatorOptions.

      valid options are:
      quality = 1 - 100 (integer) upscaling = true | false (boolean) cropping = true | false (boolean) autoRotation =true | false (boolean) sharpening = 'none' | 'soft' | 'medium' | 'strong' (string) bgcolor = (array) css rgb or css rgba, first three values are integer 0-255 and optional 4 value is float 0-1, - default is array(255,255,255,0) thumbnailColorizeCustom = (array) rgb with values for colorize, integer -255 - 255 (this can be used to set a custom color when working together with Thumbnails-Module)
        outputFormat = 'gif' | 'jpg' | 'png' (Attention: outputFormat cannot be specified as global option in $config->imageManipulatorOptions!) set {singleOption} ($value)
      For every valid option there is also a single method that you can call, like setQuality(90), setUpscaling(false), etc.
      -------------------------------------------------------------------

      * pimSave

      pimSave()
      return: PageImage-Object If a new image is hold in memory, it saves the current content into a diskfile, according to the settings of filename, imagetype, targetFilename and outputFormat. Returns a PageImage-Object!
      -------------------------------------------------------------------

      * release

      release()
      return: void (nothing) if you, for what ever reason, first load image into memory but than do not save it, you should call release() to do the dishes! 😉 If you use pimSave() to leave the ImageManipulator, release() is called automatically.
      -------------------------------------------------------------------

      * getOptions

      getOptions()
      return: associative array with all final option values example:
      ["autoRotation"] bool(true) ["upscaling"] bool(false) ["cropping"] bool(true) ["quality"] int(90) ["sharpening"] string(6) "medium" ["targetFilename"] string(96) "/htdocs/site/assets/files/1124/pim_prefix_filename.jpg" ["outputFormat"] string(3) "jpg" get {singleOption} ()
      For every valid option there is also a single method that you can call, like getQuality(), getUpscaling(), etc. See method setOptions for a list of valid options!
      -------------------------------------------------------------------

      * getImageInfo

      getImageInfo()
      return: associative array with useful informations of source imagefile example:
      ["type"] string(3) "jpg" ["imageType"] int(2) ["mimetype"] string(10) "image/jpeg" ["width"] int(500) ["height"] int(331) ["landscape"] bool(true) ["ratio"] float(1.5105740181269) ["bits"] int(8) ["channels"] int(3) ["colspace"] string(9) "DeviceRGB" -------------------------------------------------------------------

      * getPimVariations

      getPimVariations()
      return: array of Pageimages Collect all pimVariations of this Pageimage as a Pageimages array of Pageimage objects. All variations created by the core ImageSizer are not included in the collection.
      -------------------------------------------------------------------

      * removePimVariations

      removePimVariations()
      return: pim - (class handle) Removes all image variations that was created using the PIM, all variations that are created by the core ImageSizer are left untouched!
      -------------------------------------------------------------------
      * width

      width($dst_width, $sharpen_mode=null)
      param: $dst_width - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the width, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * height

      height($dst_height, $sharpen_mode=null)
      param: $dst_height - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the height, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * resize

      resize($dst_width=0, $dst_height=0, $sharpen_mode=null)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you have to set width and / or height, like with pageimage size(). Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * stepResize

      stepResize($dst_width=0, $dst_height=0)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 return: pim - (class handle) this performs a resizing but with multiple little steps, each step followed by a soft sharpening. That way you can get better result of sharpened images.
      -------------------------------------------------------------------

      * sharpen

      sharpen($mode='soft')
      param: $mode - (string) possible values 'none' | 'soft'| 'medium'| 'strong' return: pim - (class handle) Applys sharpening to the current memory image. You can call it with one of the three predefined pattern, or you can pass an array with your own pattern.
      -------------------------------------------------------------------

      * unsharpMask

      unsharpMask($amount, $radius, $threshold)
      param: $amount - (integer) 0 - 500, default is 100 param: $radius - (float) 0.1 - 50, default is 0.5 param: $threshold - (integer) 0 - 255, default is 3 return: pim - (class handle) Applys sharpening to the current memory image like the equal named filter in photoshop.
      Credit for the used unsharp mask algorithm goes to Torstein Hønsi who has created the function back in 2003.
      -------------------------------------------------------------------

      * smooth

      smooth($level=127)
      param: $level - (integer) 1 - 255, default is 127 return: pim - (class handle) Smooth is the opposite of sharpen. You can define how strong it should be applied, 1 is low and 255 is strong.
      -------------------------------------------------------------------

      * blur

      blur()
      return: pim - (class handle) Blur is like smooth, but cannot called with a value. It seems to be similar like a result of smooth with a value greater than 200.
      -------------------------------------------------------------------

      * crop

      crop($pos_x, $pos_y, $width, $height)
      param: $pos_x - (integer) start position left param: $pos_y - (integer) start position top param: $width - (integer) horizontal length of desired image part param: $height - (integer) vertical length of desired image part return: pim - (class handle) This method cut out a part of the memory image.
      -------------------------------------------------------------------

      * canvas

      canvas($width, $height, $bgcolor, $position, $padding)
      param: $width = mixed, associative array with options or integer, - mandatory! param: $height = integer, - mandatory if $width is integer! param: $bgcolor = array with rgb or rgba, - default is array(255, 255, 255, 0) param: $position = one out of north, northwest, center, etc, - default is center param: $padding = integer as percent of canvas length, - default is 0 return: pim - (class handle) This method creates a canvas according to the given width and height and position the memory image onto it.
      You can pass an associative options array as the first and only param. With it you have to set width and height and optionally any other valid param. Or you have to set at least width and height as integers.
      Hint: If you want use transparency with rgba and your sourceImage isn't of type PNG, you have to define 'png' as outputFormat with your initially options array or, for example, like this: $image->pimLoad('prefix')->setOutputFormat('png')->canvas(300, 300, array(210,233,238,0.5), 'c', 5)->pimSave()
      -------------------------------------------------------------------

      * flip

      flip($vertical=false)
      param: $vertical - (boolean) default is false return: pim - (class handle) This flips the image horizontal by default. (mirroring)
      If the boolean param is set to true, it flips the image vertical instead.
      -------------------------------------------------------------------

      * rotate

      rotate($degree, $backgroundColor=127)
      param: $degree - (integer) valid is -360 0 360 param: $backgroundColor - (integer) valid is 0 - 255, default is 127 return: pim - (class handle) This rotates the image. Positive values for degree rotates clockwise, negative values counter clockwise. If you use other values than 90, 180, 270, the additional space gets filled with the defined background color.
      -------------------------------------------------------------------

      * brightness

      brightness($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust brightness by defining a value between -255 and +255. Zero lets it unchanged, negative values results in darker images and positive values in lighter images.
      -------------------------------------------------------------------

      * contrast

      contrast($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust contrast by defining a value between -255 and +255. Zero lets it unchanged, negative values results in lesser contrast and positive values in higher contrast.
      -------------------------------------------------------------------

      * grayscale

      grayscale()
      return: pim - (class handle) Turns an image into grayscale. Remove all colors.
      -------------------------------------------------------------------

      * sepia

      sepia()
      return: pim - (class handle) Turns the memory image into a colorized grayscale image with a predefined rgb-color that is known as "sepia".
      -------------------------------------------------------------------

      * colorize

      colorize($anyColor)
      param: $anyColor - (array) like css rgb or css rgba - but with values for rgb -255 - +255,  - value for alpha is float 0 - 1, 0 = transparent  1 = opaque return: pim - (class handle) Here you can adjust each of the RGB colors and optionally the alpha channel. Zero lets the channel unchanged whereas negative values results in lesser / darker parts of that channel and higher values in stronger saturisation of that channel.
      -------------------------------------------------------------------

      * negate

      negate()
      return: pim - (class handle) Turns an image into a "negative".
      -------------------------------------------------------------------

      * pixelate

      pixelate($blockSize=3)
      param: $blockSize - (integer) 1 - ??, default is 3 return: pim - (class handle) This apply the well known PixelLook to the memory image. It is stronger with higher values for blockSize.
      -------------------------------------------------------------------

      * emboss

      emboss()
      return: pim - (class handle) This apply the emboss effect to the memory image.
      -------------------------------------------------------------------

      * edgedetect

      edgedetect()
      return: pim - (class handle) This apply the edge-detect effect to the memory image.
      -------------------------------------------------------------------

      * getMemoryImage

      getMemoryImage()
      return: memoryimage - (GD-Resource) If you want apply something that isn't available with that class, you simply can check out the current memory image and apply your image - voodoo - stuff
      -------------------------------------------------------------------

      * setMemoryImage

      setMemoryImage($memoryImage)
      param: $memoryImage - (GD-Resource) return: pim - (class handle) If you are ready with your own image stuff, you can check in the memory image for further use with the class.
      -------------------------------------------------------------------

      * watermarkLogo

      watermarkLogo($pngAlphaImage, $position='center', $padding=2)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 5, padding to the borders in percent of the images length! return: pim - (class handle) You can pass a transparent image with its filename or as a PageImage to the method. If the watermark is bigger than the destination-image, it gets shrinked to fit into the targetimage. If it is a small watermark image you can define the position of it:
      NW - N - NE | | | W - C - E | | | SW - S - SE  
      The easiest and best way I have discovered to apply a big transparency watermark to an image is as follows:
      create a square transparent png image of e.g. 2000 x 2000 px, place your mark into the center with enough (percent) of space to the borders. You can see an example here! The $pngAlphaImage get centered and shrinked to fit into the memory image. No hassle with what width and / or height should I use?, how many space for the borders?, etc.
      -------------------------------------------------------------------

      * watermarkLogoTiled

      watermarkLogoTiled($pngAlphaImage)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency return: pim - (class handle) Here you have to pass a tile png with transparency (e.g. something between 150-300 px?) to your bigger images. It got repeated all over the memory image starting at the top left corner.
      -------------------------------------------------------------------

      * watermarkText

      watermarkText($text, $size=10, $position='center', $padding=2, $opacity=50, $trueTypeFont=null)
      param: $text - (string) the text that you want to display on the image param: $size - (integer) 1 - 100, unit = points, good value seems to be around 10 to 15 param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 2, padding to the borders in percent of the images length! param: $opacity- (integer) 1 - 100, default is 50 param: $trueTypeFont - (string) systemfilepath to a TrueTypeFont, default is freesansbold.ttf (is GPL & comes with the module) return: pim - (class handle) Here you can display (dynamic) text with transparency over the memory image. You have to define your text, and optionally size, position, padding, opacity for it. And if you don't like the default font, freesansbold, you have to point to a TrueTypeFont-File of your choice.
      Please have a look to example output: http://processwire.com/talk/topic/4264-release-page-image-manipulator/page-2#entry41989
      -------------------------------------------------------------------





      PageImage Manipulator - Example Output


    • By d'Hinnisdaël
      Format Datetime fields as Carbon instances.
      You can find the latest release and the complete readme on Github.
      Installation
      composer require daun/datetime-carbon-format Usage
      All Datetime fields will now be formatted as Carbon instances instead of strings. Some examples:
      // $page->date is a Datetime field // Output format: j/n/Y echo $page->date; // 20/10/2020 echo $page->date->add('7 days'); // 27/10/2020 echo $page->date->format('l, F j'); // Monday, October 20 echo $page->date->year; // 2020 echo $page->date->diffForHumans(); // 28 minutes ago Frontend only
      The ProcessWire admin seems to expect datetime fields to be strings. This module will only return Carbon instances on frontend page views.
      Date output format
      When casting a Carbon instance to a string (usually when outputting the field in a template), the field's date output format will be respected.
      Links
      GitHub • Readme • Carbon docs
       
       
      PS. I remember reading about a Carbon module in a recent newsletter, but couldn't find it anywhere. Was that you, @bernhard?
    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Warning: This module requires ProcessWire 3.0.167 which is above the current stable master release at the moment.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) TrelloWire in the modules directory Module configuration

    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Attention, please note!
      Nested repeaters cannot be supported technically. Therefore a check is made to prevent this. However, a nested repeater can only be detected if the field name ends for example with "_repeater1234". For example, if your MatrixRepeater field is named like this: "content_repeater" or "content_repeater123", this field is identified as nested and the module does not load. In version 2.0.1 the identification has been changed so that a field ending with the name repeater is only detected as nested if at least a two-digit number sequence follows. But to avoid this problem completely, make sure that your repeater matrix field does NOT end with the name "repeater".
      Changelog
       
      2.0.1
      Bug fix: Thanks to @ngrmm I could discover a bug which causes that the module cannot be loaded if the MatrixRepeater field ends with the name "repeater". The code was adjusted and information about the problem was provided 2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.1)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
×
×
  • Create New...