Jump to content
kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

@kongondo - thanks - yes, i could also just delete and remake the field, since i can copy the code, and there is no risk of losing entered data...

it would be good to fix though, as surely someone along the way is going to try and rename one of these..

Share this post


Link to post
Share on other sites

 In relation to lister -

So i have this module generating a dynamic link (the link is based off the combination of a page select and some attributes of the page being edited); to get it to work in lister, e.g. where it doesn't end up getting entity encoded, i added this to ready.php:

wire()->addHookAfter('FieldtypeRuntimeMarkup::markupValue', function($event) {
  $value = $event->arguments('value');
  $event->return = $value;
});

should the module assume that the output will be markup and therefore also provide a markupValue by default, or leave this up to the user to add as a hook?

  • Like 1

Share this post


Link to post
Share on other sites

 In relation to lister -

....should the module assume that the output will be markup and therefore also provide a markupValue by default, or leave this up to the user to add as a hook?

Thanks. Good idea. Will provide the method.

Share this post


Link to post
Share on other sites

@kongondo - thanks - yes, i could also just delete and remake the field, since i can copy the code, and there is no risk of losing entered data...

it would be good to fix though, as surely someone along the way is going to try and rename one of these..

@Macrura,

Reported the issue and Ryan fixed it in this commit. I've tested it and it works.

Share this post


Link to post
Share on other sites

Update: version 0.0.2

As requested by @Macrura, added a markupValue() method to correctly output the field's markup output in listers.

  • Like 3

Share this post


Link to post
Share on other sites

awesome, many thanks for this!

will be upgrading mods tomorrow...

Share this post


Link to post
Share on other sites

How can I have the button open a url in a modal? I can't quite get it to work. The modal does appear but then the browser goes to the url.

$url = 'http://example.com';
$out = '<a href="'.$url.'" class="pw-modal pw-modal-large" data-buttons="#non_rte_dialog_buttons button" data-autoclose="1" data-close="#non_rte_cancel">';
$out .= '<button type="button" name="button" class="ui-button ui-widget ui-corner-all ui-state-default">';
$out .= '<span class="ui-button-text">Image Archive</span></button>';
$out .= '</a>';
return "<div class='pfabLink'>".$out."</div>";

Thanks

Share this post


Link to post
Share on other sites

It should work (@adrian) but for some reason the modal quickly closes, so something on PW side doing that. Maybe @adrian used fancybox or something else and you are calling modal.js? I have no idea really.

@adrian, thoughts? Thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites

The page has image field's thumbnail images which use modal and have those "pw-modal" classes and work just fine, so any necessary js and css are in place already. I'd seen that Adrian comment so I know it can be done.

I'm new to jqueryUI so I don't understand the handling of the click event and at what point it does something (return false?) to stop the browser from processing the link as a link and going off to another page. There must be some condition which isn't being met. Could it be a matter of what the A tag is wrapped in?

Answer: Don't use an A tag! Seems simple enough. Just do it all with the button, putting the url in a "data-href" attribute on the button. It's working now.

Drifting off topic but any tips on how best to generate the boilerplate page markup for this iframe so that admin theme styling for an AdminDataTable works. I'm about halfway there.

  • Like 1

Share this post


Link to post
Share on other sites

Hey guys - I actually removed that popup link I was using - not because it didn't work great with RuntimeMarkup, but for other reasons - anyway, I don't have the code I used for it anymore.

But, this works for me:

$url = 'http://www.example.com';
$out = '<button data-href="'.$url.'" type="button" name="button" class="pw-modal pw-modal-large ui-button ui-widget ui-corner-all ui-state-default">';
$out .= '<span class="ui-button-text">Image Archive</span></button>';
return "<div class='pfabLink'>".$out."</div>";
  • Like 1

Share this post


Link to post
Share on other sites

Yup, working for me too. The only wierdness left has to do with button color. Using the default admin theme it's green and turns sort of purple after being clicked to launch the modal. It stays that color after the modal is closed and that seems wrong.

Share this post


Link to post
Share on other sites

Yeah, it needs to be refreshed (the button, i.e.)...

You can use JS for that. Which reminds me, This module comes with an empty InputfieldRuntimeMarkup.js...in which I foolishly state: 

/*Use this file for scripts (js) for your renderend Markup in the page edit in admin, i.e. in the rendered InputfieldRuntimeMarkup*/

...as if those wouldn't be overwritten on the next upgrade, grrr!

Anyway, I will either let the module check for and if found include an 'InputfieldRuntimeMarkupCustom.js', which won't get overwritten on upgrades, or simply, I will ship the module  without a  'InputfieldRuntimeMarkup.js' (and without a  'InputfieldRuntimeMarkup.css' as well). In that case, PW will autoload those files if found and they'll never get overwritten.

So, to your solution. Add the following to your 'InputfieldRuntimeMarkup.js': @note: I added an id="archives" to your button

$(document).ready(function(){
  $('button#archives').on('click', function(){
  //refresh button (remove 'ui-state-active') (only needed for default theme)
  $(this).button().button('refresh');
 });
})

The code could probably be optimized to only run if default admin theme is in use. Maybe could even be used inline but this is cleaner. Maybe there's better solutions as well. The blue (on Chrome) outline around the button can be removed using CSS.

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

Nice! I didn't know about button('refresh'). That works perfectly. Thanks so much for the module too.

I'll be posting something about this "archive" pretty soon in Module/Plugin Development.

Share this post


Link to post
Share on other sites

ok, adding buttons is easy and helpful. can someone help me out when i want to add input fields as well?

usecase is a simple form with one inputfield and one button to copy a page and save it with the name specified in the textfield.

i was able to display the field + button but i was not able to get the data of the field. my $input->post was empty all the time. i tried it like this:

return wireRenderFile('markup/_createcustomcopy');
<?php
$field = $modules->get("InputfieldText");
$field->label = "Name";
$field->attr('id+name','name');
$field->required = 1;
echo $field->render(); // append the field to the form

// oh a submit button!
$submit = $modules->get("InputfieldSubmit");
$submit->attr("value","create copy");
$submit->attr("id+name","createcustomcopy");
echo $submit->render();

echo print_r($input->post, true);

post-2137-0-23494800-1456317817_thumb.pn

i hope someone can point me in the right direction :)

Share this post


Link to post
Share on other sites

I don't share the warm fuzzy feelings I get when I use people's modules nearly often enough, so I just left a comment on the module directory page.

The short version is that it's saving me from having to create custom modules for a lot of places where I'd want to output some custom, processed output when editing a page and it is streamlining some of the steps I need to perform when approving entries in the dev directory, so thanks for this!

  • Like 7

Share this post


Link to post
Share on other sites

@BernhardB,

You should be getting a couple of errors with that code (if you have debug on). In that context, PW doesn't know what $modules and $input are (see similar issues on page 1 of this thread). You need to use $this-> or wire('modules'). Secondly, the module will only return a string or integer. You need to save string/integer output in a variable (e.g. $out) and return $out;

Share this post


Link to post
Share on other sites

hi kongondo,

sorry, it seems i was not clear enough.

in the markup field settings i have

return wireRenderFile(...);

and in this file i have code like this

<?php
// some code here
$out .= 'xxx';
$out .= 'yyy';

echo $out;

so i think at least this should not be a problem as i am only returning a string of html. i was also confused why $modules was available in the file from wireRenderFile() but i guess it has something to do with that method. but to be honest i did not investigate that further.

Share this post


Link to post
Share on other sites

Aah, I see. That's a cool usage of the module you got there! ^-^. Using wireRenderFile() keeps the module's input clean, circumvents limit of text allowed in that field plus makes the module much more versatile. One can do all sorts of flexible includes from within the file rendered by wireRenderFile(), depending on the context. :)

I have tested and it works fine here creating a new page (see below). Cloning a page on the other hand leads to a cyclical error (or memory issue) and crashes Apache. 

In details tab of this module I have:

return wireRenderFile('test');

In /site/templates/test.php

$out ='';

$f = $modules->get("InputfieldText");
$f->label = "Copy Title";// @note: doesn't seem to work
$f->attr('id+name','name');
$f->required = 1;// @note: -ditto-
$out= $f->render(); // append the field to the form

// oh a submit button!
$f = $modules->get("InputfieldSubmit");
$f->attr("value","Create Copy");
$f->attr("id+name","createcustomcopy");
$out .= $f->render();

$currentPage = '';
$process = wire('process'); 
if($process && $process->className() == 'ProcessPageEdit') $currentPage = $process->getPage();
if(!$currentPage) return;

echo $out;

// let's create a copy
$copy = $input->post->createcustomcopy;
$title = $sanitizer->text($input->post->name);

if($copy) {

   if(!$title) {
     $this->error('You need to specify a title for the copied page!');
     return;
   }

   $p = new Page();
   $p->template = $templates->get($currentPage->template);
   $p->parent = $currentPage->parent;

   $p->title = $title;
   //sanitize and convert to a URL friendly page name
   $p->name = $sanitizer->pageName($p->title);

   //check if name already taken within same parent. if the same name exist, don't create a new copy
   //  @note; without this line pages were being created in duplicates
   if($p->parent->child("name={$p->name}, include=all")->id) return;
   else { 
       $p->save();
       $this->message('Created a copy of the page with the title: ' . $title);
   }
}
Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites

Following up on my post above...Say you wanted to embed a YouTube video...for whatever reason...in the page edit context..

<iframe width="420" height="315"
src="https://www.youtube.com/embed/Bohhf3aK8gU" frameborder="0" allowfullscreen>
</iframe>

That's it!

  • Like 1

Share this post


Link to post
Share on other sites

that is awesome!!!! exactly what i wanted, thank you very much :)

Aah, I see. That's a cool usage of the module you got there! ^-^. Using wireRenderFile() keeps the module's input clean, circumvents limit of text allowed in that field plus makes the module much more versatile. One can do all sorts of flexible includes from within the file rendered by wireRenderFile(), depending on the context. :)

yes, i'm a huge fan of wirerenderfile :)

what do you think of having your module render a file with the name of the field by default?

field "examplefield" would render /site/assets/FieldtypeRuntimeMarkup/examplefield.php
field "examplefield2" would render /site/assets/FieldtypeRuntimeMarkup/examplefield2.php

Share this post


Link to post
Share on other sites

So, I tried to use RuntimeMarkup in my RepeaterMatrix and $page refers to the page that the repeater is on. I have placed the RuntimeMarkup field inside repeater entries and therefore, I can't see a way to get a reference to the Page field in the "current" repeater entry. Basically, if I can get a reference to the Page field each time it appears in the repeater, I can simply reference the field value is want from (Template2/Page2) straight from the Page field.

Thanks.

Share this post


Link to post
Share on other sites

I haven't tried this in a repeater...yet. so would have to do that before I can give an answer...unless someone beats me to it?

Share this post


Link to post
Share on other sites

@Gazley,

I don't think this is possible out of the box. Have a read here at a similar question:

https://processwire.com/talk/topic/8962-selectable-pages-defined-dynamically-for-page-field-in-repeater/

What you want is a way to get the current repeater item, basically the nth repeater. I haven't seen any way to do that without looping through all repeaters  - which wont be very efficient.

If your page field is a single page field, using a select, maybe we could use jQuery Ajax to dynamically send the id of the selected page to some template file which would then grab whatever it is you want from template 2, return that as JSON and dynamically add the markup next to the page field. I'm not sure, in your case, whether it's worth the effort going down that route.

Edited by kongondo

Share this post


Link to post
Share on other sites

Btw, above answer refers to normal repeaters. I haven't used repeater matrix before. I am wondering whether, unlike normal repeaters, will be able to give you a 'current repeater item' variable. Anybody knows? Haven't got time to test atm.

Share this post


Link to post
Share on other sites

working the first time with repeater matrix today and it is totally awesome!!

repeater items are just normal pages and you have all you need there:

current repeater-item available under $page variable;

field in your repeater-item-type = $page->yourfield;

current page, where your repeater matrix lives on = $page->getForPage();

don't know how that plays together with your module - i'm quite busy right now :)

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 d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
×
×
  • Create New...