Jump to content
kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

Hey @kongondo - these changes seem to work well and prevent any unnecessary re-rendering of the output.

In the fieldtype, I change these three methods to return true.

    public function ___sleepValue(Page $page, Field $field, $value) {
        //return $this->renderMarkup($page, $field);
        return true;
    }

    public function getLoadQuery(Field $field, DatabaseQuerySelect $query) {
        // prevent loading from DB
        return $query;
    }

    public function ___loadPageField(Page $page, Field $field) {
        // generate value at runtime rather than loading from DB
        //return $this->renderMarkup($page, $field);
        return true;
    }

And in the inputfield I replace the ___render() method with the following which returns the wakeup value without re-rendering.

    public function ___render() {

        //if code field is empty return early
        if(!$this->runtimeFields) return;

        //so that $page and $pages are locally scoped to the eval
        $process = $this->wire('process');
        if($process && ($process->className() == 'ProcessPageEdit' || $process->className() == 'ProcessUser')) {
            $page = $process->getPage();
            return $page->{$this->name};
        }
        else {
            return;
        }

    }

Let me know if you have any questions / comments about this approach.

Thanks again for an invaluable module!

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites
On 2/13/2019 at 6:20 PM, adrian said:

Let me know if you have any questions / comments about this approach.

Thanks @adrian. I'll have a look (but not sure when :)). I'm swamped all around!

 

If it's not too much to ask, could you please create an issue and reference your post above? Thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites

I've been using this field type for a while and very good it is too, but now I am scratching my head:

I have a runtime_markup field ('runtime_markup_expiryDate') with PHP as follows

return ($page->parent->name == 'memberships' and $page->latestSubscription()->id) ? date('d/m/Y', $page->latestSubscription()->subsEndDate) : 'Non-subscriber';

This works well in the back-end, but gives the wrong result in the API. If I retrieve the field in the API, it just gives 01/01/1970.

However, if I remove the formatting in the PHP, thus:

return ($page->parent->name == 'memberships' and $page->latestSubscription()->id) ? $page->latestSubscription()->subsEndDate : 'Non-subscriber';

it works correctly in the API (gives the right date, e.g. 30/09/2019) but obviously just gives the integer in the back end (e.g. 1569798000). The curious thing is that, in this case I can't work out where the formatting is applied in the API (which might be related to the cause of the problem)

What is going on? Any suggestions for a fix or work-round?

Thanks.

Share this post


Link to post
Share on other sites
date('d/m/Y', $page->latestSubscription()->subsEndDate) // change this
date('d/m/Y', $page->latestSubscription()->getUnformatted('subsEndDate')) // to this

 

  • Like 3

Share this post


Link to post
Share on other sites

Update version 006 - 11 May 2019

Finally got a bit of time to work on this module.

Changelog

  • Namespacing: ProcessWire 3.x Support only from now on.
  • Removed the module's CSS and JS files. They are unnecessary.
  •  Switched to $files->render() instead of wireRenderFile().
  • Option to check for and optionally use InputfieldAceExtended for code highlighting in the PHP custom code textarea. Thanks to @adrian , @diogo and others who suggested this.
  • Option to specify number of rows for the PHP custom code textarea (@note: for some reason, it's not working with Ace Extended. It does work with plain textarea).
  • Removed the option (in field settings) to search for files to render under /site/modules/FieldTypeRuntimeMarkup/ as these could get overwritten during upgrades.
  • Refactored code to prevent unnecessary re-rendering of output, thanks @adrian
  • Render PHP file mode is now supported for frontend use as well, thanks @Noel Boss
  • Changed license to MIT.

Please note this is the new master and is available in the modules directory.

Screenshots

rtm_005_code_highlight_and_rows_config.thumb.jpg.2a390851d3dd63540b8828b87ed62c37.jpg

Over to you @bernhard 😀.

 

Edited by kongondo
  • Like 6

Share this post


Link to post
Share on other sites

Btw, mainly for @bernhard and @adrian who have previously looked at RTM code, InputfieldRuntimeMarkup now behaves similar to many inputfields in that it gets its values from the Fieldtype's wakeupValue(), i.e. from $this->attr('value').  The previous implementation seemed a bit unclean to me when I looked at it recently. We had the inputfield doing its own eval() or wireRenderFile(). Now I've moved everything to FieldtypeRuntimeMarkup plus added a small helper class in there to handle such things. All the inputfield does now is serve values, as inputfields are meant to do.

  • Like 3

Share this post


Link to post
Share on other sites

Hello @kongondo

I updated a site to v.0.0.6 and now when trying to edit a – seemingly unrelated – TextareaLanguage field by using the field overwrite editor modal of a template I get this:

Fatal Error: Uncaught Error: Class 'ProcessWire\RuntimeMarkupUtilities' not found in .../site/modules/FieldtypeRuntimeMarkup/InputfieldRuntimeMarkup.module:68
Stack trace:
#0 .../wire/core/Modules.php(624): ProcessWire\InputfieldRuntimeMarkup->init()
#1 .../wire/core/Modules.php(1336): ProcessWire\Modules->initModule(Object(ProcessWire\InputfieldRuntimeMarkup), Array)
#2 .../wire/core/Modules.php(1193): ProcessWire\Modules->getModule('InputfieldRunti...')
#3 .../wire/core/Modules.php(1566): ProcessWire\Modules->get('InputfieldRunti...')
#4 .../wire/modules/Fieldtype/FieldtypeTextareaHelper.php(40): ProcessWire\Modules->find('className^=Inpu...')
#5 .../wire/modules/Fieldtype/FieldtypeTextarea.module(338): ProcessWire\FieldtypeTextareaHelper->getConfigInputfields(Object(Proce (line 68 of .../site/modules/FieldtypeRuntimeMarkup/InputfieldRuntimeMarkup.module)

This error message was shown because: site is in debug mode. ($config->debug = true; => /site/config.php). Administrator has been notified. Error has been logged.

I tried uninstalling the module (because the site does not use it yet anyway, meaning there is no field using RuntimeMarkup) and when I click on the uninstall button I also get: 

Class 'ProcessWire\RuntimeMarkupUtilities' not found 

However, if I create a RuntimeMarkup field then the error goes away in both cases described above. It looks like the case when there is no RuntimeMarkup filed in the system is not taken into account. So with a RuntimeMarkup field created, I could uninstall the module as the fatal error did not crop up in that case.

Also note that I find it strange that both FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup show up as RuntimeMarkup in the module list, see the screenshots:

Spoiler

RuntimeMarkup-module-shots.thumb.gif.4f86c5662891c2fe7e6f38c6953bb6ff.gif

 

Edited by szabesz
Also see my next post below.

Share this post


Link to post
Share on other sites
21 hours ago, szabesz said:

Also note that I find it strange that both FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup show up as RuntimeMarkup in the module list, see the screenshots:

Sorry, rookie mistake on my part :-). I had them both with identical titles. Corrected in 007.

21 hours ago, szabesz said:

I updated a site to v.0.0.6 and now when trying to edit a – seemingly unrelated – TextareaLanguage field by using the field overwrite editor modal of a template I get this:

Hmm. That's very strange. By 'overwrite editor modal', do you mean the one where you can overwrite a field's 'original' label, description, notes, etc for a specific template?

Are you able give me more details please?

  1. Which field values did you try to edit?
  2. Did the error crop up after saving or as soon as you opened the modal?
  3. ProcessWire version

Thanks.

  • Like 1

Share this post


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

By 'overwrite editor modal', do you mean the one where you can overwrite a field's 'original' label, description, notes, etc for a specific template?

Yes.

11 minutes ago, kongondo said:

Are you able give me more details please?

I'd rather give you access to the site (as it is not yet live anyway) so that you can also use Tracy's file editor to poke around. What do you think?

BTW, I could not really uninstall the module, it was just FieldtypeRuntimeMarkup which seemingly went through the uninstall process, but PW – as expected – kept complaining about InputfieldRuntimeMarkup being used when I also clicked the uninstall button of that one. However, if I delete the RuntimeMarkup filed, I am back where I started.

Share this post


Link to post
Share on other sites
On 6/13/2019 at 1:36 PM, szabesz said:

I'd rather give you access to the site (as it is not yet live anyway) so that you can also use Tracy's file editor to poke around. What do you think?

OK, but before that, since another user has experienced some issues with the Utility Class, I think I'll just move the class to its own file and require it. We'll try that first to see if it solves your issue. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites
On 6/21/2019 at 10:41 AM, kongondo said:

OK, but before that, since another user has experienced some issues with the Utility Class, I think I'll just move the class to its own file and require it. We'll try that first to see if it solves your issue.

Hello @kongondo

Any news on this issue? I also run into it when trying to export a textarea field via the standard field export feature of the admin. I don't really need Runtime Markup, maybe you can give me a quick guide on how to remove it manually (inluding how to clean up the db if needed?).

On 6/13/2019 at 2:17 PM, kongondo said:

Corrected in 007.

Has this version been version published yet?

Thanks in advance.

Share this post


Link to post
Share on other sites

Are there known limitations in the plugin?

For example i cannot resize an image.

Then I wanted to get the original image but I cannot get the url.
$image->url  gives me just the folder where the image is but not the file-name.
$image->basename gives me nothing.

Textfields are working as expected.

"PHP Runtime Code Mode" is set to "Paste PHP code".

Share this post


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

For example i cannot resize an image.

Then I wanted to get the original image but I cannot get the url.
$image->url  gives me just the folder where the image is but not the file-name.
$image->basename gives me nothing.

Hard to tell without seeing some code. Maybe you image field is set to contain multiple images. In that case $image->url may not work. Could we see some code please.

1 hour ago, 2hoch11 said:

"PHP Runtime Code Mode" is set to "Paste PHP code".

Please note that it is advisable to use the option Render PHP file(s) instead.

Share this post


Link to post
Share on other sites

@kongondo If you have some time, could you please look into the issue I have? Please see above. Thanks in advance!

 

Share this post


Link to post
Share on other sites

@kongondo

So in other words resizing images should work the same way like it works in the frontend…

However, now I have an external file (instead of pasting php in the backend) but there was no difference… then I added "first()" to the image and now it works as expected:

$imageResized = $image->first()->size(400,400);

This is pretty strange because I already have an output of this image field in the frontend and it works without "first()"…

Share this post


Link to post
Share on other sites
51 minutes ago, 2hoch11 said:

This is pretty strange because I already have an output of this image field in the frontend and it works without "first()"…

Aah. I see what is happening. It isn't strange, actually, but working as expected. When output formatting is off, the value of an image or file field is always a WireArray irrespective of the field's maximum files allowed or the setting in formatted value. There is a note on the field. Please see the screenshot on this post.

The reason you didn't need first() in the frontend is because output formatting is on there. In the backend, where your rtm external file is called, output formatting is off, hence the need for first(). You can test this by using TracyDebugger to dump the results of the image field in both your external rtm file and in the template file used in the frontend. You should see the backend dump returning Pageimages and the frontend one Pageimage as illustrated below.

bd(get_class($page->image));

Backend dump

single_image_of_off.png.a3609c441e27a2deece4ff05b7a70d39.png

Frontend dump

single_image_of_on.png.cfd1dd0022c15587455f5de9e5427fba.png

  • Thanks 1

Share this post


Link to post
Share on other sites
11 hours ago, szabesz said:

@kongondo If you have some time, could you please look into the issue I have? Please see above. Thanks in advance!

 

Oops, sorry, totally slipped my mind! I'll have a look 😄.

  • Thanks 1

Share this post


Link to post
Share on other sites

I have been using this module successfully for some time. Now I have a more complex use case. I want to update the page (in the admin) using ajax, rather than having to manually select "save". However, in this case, the data is submitted OK but the RuntimeMarkup script does not run and so the page is not properly updated. Any ideas?

Thanks.

Edit. I'm not entirely sure if the problem just lies with this module since, although the ajax is returning 'success' the normal fields don't appear to update either.

Share this post


Link to post
Share on other sites
13 hours ago, MarkE said:

Edit. I'm not entirely sure if the problem just lies with this module since, although the ajax is returning 'success' the normal fields don't appear to update either.

Solved now - the problem is in the jquery ajax call - using method: with version 1.8.3 - it should be type: prior to 1.9. See 

 

Share this post


Link to post
Share on other sites

@kongondo is there any update about how to properly uninstall this module ? i have same error message like @szabesz case.

Thanks

Share this post


Link to post
Share on other sites

Hmm... When I try to uninstall the module I get this error... ? 🤔

172829_Skrmbillede2020-03-21kl_18_50_35.thumb.png.f87e8f62bda52884ac39636b194a19b8.png

 

EDIT: //

Hmm... 

I don't know what changed but after having refreshed my modules the uninstaller worked

(Resolved)

 

All the best,

Jonatan

Share this post


Link to post
Share on other sites
On 3/10/2020 at 10:39 AM, pwfans said:

@kongondo is there any update about how to properly uninstall this module ? i have same error message like @szabesz case.

Thanks

Sorry all, I haven't yet found time to act on this. I need time to investigate it properly.

  • Like 1

Share this post


Link to post
Share on other sites
On 3/27/2020 at 2:42 AM, kongondo said:

Sorry all, I haven't yet found time to act on this. I need time to investigate it properly.

Encountered this issue too. The following change to InputfieldRuntimeMarkup appears to have fixed the missing utilities class:

<?php

	public function init() {
		// parent::init();
		// get the helper class (included in FieldtypeRuntimeMarkup.module file)
        $this->classLoader->loadClass('FieldtypeRuntimeMarkup'); // add this line to ensure the RuntimeMarkupUtilities class is available
		$this->rtmUtilities = new RuntimeMarkupUtilities();
	}

Can now install, uninstall, create & delete fields, etc without problems.

I needed this module for a FormBuilder form but sadly the module's configurable fields aren't available in FormBuilder 😢

  • Like 1

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 MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
×
×
  • Create New...