kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
 
Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
 
This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
 
The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
 
The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
 
The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
 
Warning/Consideration

  • Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional)
  • The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find().

Usage and API

 
Backend

Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
 
FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
 
A very simple example.

return 'Hello';

Simple example.

return $page->title;

Simple example with markup.

return '<h2>' . $page->title . '</h2>';

Another simple example with markup.

$out = '<h1>hello ';
$out .= $page->title;
$out .= '</h1>';
return $out;

A more advanced example.

$p = $pages->get('/about-us/')->child('sort=random');
return '<p>' . $p->title . '</p>';

An even more complex example.

$str ='';
if($page->name == 'about-us') {
  $p = $page->children->last();
  $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>";
}

else {
  $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>";
}

return $str;

Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:

return wireRenderFile('name-of-file');// file will be in /site/templates/

If using ProcessWire 3.x, you will need to use namespace as follows:

return ProcessWire\wireRenderFile('name-of-file');

How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
 
Access the field on the current page (just like any other field)

echo $page->runtime_markup;

Access the field on another page

echo $pages->get('/about-us/')->runtime_markup;

Screenshots
 
Backend
 
screenshot1.png
 
screenshot2.png
 
Frontend
 
screenshot3.png

  • Like 23
  • Thanks 1

Share this post


Link to post
Share on other sites

I think I understand what this module does but I'm having trouble grasping the situations in which it would be useful based on the examples you've given.

Is it just a convenience thing, so the editor doesn't have to look elsewhere for some information that might affect the content they decide to add to the page?

Share this post


Link to post
Share on other sites

There are many usefull situations like:

1. If you have a page for settings or tools with general entries/items and you use them on other pages like in a contactform you use the email field from the /settings/ page you could show this general fields on several places/templates

2. more advanced example could be to render statistic like content from subpages - imagine if you have a ad system that is counting views and clicks you could render a little stat with some html and some css/js at the rootpage of the ad's...

3. special for overview pages/rootpages it provides options to put some extra information/logic in such pages without the use of pagetable or something other complex..

4....

you get the idea

regards mr-fan

  • Like 3

Share this post


Link to post
Share on other sites

Simple answer is that @Valan had a need and commissioned me to develop this :biggrin: . 

Seriously though, mr-fan already covered it brilliantly. When I get some time, I'll post some other examples.

  • Like 2

Share this post


Link to post
Share on other sites

I have used a homemade solution to display information of related pages in the editor, which are needed to know how to handle the page (essentially user requests).

  • Like 2

Share this post


Link to post
Share on other sites

This is such a great module; recently I used it to create custom action buttons on my calendar/futuremail app;

Send or preview the email message for the future mail:

post-136-0-22253700-1443749172_thumb.png

send or preview a calendar event, which is typed by a chosen template (e.g. event, lesson reminder, etc.)

post-136-0-31179600-1443749173_thumb.png

  • Like 12

Share this post


Link to post
Share on other sites

Macrura - very cool - I hadn't thought of using it that way and will actually need similar buttons in an upcoming project so might just consider using this module to do it!

The trouble I am having with PW lately is that there are so many great new ways of doing things and it's hard to keep track of them all :)

  • Like 4

Share this post


Link to post
Share on other sites

In my case i only have 1 field and then my code checks for which template it's on, then outputs various buttons and messages; the buttons themselves just link to templates that read the url parameters and run some process. Eventually i'll probably have a generic module to process the buttons..

i think I'm going to be using this a lot!

  • Like 3

Share this post


Link to post
Share on other sites

Thank you Kongondo & @Valan for this great little helper!

For me as a non real dev...it is much more easy to get some special admin magic working with this!

This is one of the real big things i like with PW - there are tools that helps and can used by non experienced PHP users without to force them to do risky things within the backend...in other systems the level of complexity always grows and grows...with PW it seems it always get easier ;)

I'm on a hard deadline this days so less time to contribute but this little snippet may helps others - easy to use and very helpful.

It works as a kind of shortcut navigation to prev next siblings - like Kongondo showed off in his video to the notorious V.P.S.

I saw the raw links and thought hey i've a version of this running with UI buttons so here we go:

$out ='';
$siblings = $page->siblings;
//generate next & prev links output
if (count($siblings)) {
	$prev = $siblings->getPrev($page);
	if ($prev) {	
		$out .= '<a href="'.$prev->editUrl.'">';
		$out .= '<button type="button" name="button" class="ui-button ui-widget ui-corner-all ui-state-default">';
		$out .= '<span class="ui-button-text"><i class="fa fa-angle-double-left"></i> '.$prev->title.'</span></button>';
		$out .= '</a>';
	}
	$next = $siblings->getNext($page);
	if ($next) {
		$out .= '<a href="'.$next->editUrl.'">';
		$out .= '<button type="button" name="button" class="ui-button ui-widget ui-corner-all ui-state-default">';
		$out .= '<span class="ui-button-text">'.$next->title.' <i class="fa fa-angle-double-right"></i></span></button>';
		$out .= '</a>';
	}
if ($out <> "") $out = "<div class='NextPrevLinks'>".$out."</div>";
return "<div class='NextPrevLinks'>".$out."</div>";
}

Output of the field is:

post-2327-0-97972400-1443878534_thumb.jp

Have fun and best regards mr-fan

  • Like 4

Share this post


Link to post
Share on other sites

is it possible to use the value of this field for field dependency selectors? that would be really great but i didn't get it to work...

i created a field "testruntime"

post-2137-0-26897500-1445185352_thumb.pn

i set visibility for field "headline2"

post-2137-0-19718400-1445185351_thumb.pn

but the field does not show up...

post-2137-0-31086500-1445185353_thumb.pn

post-2137-0-84136000-1445185431_thumb.pn

any help for this? thanks for the great module - it was on my wishlist https://processwire.com/talk/topic/10555-using-pw-variables-in-descriptions-and-notes/   :)   ;)

edit: i was on the wrong track with this one... field dependencies work on the client side with JS and won't take care of the field value when the field is hidden

Share this post


Link to post
Share on other sites

Kongondo - just wanted to send a big thanks for this - just used it for the first time as a way to provide a preview of content from a hidden page tree and a modal edit link to edit that content - really very handy!

  • Like 1

Share this post


Link to post
Share on other sites

<silliness>I've been meaning to do a video demo of a list of silly thinks/pranks you can do with RunTimeMarkup...you know, a countdown to lunch break, a thing that shouts "peekaboo" every time you type a certain letter on your keyboard, a (not-so-silly) live spell-checker, etc....But then again, I have been meaning a lot of things... ;) </silliness>

  • Like 4

Share this post


Link to post
Share on other sites

That would surely convert many users from other CMSes - so please don't go that cinematic :)

  • Like 1

Share this post


Link to post
Share on other sites

Hi there?

is this possible?

if ($page->url=='/search/') {
  $title = $input->get['keyword']." ";
}
return $title;

I cannot return the value of $input->get['keyword'] even though it exist in the url?

Share this post


Link to post
Share on other sites

I'm not sure if you can access these items with the array notation, try $input->get('keyword') or $input->get->keyword.

Edit: And just as I thought, only $pages and $page are available as local variables. All the other api variables need to be accessed as $this->input or wire('input').

  • Like 2

Share this post


Link to post
Share on other sites

I'm not sure if you can access these items with the array notation, try $input->get('keyword') or $input->get->keyword.

Also did not work on url variables... i tried this but can't get to work...

Here's my url output

thefilipinodoctor/search/?keyword=Supranueron

Share this post


Link to post
Share on other sites

Also did not work on url variables... i tried this but can't get to work...

Speedy people here. Read my edited post above.

Share this post


Link to post
Share on other sites

@naldrocks98, 

Yes, @LostKobrakai is right about variable scope; RM only knows $page and $pages :-). So, this with your 'array notation', works:

$title = '';

if ($page->url=='/search/') {
  $title = $this->wire('input')->get['keyword'] ." ";
}
return $title;

If you had debug turned on, you could have seen the errors and fixed it :-). You also need to instantiate $title, otherwise, you will get an error for pages that don't match.

Edit

Btw, just curious, how are you using this?

Edited by kongondo

Share this post


Link to post
Share on other sites

Greatly useful module guys, thanks!

Just used it to provide a list of collected emails for simple copy/paste into send field

return $page->children->implode(', ', 'email');

Couldn't get any simpler than this!

PS: of course it would be great to have ACE on the code field like i Hanna Code ;)

  • Like 3

Share this post


Link to post
Share on other sites

PS: of course it would be great to have ACE on the code field like i Hanna Code ;)

The module could just check if Inputfield Ace Extended is installed and use it if so. That would prevent the big filesize like it's the case for hanna code and leave the code editor optional.

  • Like 3

Share this post


Link to post
Share on other sites

@kongondo - wondering if there might be an issue with renaming fields using this fieldtype;

i tried renaming an existing field but got a sql error;

Share this post


Link to post
Share on other sites

@Macrura,
 
Thanks for catching this. You will notice the same error if you tried to rename a FieldtypeConcat field. The error occurs because these Fieldtypes do not create a database table, i.e. there is no field_my_runtime_field table. MySQL throws the error since it can't find such a table on file, i.e. there is no field_my_runtime_field.frm file (every MySQL table is represented on disk by a .frm file that describes the table's format). It throws the error in Fields.php, in the __save() method, here. Although the method is hookable, I'll have a talk with Ryan to see what's the best way to handle this.

Edit: Forgot to provide a temporary solution:

As we know, the names of fields themselves are stored in the 'fields' table. As we wait to resolve this, we can always change a fields name there. Not ideal, I know, but we will get to the bottom of this.

Edit 2: Issue fixed in this commit in ProcessWire 2.7.2 (dev)

Edited by kongondo
  • 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 Macrura
      Field Descriptions Extended
      This module enables you to extend field descriptions by dividing short descriptions with a longer text that is revealed in a toggle.
      Modules Directory: http://modules.processwire.com/modules/field-descriptions-extended/
      Github: https://github.com/outflux3/FieldDescriptionsExtended
      Extending your field descriptions using the standard field's description field.
      Once this module is installed, it will automatically search your description field for the presence of 5 dashes (-----).
      Any content above the 5 dashes will be visible and the content below the dashes will be hidden. A 'More...' link will appear at the end of the short description which when clicked will reveal the rest of the description.
      Using Simple Markdown Editor with the description field
      If you have Simple Markdown Editor (InputfieldSimpleMDE) installed, you can enable the field description to have that editor.
      *When using Simple MDE, you can use the button (Insert Horizontal Line) instead of typing 5 dashes. More about SimpleMDE.
      Extending your field descriptions using content from a ProcessWire Page for the field description.
      You may use the content from a ProcessWire page as a field description. This would allow you to easily insert images, links, and use hanna codes.
      To use page content for your field descriptions, please follow these instructions:
      Install Select Fields module (FieldtypeFields) http://modules.processwire.com/modules/fieldtype-fields/ Create a new field using this field type, e.g. field_select. Add the field to any template you will be using for your field descriptions. Setup your help pages (for example under a settings branch) where you will store the field description content,using the template containing the Field Select. Add content to a page and select the field where that content should show. To show a short text before the link to the longer content, separate them with 5 dashes Be sure to update your settings on this page, first enable page content descriptions,then specify the name of the Select Fields field, template to search, and content field. If you create a field description using this method, please note that the description field must be blank for contexts where you want the page content to appear.
      You can freely use template context for field descriptions, but the Page Content method is not context sensitive and will display under all contexts where the description is blank.
      ----
      original post:
      This is a new module, hope to release soon, which allows extended field descriptions, in currently 2 ways.
      The main feature of the module is that you can have a short description and then a 'more...' link which drops down a longer block of text.
      This is achieved by separating the intro/visible text and the rest with 5 dashes.

      Example setup:

      the 2nd way is if you are using AdminThemeUiKit, you can show extended field instructions in a panel. The content of the panel is edited on a regular PW page. This use case would probably not be that common, but if you had a field that required some extended instructions for how to use, this could be useful; Also, since this allows you to target information and instructions down at the field level, it could reduce the amount of documentation needed on a global level, since it is a lot more context targeted.

    • 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. If the option to include uneditable pages is selected then those pages are indicated by a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 sibling pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. 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 joshuag
      Hey guys, 
      Thought I would share a quick preview of Designme. A module we (Eduardo @elabx and I) are building for visually laying out your templates/edit screens. 🙂
      This is a really quick, zero polish screen grab. FYI. 
      Video #2 - UPDATE
      This new video shows the following features in Designme:
      Re-arranging fields via Drag & Drop Re-sizing fields via Dragging. Adjusting field settings - with live refresh. Working on "hidden" fields while Designme is active. Creating New fields. Deleting fields. Creating/Deleting Tabs. Dragging fields between tabs. Creating fieldsets. Tagging/Un-tagging fields. Fields without headers expand when hovered (like checkboxes). Live filtering of fields in the sidebar. Ability to adjust (all) Template settings without leaving Designme. Template File Tree Editing Template files source code with ACE Editor. Editing Multiple files with ACE Editor. (New Tabs) Saving files. Techie stuff Fields load their own js/css dependancies. *ready to use on creation (*most fields)  Everything happens via Ajax to ProcessPageEdit (via module + hooks). Designme has a JS api that you can use.  All actions trigger events.  We would love any detailed feedback on what you see so far. If you are interested in testing Designme. Let me know below. 🙂
       
       
      Video #1. 
       
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By tpr
      ProcessNetteTester
      Run Nette Tester tests within ProcessWire admin.
      (continued from here)

      Features
      AJAX interface for running Nette Tester tests, in bulk or manually display counter, error message and execution time in a table run all tests at once or launch single tests show formatted test error messages and report PHP syntax errors stop on first failed test (optional) hide passed tests (optional) display failed/total instead passed/total (optional) re-run failed tests only (optional) auto scroll (optional) include or exclude tests based on query parameters start/stop all tests with the spacebar reset one test or all tests (ctrl+click) https://modules.processwire.com/modules/process-nette-tester/
      https://github.com/rolandtoth/ProcessNetteTester