kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

@berhard - In the module when a RuntimeMarkupField runs inside a repeater, $page references the page that the repeater is on, not the repeater iteration instance.

Share this post


Link to post
Share on other sites

@Gazley, we can probably get around that. The main issue for me is how to reference the current repeater matrix item, basically the 'neighbouring' page field. In normal repeaters, fields are grouped (using their modified field-names) like so in one repeater item:

email_repeater3157            page_field_name_repeater3157             runtime_markup_field_name3157         eq(0)

email_repeater3179            page_field_name_repeater3179             runtime_markup_field_name3179         eq(1)

What is needed is a way to get the eq(n) of the repeater or the 3157 (the ID of the page where the fields actually live - hidden repeater page in admin)

Btw, $page->getForPage() won't cut it because this is the current page that has all those repeater items, in other words the $page in your RuntimeMarkup field. It seems the $page variable will do it? I don't even have a PW 3.x install ( :-X ) which RepeaterMatrix requires to test this. Time, oh time...

Edited by kongondo

Share this post


Link to post
Share on other sites

I added this small tweak to the FieldType, which allows me to use the Ace extended for my code editing..

if(wire('modules')->get('InputfieldAceExtended')) {
	$f = $this->modules->get('InputfieldAceExtended');
	$f->mode = "php";
	$f->theme = "monokai";
} else {
	$f = $this->modules->get('InputfieldTextarea'); 
}
  • Like 4

Share this post


Link to post
Share on other sites

Thanks Macrura...had let this slip under the radar. I'll add it as an option so users get to choose (and why wouldn't they?) if they want the textarea formatted with ace or not...

  • Like 3

Share this post


Link to post
Share on other sites

cool - yeah the only slight snafu is that if you want syntax highlighting, you have to add an opening php tag, so if i'm editing, i add that and then i delete it before saving; not sure though if there is any way around that, but haven't looked into it yet...

Share this post


Link to post
Share on other sites
Error: Call to undefined function wireRenderFile() (line 1 of .../FieldtypeRuntimeMarkup.module(98) : eval()'d code) 
This error message was shown because: you are logged in as a Superuser. Error has been logged.

hi @kongondo

i get this error after updating from pw 2.7.3 to pw 3.0.28

i have this in my custom php field:

return wireRenderFile('_pageactions');

changing it to this:

namespace Processwire;
return wireRenderFile('_pageactions');

solves the problem. don't know how bullet-proof this is? maybe you could add this automatically when using namespaces?

Share this post


Link to post
Share on other sites

thanks again for this awesome field! if anybody needs excel-like tables this is easily possible like this (startingpoint):

  • create a folder like /site/modules/HandsonTable
  • copy https://github.com/handsontable/handsontable to this folder
  • create a runtime field with this content: return wireRenderFile('../modules/HandsonTable/HandsonTable.php');
  • create your php-file /site/modules/HandsonTable/HandsonTable.php
<?php
$config->scripts->append($config->urls->siteModules . "HandsonTable/handsontable/dist/handsontable.full.js");
$config->scripts->append($config->urls->siteModules . "HandsonTable/handsontable/dist/moment/moment.js");
$config->scripts->append($config->urls->siteModules . "HandsonTable/handsontable/dist/pikaday/pikaday.js");
$config->styles->append($config->urls->siteModules . "HandsonTable/handsontable/dist/handsontable.full.css");
$config->styles->append($config->urls->siteModules . "HandsonTable/handsontable/dist/pikaday/pikaday.css");
?>

<div id="example"></div>
<script>
var data = [
  ["", "Ford", "Volvo", "Toyota", "Honda"],
  ["2016", 10, 11, 12, 13],
  ["2017", 20, 11, 14, 13],
  ["2018", 30, 15, 12, 13]
];

var container = document.getElementById('example');
var hot = new Handsontable(container, {
  data: data,
  rowHeaders: true,
  colHeaders: true
});
</script>

moment and pickaday are not needed in this example and just as a showcase and reminder...

2016-09-16 15_46_57-Edit Page_ Impulstag für Motivation und Erfolg - Graz (Listenexport) • mentalest.png

It get's a little more complicated if you need storing/editing features but i need it only to show some data and my client can copy/paste data to excel/google drive sheets.

  • Like 7

Share this post


Link to post
Share on other sites
On 02/08/2016 at 11:31 AM, bernhard said:

Error: Call to undefined function wireRenderFile() (line 1 of .../FieldtypeRuntimeMarkup.module(98) : eval()'d code) 
This error message was shown because: you are logged in as a Superuser. Error has been logged.

hi @kongondo

i get this error after updating from pw 2.7.3 to pw 3.0.28

i have this in my custom php field:


return wireRenderFile('_pageactions');

changing it to this:


namespace Processwire;
return wireRenderFile('_pageactions');

solves the problem. don't know how bullet-proof this is? maybe you could add this automatically when using namespaces?

I think it's easier if the dev themselves added the namespace. Even this one-liner would have worked for you...

return ProcessWire\wireRenderFile('_pageactions');

 

Share this post


Link to post
Share on other sites

Announcing that I've tested and can confirm that RuntimeMarkup is compatible with ProcessWire 2.8.x and ProcessWire 3.x

  • Like 6

Share this post


Link to post
Share on other sites

Hi Kongondo

I have tried your master and dev versions with PW 3.0.36 and only get errors.

Using your example code or something simple like 'return $page->parent->title;'  gets the resulting error:

Only strings and integers should be returned by your custom code! Check if your code is valid.

'return "hello";' works - but thats not so useful.

I am running php 5.4.4  -  might that be the issue?

 

Kind regards

Nik

 

Share this post


Link to post
Share on other sites

@NikNak. Works fine for me on PW 3.0.42 and PHP 5.4.22 .  You need to ensure that your code returns a value. For wireRenderFile you will need to namespace the function in PW 3.

 

Share this post


Link to post
Share on other sites

Thanks.

I tried the simplest of things, and namespaced it too, but couldnt get any output other than an error.

Not to worry - I'll do more testing.

Many thanks

Nik

Share this post


Link to post
Share on other sites

Any chance $page->parent->title; is returning an object due to multi-language?

Share this post


Link to post
Share on other sites

I've done some more testing. The module is working on normal pages whereas I was initially trying it out on $user pages, where it failed.  

Kind regards

Nik

Share this post


Link to post
Share on other sites
return wire('users')->get(40)->name;

@NikNak

That will return guest. Only $page and $pages are locally scoped, as per the description right above the input for code;). I guess that and the docs should perhaps be clearer.

Share this post


Link to post
Share on other sites

Thanks Kongondo - it's just me being thicker than usual - no problem with the description ;-)

 

I assume this means that you cannot self reference fields on a $user page being edited.

EDIT: The below solves what I was trying to do - thanks Kongondo

$process = wire('process'); 
$u = $process->getPage();
$id = $u->id;
return $id;// will return 40 for guest, 41 for superuser, etc...
//return $process->className();// would return ProcessUser. Useful to know if you are using the field elsewhere and want to do different things based on context
// return $u->email;// etc...

 

Kind regards

Nik

Edited by NikNak

Share this post


Link to post
Share on other sites

Just came here to say that this module works brilliantly!

I have made an "email sender field" that uses the page's data to manage surveys for a certain product and right now I'm doing a "defaults selection for repeater field" for a repeatear field with page fields in it that will describe features of a product. It's really nice to just hack your way so fast with this!

I use it with wireRenderFile() which rules because it lets me handle the markup nicely in a separate file in my preferred text editor.

EDIT: Added "mail settings" screenshot. Jus realized my description text is all messed up engrish

Screen Shot 2017-01-11 at 8.11.32 AM.png

  • Like 4

Share this post


Link to post
Share on other sites

I tried this module today to output a video preview from a multilanguage field. Worked like a charm. :) See the screenshot.

I created two fields, one for the default language (English) and one for Portuguese. 

Here's the code for both, if someone's interested:

English field:

return '<iframe src="https://www.youtube.com/embed/'.$page->youtube_id.'/?showinfo=0&amp;iv_load_policy=3&amp;controls=1" frameborder="0" allowfullscreen width="100%"></iframe>';

Portuguese field:

//1021 is the 'portuguese' language page id
$youtube_id = $page->youtube_id->getLanguageValue(1021);

return '<iframe src="https://www.youtube.com/embed/'.$youtube_id.'/?showinfo=0&amp;iv_load_policy=3&amp;controls=1" frameborder="0" allowfullscreen width="100%"></iframe>';

Thanks @kongondo for this great module!

video_preview.png

  • Like 8

Share this post


Link to post
Share on other sites

Hi there,

I use this field type with translateable strings and it works. My problem is I cannot find where I could translate it in the backend.

Example:

Fieldname: calendarbox

PHP code inside this field:

Screenshot_4.jpg

The output in the backend works. Maybe I have to create the translateable file manually.

Can anyone help me out?

Best regards

Share this post


Link to post
Share on other sites

i guess you could use wireRenderFile, then it should show up in the backend.

  • Like 2

Share this post


Link to post
Share on other sites

Just a quick by the way, I recently updated the first post in this thread to state that the wireRenderFile() approach is the recommended way to use this module. I'll update the README too when I get the time.

  • Like 4

Share this post


Link to post
Share on other sites

you could also put everything in one file to have all translations aggregated in one page in the admin

custom code:

return wireRenderFile('fieldmarkup', array('field' => 'calendarbox'));

fieldmarkup.php

<?php
switch ($field) {
    case 'calendarbox':
        $out = '<div>...</div>';
        $out .= '<p>...</p>';
        echo $out;
        break;
}

i guess for easy fields that would be better than having a file for each field...

  • 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 bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public:
       
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
       
    • By Soma
      LogMaintenance
      A simple ProcessWire module to give some maintenance control over log files. I found myself often having lots of log files for different things that can grow more or less quickly to a size where they can be difficult to maintain. The built in Logger of PW does a good job of giving you the possibility to delete or prune logs. But it has to be done manually and sometimes a log grows into millions of lines, which makes it often impossible to even prune it as it's too large.
      LogMaintenance uses LazyCron to run the maintenance task and there's several settings you can setup on a global or per log basis.
      Archive: will create zip files for each log file in logs/archive/ folder and add the log each time the maintenance is run to a subfolder containing the datetime.
      Lines: keeps logs to a certain number of lines 
      Days: keeps the log to a certain number of days
      Bytes: keeps the log to a certain amount of bytes
      Each setting is checked from top down, the first setting to contain something is used. So if you check the "Archive" option, all other settings are ignored and logs are archived everytime the LazyCron is executed. If you want to keep your logs to a certain amount of bytes just leave all other settings to 0 or blank.
      Per Log Settings
      There's a textarea that you can use to setup a config for a specific log file one per line. All the logs you define here ignore the global settings above. The syntax for the settings is:
      logname:[archive]:[lines]:[days]:[bytes] 
      errors:1:0:0:0 // would archive the errors log messages:0:10000:0:0 // will prune the errors log to 10000 lines  
      The module can be found on github for you to check out. It's still fresh and I'm currently testing.
      https://github.com/somatonic/LogMaintenance
    • By teppo
      Fieldtype Page IDs is a third party Fieldtype that, simply put, stores Page references as integers (Page IDs).
      This fieldtype was built as a quick and dirty workaround for Page Reference fields' inability handle self-references due to circular reference issues. A project I've been working on for a while now includes a combination of RepeaterMatrix content blocks and tagging/categorization system that would've resulted in a lot of duplicate pages (and plenty of unnecessary manual work for content editors) had I used built-in Page Reference fields, and thus a new Fieldtype felt like the most sensible approach.
      Fieldtype Page IDs was designed to be loosely compatible with Page References in order to make conversions between the two feasible, but it is quite limited feature wise:
      largely due to the fact that stored values are actually just integers with no connection to Pages whatsoever some advanced selectors and related features are not supported, and page values can't be directly accessed configuration settings are limited to the bare essentials (selector string and Inputfield class) only a handful of Inputfields (AsmSelect, Checkboxes, Text) are (currently) supported Anyway, in case you need to store Page IDs (and Page IDs only) and are happy with the limitations mentioned above, feel free to give this Fieldtype a try. It has been working fine for me in one particular project, but hasn't been tested that much, so please tread carefully – and let me know if you run into any issues.
      GitHub repository: https://github.com/teppokoivula/FieldtypePageIDs
      Modules directory: https://modules.processwire.com/modules/fieldtype-page-ids/
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      I've updated the module to 0.0.4. I removed the instructions from this forum, so I don't have to maintain it on multiple places. Just checkout the readme on github 🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github. 
    • By bernhard
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      180528, v1.0.4 add custom select statement option 180516 change sql query method, bump version to 1.0.0 180515 multilang bugfix 180513 beta release <180513 preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/