Jump to content
adrian

Tracy Debugger

Recommended Posts

Everyone else coming from 3.0152 to 3.0153 seeing this? Looks correct to me based on what Ryan just committed to the core.

image.png.b0bf7af11ce1f08ce6b4f7bf59eb8a90.png

Share this post


Link to post
Share on other sites

Thanks @bernhard - those Breadcrumb and $process methods have been persistent for a while. I think you'll actually need one more update for them to disappear. I "reset" my cache when I was updating Tracy yesterday by going from 152 back to 151, then to 152 and today to 153. Can you remember to check on upgrade to 154 and let me know if the problem still persists please? Thanks.

Share this post


Link to post
Share on other sites

Not sure if that helps, but I have this site under git, so I reverted to 1.0.152, did a modules refresh, then went back to master branch (1.0.153) and this is what I get: 

Sdc9fBG.png

Share this post


Link to post
Share on other sites

Thanks @bernhard - is that just the start of things - is it listing virtually everything as new? It is kinda looking like the old cached version was removed somehow in the downgrade / upgrade process. Let's see what others report their experience to be.

Share this post


Link to post
Share on other sites

Now it shows this, so I guess it was somehow messing up with some cached values 🙂 

KTJZGCR.png

Wow, this even works for my own $theme API variable 😮 

  • Like 1

Share this post


Link to post
Share on other sites

@adrian Hi. 

I'm facing a small issue and I'm not sure that this one is relative to Tracy, but I feel that it's better to ask anyway.
I have quite a simple template that outputs page views based on the GET parameters.

Spoiler

<?php namespace ProcessWire;

	bp('template before');
	if (!config('ajax') || !input()->get('post_ids')) {
		wire404();
	}

	$layout->preventOutput(true);
	$dirty_post_ids = input()->get('post_ids');
	$post_ids = implode('|', sanitizer('intArray', $dirty_post_ids));



	header('Content-Type: application/json; charset=utf-8;');
	$data = cache()->getFor('PostViews', $post_ids, 300, function () use ($post_ids) {
		return pages()->getById($post_ids, [
			'getNumChildren' => false,
			'joinFields'     => [
				'phits'
			]
		])->explode(function ($p) {
			return [
				'id'    => $p->id,
				'views' => (int) $p->getViewsCount(3.3)
			];
		});
	});

	echo wireEncodeJSON($data, 0);
	bp('template after');
	$this->halt();

URL of this page is /ua/views/.

The issue is that I have significant and unreasonable leap in memory usage

image.png.b53bb594a76de53db13001323e8dc983.png

The strange thing is that if I change URL ( page name) to something else like v or view I get (if not contains 'views')

image.png.9bb5fdd73198780eb605dd1e6438b52e.png

I have reviewed all the code and did not find anything where occurs 'views'.

I don’t have any idea what can cause it, it's just some kind of mysticism, so I thought maybe it could be an issue with Tracy or Performance Panel. 

Thanks. 

Share this post


Link to post
Share on other sites

Hey @adrian

I've just started using live.js because I'm doing some work in the backend where I need JS/LESS a lot. After getting tired of reloading the browser I thought I'd try browsersync that I recently discovered but it did not work. Then I found live.js and added this to my module:

if(!$this->user->isSuperuser()) return;
if(!$this->config->debug) return;
$this->config->scripts->add('http://livejs.com/live.js');

And this just works!!

The great thing about it is that it even recognizes when my style.less file changed. The great thing here is that it does not reload the browser but only replaces the CSS file (which is crazy because the CSS is parsed via RockLESS on demand, so the server must somehow be involved. Anyway... the style gets updated without reloading the page as soon as I change my LESS file 😎

I thought this would be very easy to include in Tracy. For the frontend it would need to add the whole script tag instead of doing $config->styles->add(), but that would also be simple.

What do you think?

Edit: I understand now how the less-part works. On every poll of live.js the server is involved, so live.js results in lots of requests to your server! I don't think that's a very good option...

Share this post


Link to post
Share on other sites

@Zeka - sorry, I am not sure - that Performance panel is not my own work - it comes from https://github.com/Zarganwar/PerformancePanel although it hasn't seen any updates in a long time. It would be great if you could figure out where the problem is coming from though if you have the time.

@bernhard - thanks for the idea - but sounds like it's a no go afterall.

Share this post


Link to post
Share on other sites
1 minute ago, adrian said:

but sounds like it's a no go afterall.

Unfortunately yes 🙂 

Share this post


Link to post
Share on other sites

Hi @adrian,

Is it possible to switch into a user with the guest role only using the User Switcher panel? I didn't see the default guest user available there so I created a new user with only the guest role but it doesn't appear either.

Or do you know of another way to get the debug bar to appear on a remote site when not logged in? (of course you would never to this on a live site - my site isn't publicly accessible)

Share this post


Link to post
Share on other sites
1 minute ago, Robin S said:

Is it possible to switch into a user with the guest role only using the User Switcher panel?

Use the logout button on the user switcher panel and it should do what you want.

  • Like 1

Share this post


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

Use the logout button on the user switcher panel and it should do what you want.

Thanks! I just had to start a User Switcher session and then the logout button did the trick.

  • Like 1

Share this post


Link to post
Share on other sites

Major new release, thanks in big part to @Robin S for ideas, testing, and feedback.

1. The Console panel now stores it's snippets on disk so they can be backed up, be under version control, and also editable via your external code editor (with direct link from the entry in the Console snippet sidebar). They are stored in either /site/templates/TracyDebugger/snippets/ or /site/assets/TracyDebugger/snippets/

Note that all your pre-existing snippets that were previously stored along with Tracy's module settings will be automatically written to disk when you upgrade to the new version of Tracy.

2. You can define a block of code to be prepended to the snippet when it is saved to disk. For example, Robin is using:

<?php namespace ProcessWire;
//<editor-fold desc="API variables">
/**
 * @var Config $config
 * @var Fieldgroups $fieldgroups
 * @var Fields $fields
 * @var Languages $languages
 * @var Modules $modules
 * @var Page $page
 * @var Pages $pages
 * @var Paths $urls
 * @var Permissions $permissions
 * @var ProcessWire $wire
 * @var Roles $roles
 * @var Sanitizer $sanitizer
 * @var Session $session
 * @var Templates $templates
 * @var User $user
 * @var Users $users
 * @var WireCache $cache
 * @var WireDatabasePDO $database
 * @var WireDateTime $datetime
 * @var WireFileTools $files
 * @var WireInput $input
 * @var WireLog $log
 * @var WireMail $mail
 * @var \ProCache $procache
 * @var FormBuilder $forms
 **/
//</editor-fold>

 

3. The SnippetRunner panel has been removed because it's no longer necessary with the new behavior of the Console panel.

4. The Console panel has a new inbuilt DB backup feature. If checked, it will backup your complete DB. The backups are stored under /site/assets/backups/database/ which is where Ryan's Database Backups module (http://modules.processwire.com/modules/process-database-backups/) stores its backups. It is recommended to install this module to make managing and restoring backups much easier. Backups can be automatically named: tracy-console-2020-04-14-18-23-38.sql or you can specify a custom name in the Console panel if you'd like to set something more meaningful before a major change. Automatically named backups are automatically pruned when there are a set number of backups (default is 25, but is configurable in module settings).

5. The user switcher panel now has the option to use a PW API selector string as a way to determine which users will be listed.

6. There is a new Quicklinks section at the top of the module settings to more quickly get to what you're looking for (code thanks to Robin).

7. Lots of other tweaks, fixes and improvements.

8. New core versions of Tracy and ACE editor.

Please let me know what you think and if you have any problems.

PS - please do a hard reload in your browser to ensure you get the new css and js files.

 

 

 

  • Like 4

Share this post


Link to post
Share on other sites

Big, big thanks @adrian for all your ongoing work on Tracy Debugger - it just gets better and better!

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

Hello There @adrian

I am having a strange problem with the wonderfull tracy that started a long time ago but i havent notice until now because i have not used it in a while.

But i am getting errors about:
- The Console Panel
- The ProcesswireInfoPanel
- The ApiExplorerPanel

I will attach screenshots of the errors with some sensitive parts blured out for security.

I hope we can resolve this because i love to use the Console.

I am running:
- Processwire 3.0.153
- Tracy Debugger 4.21.1
- PHP 7.3.16
 

tracy_Debugger_console_error.thumb.png.5fc535d15ae1feb26b85c28b40119a80.pngtracy_Debugger_ProcesswireInfoPanel_error.thumb.png.68fcc9f997633760545e452dc1e47436.pngtracy_Debugger_ApiExplorerPanel.thumb.png.9337c6b027918efc50e3726976f6d1f9.pngtracy_Debugger_toolbar.thumb.png.22430b96c90b196200dd142ae2582a9d.pngtracy_Debugger_toolbar.thumb.png.22430b96c90b196200dd142ae2582a9d.png

Share this post


Link to post
Share on other sites

Hi @EyeDentify - what host are you using? Any chance it's nextcloud or one.com ? https://github.com/nextcloud/server/issues/16752

I can see why you might be getting the error in the PW Info panel, but am confused about the other two. Can you please try disabling the PW Info panel and see if that fixes the other two as well. If it does, then I think we might be able to do a try / catch for the PW Info panel that will fix it.

Finally, do you know why there are two copies of the main Tracy bar - that looks strange to me.

  • Like 1

Share this post


Link to post
Share on other sites

@EyeDentify - could you also check whether set_time_limit is actually in the php.ini disable_functions list?

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

Hi @EyeDentify - what host are you using? Any chance it's nextcloud or one.com ? https://github.com/nextcloud/server/issues/16752

I can see why you might be getting the error in the PW Info panel, but am confused about the other two. Can you please try disabling the PW Info panel and see if that fixes the other two as well. If it does, then I think we might be able to do a try / catch for the PW Info panel that will fix it.

Finally, do you know why there are two copies of the main Tracy bar - that looks strange to me.

Hi @adrian

Thanks for getting back to me.

I have one.com as host.

I am baffled by the double bar as well, but it says AJAX on the other one.

I tried to disable Info panel but that did not do any difference to the Console error.

Where do i check for the disable_functions list?

Share this post


Link to post
Share on other sites

If the other bar says AJAX, then that is expected, but your screenshot didn't show that at all, hence my question.

Looking at the error messages for the Console and API Explorer panels more closely, it shows it's actually coming from PW's core FileCompiler.php file on line 384. The PW core uses set_time_limit in many places: https://github.com/processwire/processwire/search?q="set_time_limit"&unscoped_q="set_time_limit" so I think your only decent option is a different host because from what I can tell, one.com doesn't let you enable set_time_limit.

  • Like 1

Share this post


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

If the other bar says AJAX, then that is expected, but your screenshot didn't show that at all, hence my question.

Looking at the error messages for the Console and API Explorer panels more closely, it shows it's actually coming from PW's core FileCompiler.php file on line 384. The PW core uses set_time_limit in many places: https://github.com/processwire/processwire/search?q="set_time_limit"&unscoped_q="set_time_limit" so I think your only decent option is a different host because from what I can tell, one.com doesn't let you enable set_time_limit.

Oki.

Thats unfortunate, because i just changed to one.com 🙂

But everything else seem to work with PW other then the Tracy Debugger.

I get this string:
"disk_total_space, diskfreespace, exec, system, popen, proc_open, proc_nice, shell_exec, passthru, dl"

When i run:
 

<?PHP print_r(ini_get('disable_functions')); ?>

 

Share this post


Link to post
Share on other sites
31 minutes ago, EyeDentify said:

But everything else seem to work with PW other then the Tracy Debugger.

Can you try a few different things for me:

1) Empty the PW trash

2) Do a field export (from the main fields list page)

3) Install the core ProcessPageClone module and click the new "COPY" page list action button

If those all succeed without error, I'll revisit, but otherwise I'll need to update Tracy to be PW 3.x only so that it avoids the FileCompiler completely. That would solve the Console and APIExplorer panel error. The PW Info panel error is due to the Versions List feature trying to check if the system allows runtime modification of max_execution_time so I could conditionally remove or deal with that, but I'd like to make sure those other core PW things work on that host first.

It's also weird how one.com seems to disable set_time_limit / max_execution_time some other way - ie not in disable_functions - make it much harder to detect. 

 

  • Like 1

Share this post


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

Can you try a few different things for me:

1) Empty the PW trash

2) Do a field export (from the main fields list page)

3) Install the core ProcessPageClone module and click the new "COPY" page list action button

If those all succeed without error, I'll revisit, but otherwise I'll need to update Tracy to be PW 3.x only so that it avoids the FileCompiler completely. That would solve the Console and APIExplorer panel error. The PW Info panel error is due to the Versions List feature trying to check if the system allows runtime modification of max_execution_time so I could conditionally remove or deal with that, but I'd like to make sure those other core PW things work on that host first.

It's also weird how one.com seems to disable set_time_limit / max_execution_time some other way - ie not in disable_functions - make it much harder to detect. 

 

 

I did the following:
1. Empty trash
2. Did a sucessfull field export

Did not install the ProcessPageClone because it had no install button, it seems to be manual only.
i am not sure how to install it manually.

And PW says i have an newer version of the ProcessPageClone in the system "1.0.4?"

install_ProcessPageClone.thumb.png.977fc6227b45228b24ab76363f7cf688.png

Share this post


Link to post
Share on other sites

It looks like you already have ProcessPageClone installed - do you have the "copy" button in the Page list action buttons?

Not sure where to go from here - I feel like one.com should be failing on those PW core calls to set_time_limit() as well. Any chance you can give me access to the server - either this one, or another test one at one.com?

 

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

It looks like you already have ProcessPageClone installed - do you have the "copy" button in the Page list action buttons?

Not sure where to go from here - I feel like one.com should be failing on those PW core calls to set_time_limit() as well. Any chance you can give me access to the server - either this one, or another test one at one.com?

 

Hello Again.

I Get a "Copy" option on any pages under the Root in pagelist.

I am going to uninstall Tracy Debugger and install it again and see what happens.
Cause some things have been acting strange like the image upload issue i postet about a short while ago then went away.

I will think about the server access thing.
 

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 FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules DeepL offers translations to the following languages: English (US), English (UK), German, French, Spanish, Portuguese (EU), Portuguese (Brazil, Italian, Dutch, Polish, Russian, Japanese, Chinese (Simplified)
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. This tool is available for all users with the page-edit permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Gitlab issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Gitlab page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      It's Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader). The only cost to use this is a subscription fee for the DeepL Pro API. Find out more and sign up here.
      Download & Feedback
      Download the latest version here
      https://gitlab.com/SkyLundy/fluency-processwire/-/archive/master/fluency-processwire-master.zip
      Gitlab repository:
      https://gitlab.com/SkyLundy/fluency-processwire
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://gitlab.com/SkyLundy/fluency-processwire/-/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • 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

×
×
  • Create New...