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 thomasaull
      Some time ago I created a site profile for creation of a REST API with ProcessWire. Since I kept struggeling with updating stuff between different projects which use this, I decided to convert it into a module. It is now ready for testing: https://github.com/thomasaull/RestApi
      Additionally I added a few small features:
      automatic creation of JWT Secret at module install routes can be flagged as auth: false, which makes them publicly accessible even though JWT Auth is activated in module settings To check things out, download and install the module and check the folder /site/api for examples.
      If you find any bugs or can think of improvements, please let me know!
    • By kongondo
      Sites Manager
       
      16 September 2018:
      FOR NOW, PLEASE DO NOT USE THIS MODULE IN A PRODUCTION SITE. A  RECENT ProcessWire UPDATE HAS BROKEN THE MODULE. I AM WORKING ON A FIX.
       
      ################
       
      Sites Manager is a module for ProcessWire that allows Superusers to easily create/install ProcessWire sites on the same serverspace the module is running in. Only Superusers can use the module. You can create both stand-alone and multi-sites.
       
      Single/Stand-alone Sites
      Stand-alone or single-sites are sites that will run in their own document root/directory with their own wire and site folders, .htaccess, index.php, etc. In other words, a normal ProcessWire site.
      Multiple Sites
      Multi-sites are sites that will run off one wire folder (shared amongst two or more sites) each having their own site folder and database. In this regard, it is important to note that Sites Manager is not in itself a multiple sites solution! Rather, it is a utility that helps you create multi-sites to be run using the ProcessWire core multiple sites feature. For more on this core feature, see the official ProcessWire documentation, specifically the solution referred to as Option #1.
      Option #1 approach requires the site admin to initially install ProcessWire in a temporary directory for each new site. The directory then needs to be renamed as site-xxx, where ‘xxx’ is any name you want to use to differentiate the installation from other sites, before it is moved to the webroot. For instance, site-mysite, site-another, site-whatever. In addition, the /wire/index.config.php file must be copied/moved to the webroot. Each time a site is added, the index.config.php has to be edited to add ‘domain’ => ‘site-directory’ key=>value pairs for the site. This process can become a bit tedious. This module aims to automate the whole multi-site site creation process.
      The module is based off the official ProcessWire installer. Creating a site is as simple as completing and submitting a single form! You also have the option to type and paste values or reuse a pre-defined install configuration.
       
      The module will:
      Install a ProcessWire site in your named directory, applying chmod values as specified
      Move the directory to your webroot
      Update/Create a Superuser account as per the submitted form, including setting the desired admin theme and colour
      For multi sites, update sites.json (used by index.config.php to get array of installed sites)
       
      For multi sites, the only difference in relation to the core multi-sites index.config.php is that this file is slightly different from the one that ships with ProcessWire.
      Download from GitHub: Sites Manager (Beta Release)
      Features
      Install unlimited number of sites in one (multi-sites) or independent (single-site) ProcessWire installs. Install by completing a Form, Typing or pasting in configurations or using pre-created install configurations. Choose an Admin Theme to auto-install along with the site installation. For single-sites installation, download, save and reuse ProcessWire versions of your choice. Install and maintain site profiles for reuse to create other sites. Create install configurations to speed up installation tasks. Client and server-side validation of site creation values. Edit uploaded profiles (e.g., replace profile file). Lock installed sites, configurations and profiles to prevent editing. Bulk delete items such as site profiles, installed site directories and/or databases (confirmation required for latter two). View important site details (admin login, chmod, etc). Links to installed sites home and admin pages. Timezones auto-complete/-suggest. Pre-requisites, Installation & Usage
      Please see the documentation.
      Technicalities/Issues
      Only Superusers can use the module.
      ProcessWire 2.7 - 3.x compatible
      Currently using ProcessWire 2.7 installer (install.php)
      For multi-sites, potential race condition when sites.json is being updated on a new site install vs. index.config.php accessing the json file?
      Not tested with sub-directory installs (for instance localhost/pw/my-site-here/)
      Currently not doing the extra/experimental database stuff (database charset and engine)
      Future Possibilities
      Install specified modules along with the ProcessWire install
      Profile previews?
      Credits
      @ryan: for the ProcessWire installer
      @abdus: for the index.config.php reading from JSON idea
      @swampmusic: for the challenge
      Video Demo
      Demo  showing how quick module works on a remote server [YMMV!]. Video shows downloading and processing two versions of ProcessWire (~takes 7 seconds) and installing a single/stand-alone ProcessWire 3 site using the new Admin Theme UI Kit (~2 seconds) on a remote server.
       
      Screens
      1

      2

       
       
    • By Robin S
      Breadcrumb Dropdowns
      Adds dropdown menus of page edit links to the breadcrumbs in Page Edit.

      Installation
      Install the Breadcrumb Dropdowns module. The module requires ProcessWire >= v3.0.83 and AdminThemeUikit.
      There is a checkbox option in the module config that determines if the breadcrumb dropdowns will include pages that the user does not have permission to edit.
      Features/details
      The module adds an additional breadcrumb item at the end for the currently edited page. That's because I think it's more intuitive for the dropdown under each breadcrumb item to show the item's sibling pages rather than the item's child pages. In the dropdown menus the current page and the current page's parents are highlighted in a crimson colour to make it easier to quickly locate them in case you want to edit the next or previous sibling page. Unpublished and hidden pages are indicated in the dropdowns with similar styling to that used in Page List. If the option to include uneditable pages is selected then those pages are indicated by italics with a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. If the current user is allowed to add new pages under the parent page an "Add New" link is shown at the bottom of the breadcrumb dropdown. If the currently edited page has children or the user may add children, a caret at the end of the breadcrumbs reveals a dropdown of up to the first 25 children and/or an "Add New" link. Overriding the listed siblings for a page
      If you want to override the siblings that are listed in the dropdowns you can hook the BreadcrumbDropdowns::getSiblingsmethod and change the returned PageArray. For most use cases this won't be necessary.
      Incompatibilities
      This module replaces the AdminThemeUikit::renderBreadcrumbs method so will potentially be incompatible with other modules that hook the same method.
       
      https://modules.processwire.com/modules/breadcrumb-dropdowns/
      https://github.com/Toutouwai/BreadcrumbDropdowns
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour (excl vat).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Ken Muldrew
      I'm trying to get a short routine to run once per day that will look at some pages and send a reminder email when that customer's subscription (yearly) is about to expire. When I run the code in a template then it works without issue, but inside my lazycron service routine, I get an "Error: Uncaught Error: Call to a member function get() on null" as if the database cannot be found. My autoload module is just the sample HelloWorld module included with ProcessWire, editted to perform this task. The whole of it is included below (I've stripped out the code that generates the email because it never gets past $pages->find):
       
      <?php namespace ProcessWire;
      /**
       * ProcessWire 'LazyCronLoad'  module
       *
       */
      class LazyCronLoad extends WireData implements Module {
          public static function getModuleInfo() {
              return array(
                  'title' => 'LazyCronLoad', 
                  'version' => 1, 
                  'summary' => 'Just loads a lazy cron callback.',
                  'singular' => true, 
                  'autoload' => true, 
                  );
          }
          public function init() {
              // initialize the hook in the AutoLoad module
              $this->addHook('LazyCron::everyDay', $this, 'myHook');
              
          }
          public function myHook(HookEvent $e) {
              // called once per day
              wire('log')->save('user_activities',' lazy cron service routine');
                  $transport_pages = $pages->find("template=aggregate-entry, aggregate_type.title='Transport'");
                  foreach ($transport_pages as $page) {
                      if (($page->purchase_date + 30325800 < time()) && ($page->purchase_date + 30412600 > time())) { // between 351 and 352 days
                          wire('log')->save('user_activities', $page->id . ' email reminder sent');
                          // send email
                  }
              }
          }        
          
      }
      The first wire('log') shows up but the second one doesn't (the purchase_date condition is met (as demonstrated by running the code in a template close in time to when the lazycron routine executes)). The error log gives the Uncaught Error shown above. 
      I think this is a beginner's mistake with something obvious being missed and would be grateful for any assistance in fixing it.