kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

Posted (edited)
On 4/21/2018 at 12:39 AM, adrian said:

Is there any reason they can't just return true, rather than returning $this->renderMarkup($page, $field); ?

Hi @adrian,

 ___wakeupValue is needed for frontend access. I am assuming some people use the field in the frontend.   ___sleepValue should be able to work with return true only. I'll have to investigate deeper though. The whole module is based on Ryan's concat field. These methods were copied as is (or almost) from that module. So, his module must be having the same issues then.

I'll have a look sometime. Still no ETA though, sorry.

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites

Taking a further look, I agree that wakeupValue is needed in case someone does use on the frontend, but I can't see a need for loadPageField() - so if it was limited to just wakeupValue then it would reduce processing of the code to just once.

  • Like 2

Share this post


Link to post
Share on other sites
Posted (edited)
On 3/16/2018 at 4:30 PM, adrian said:

I am noticing that the renderMarkup() method is called many times on the currently edited page and it's also called on page reference fields on the page being edited. This makes for a lot of calls to this method that don't seem necessary as far as I can tell. Do you think this can be improved?

As an example, I put: bd($page->id); at the top of that method and saw this:

@adrian,

I have tested and cannot replicate this. I tested with both single and multi page reference fields using different inputs (Asm, Checkboxes, etc). I also tested using render via code and via wire('files')->render('some-file'). This is what I get if I put bd($page->id) at the top of renderMarkup().

rm-dump-tracy.png.1513da23878639171af413146d9e11b2.png

1367 is the ID of the page being edited. The pages saved in the page reference fields are not called.

Edit

I think there is something else going on in your install. There is nothing peculiar about the field. Apart from renderMarkup(), all the other methods are ProcessWire Field methods. Theoretically, it means if a bug exists, then all Fields should be exhibiting the same behaviour.

 

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites
Posted (edited)
11 hours ago, adrian said:

but I can't see a need for loadPageField() - so if it was limited to just wakeupValue then it would reduce processing of the code to just once.

loadPageField() is required to stop the field from visiting the database. There is a comment right there in the method :).

Quote

// generate value at runtime rather than loading from DB

If we remove the method, it will just call its parent loadPageField() (Fieldtype.php). Hence, we override it. We can have it return true. That results in renderMarkup() being called once only (rather than twice currently - once each for wakeupValue() and loadPageField()).

Edited by kongondo

Share this post


Link to post
Share on other sites

I've tried to change the title of the page and it works

$page->set('title', 'New title');
$page->save();
return "";

but when I try to change an inputfield of type text it doesn't

$page->my_field = '22223333';
// $page->my_field->attr('value', '22223333'); neither works
$page->save();
return "";

any advice, thanks.

Share this post


Link to post
Share on other sites

Using Runtimemarkup I've tried to change the title of the page and it works

$page->set('title', 'New title');
$page->save();
return "";

but when I try to change an inputfield of type text it doesn't

$page->my_field = '22223333';
// $page->my_field->attr('value', '22223333'); neither works
$page->save();
return "";

any advice, thanks.

Share this post


Link to post
Share on other sites

Thanks flydev, is not the case, but give this module a try  it opens up a new world.

Share this post


Link to post
Share on other sites

I just tested and it work well. And yes, look a cool module 🙂

 

settingruntimetest.thumb.png.35e15754e89db4db033a1ac2ef18b30f.png

 

runtimetest.thumb.png.375d408a8729b69eb13ed05ee96fd714.png

 

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

I created a new field and you're right it works, I'll check it thoroughly, many thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Is any way to get the value of a field (Runtimemarkup) from a template :

$out .= strtoupper(dechex(strtotime(date("Y-m-d H:i:s", $page->created))));
return $out;

 

I'm getting the following error:

Field 'code_codigo' is runtime and not queryable

Share this post


Link to post
Share on other sites

Looking at the code, it seem not :

public function getMatchQuery($query, $table, $subfield, $operator, $value) {
		// we don't allow this field to be queried
		throw new WireException("Field '{$query->field->name}' is runtime and not queryable");
}

 

  • Like 1

Share this post


Link to post
Share on other sites
Posted (edited)

@Manol,

It seems your question has been answered?

Moderator Note

Please don't start different topics about the same issue. Also, use this module's support forum for all questions related to it. I have merged your other topic here.

 

Edited by kongondo

Share this post


Link to post
Share on other sites
Posted (edited)
1 hour ago, Manol said:

Is any way to get the value of a field (Runtimemarkup) from a template :

Yes you can get the value. See the examples in the first page, first post of this topic. However, you cannot use a selector to query the value.

1 hour ago, flydev said:

Looking at the code, it seem not :

Yes, you cannot use a selector to query it, but you can access the value.

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites
On 7/23/2017 at 3:04 PM, kongondo said:

For frontend, only pasted PHP code option is supported. My take is that this module is primarily used for the backend. Use of the render files option is geared for creating complex and/or more flexible backend apps as opposed to frontend usage. I have no intention of changing this behaviour.

Would be nice if it is consistent – I use this Field for both, backend and frontend and would love to have the code inside php files.

Share this post


Link to post
Share on other sites
1 hour ago, Noel Boss said:

Would be nice if it is consistent – I use this Field for both, backend and frontend and would love to have the code inside php files.

@Noel Boss see the dev version

Share this post


Link to post
Share on other sites
On 6/4/2018 at 6:21 PM, Macrura said:

the dev version

This is the description for the dev version. Did not work for me. Ended up with the master and:

namespace Processwire;
return wireRenderFile('fields/'.$field->name, ['page' => $page]);

 

Share this post


Link to post
Share on other sites
51 minutes ago, Noel Boss said:

This is the description for the dev version. Did not work for me. Ended up with the master and:


namespace Processwire;
return wireRenderFile('fields/'.$field->name, ['page' => $page]);

 

whatever version i'm using works great and has the option to use files and not pasted code, in the field config.. i thought it was the dev branch.. very stable and i have it running on 5 projects now, basically this is a completely indispensable module, i usually end up with on average 10-15 RM fields on any given project..

  • Like 1

Share this post


Link to post
Share on other sites
On 6/6/2018 at 5:06 PM, Macrura said:

basically this is a completely indispensable module

True, it's a great module. But does it work for you in the frontend with files? Because as @kongondo said here:

 

Quote

For frontend, only pasted PHP code option is supported.

 

  • Like 1

Share this post


Link to post
Share on other sites
Posted (edited)
6 hours ago, Noel Boss said:

This is the description for the dev version. Did not work for me. Ended up with the master and:


namespace Processwire;
return wireRenderFile('fields/'.$field->name, ['page' => $page]);

 

Works fine for me here with the dev version, but should also work with the master version (IIRC - sorry, it's been a while since I touched this). Tested in PW 3.0.85. Here's my copy pasted PHP code:

// both of these work
/*namespace Processwire;
return wireRenderFile('runtime-markup-wirerender-test');
*/
return ProcessWire\wireRenderFile('runtime-markup-wirerender-test');

The above allows you to have your code inside PHP files. This is the pasted PHP option. It is supported in both front- and back-end. It also allows you to use PHP files, but indirectly. It is not to be confused by the other (currently dev) option of directly rendering PHP files (i.e., just stating name of the PHP file and its path.

Are you getting any errors? Tracy?

In the template file I echo the field's value like so:

 

echo $page->runtime_markup;

 

Edited by kongondo

Share this post


Link to post
Share on other sites

Hi @kongondo 

No, this works just fine. But this is "pasted PHP code" – since you introduced the option to specify files on the dev Version, it would be nice to use this option also in the frontend;

Current status:

Dev Version:

– include files using module: Backend √ + Frontend X
– Past Code: Backend √ + Frontend √

Master Version:

– Include files using module: Backend X + Frontend X
– Past Code: Backend √ + Frontend √

Desired status 😉

Master Version:

– include files using module: Backend √ + Frontend √
– Past Code: Backend √ + Frontend √

Share this post


Link to post
Share on other sites
1 hour ago, Noel Boss said:

No, this works just fine. But this is "pasted PHP code" – since you introduced the option to specify files on the dev Version, it would be nice to use this option also in the frontend;

OK. I'll have a look. Could you please file it as a request on GitHub? It will help remind me, thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Thank you Kogondo! BTW, this is one of the most useful Modules out there! Thank you for developing it!

  • Like 1

Share this post


Link to post
Share on other sites

Thank you for developing this useful module, now i can send email to certain user from admin easily, inspired from here :

For those who need more explanation:
Button is actually <a href> to template which will open new page (yes very ugly behaviour, read below) contain custom php code , not inside <form> action because <form> not allowed inside textarea.

To prevent opening new page when click the button, make an <iframe> inside the template as a target button, that's it, beautifully execution like native form in admin page.
 

  • 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   1 member

  • Similar Content

    • 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
    • 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/RockGrid
      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
       
      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.
       
      Changelog
      180711 bugfix (naming issue) 180630 alpha realease  
      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 tpr
      Update 2018-07-09: ProcessNetteTester module is available in the Modules Directory and on GitHub.

      This is a short tutorial on how to use Nette Tester with ProcessWire.
      As you will see it's very easy to setup and use and it's perfect for testing your code's functionality. With bootstrapping ProcessWire it's also possible to check the rendered markup of pages using the API, checking page properties, etc. It's also a great tool for module developers for writing better code. 
      While there will be nothing extraordinary here that you couldn't find in Tester's docs this can serve as a good starting point.
      Prerequisites: PHP 5.6+
      01 Download Tester
      Go to https://github.com/nette/tester/releases and download the latest release (currently 2.0.2). Download from the link reading "Source code (zip)". You can use composer also if you wish.
      02 Extract Tester files
      Create a new directory in your site root called "tester". Extract the zip downloaded here, so it should look like this:
      /site /tester/src /tester/tools /tester/appveyor.yml /tester/composer.json /tester/contributing.md /tester/license.md /tester/readme.md /wire ... 03 Create directory for test files
      Add a new directory in "/tester" called "tests". Tester recognizes "*.Test.php" and "*.phpt" files in the tests directory, recursively. 
      04 Create your first test
      In the "tests" directory create a new "MyTest.php" file.
      The first test is a very simple one that bootstraps ProcessWire and checks if the Home page name is "Home". This is not the smartest test but will show you the basics.
      Add this to "/tester/tests/MyTest.php":
      <?php namespace ProcessWire; use \Tester\Assert; use \Tester\DomQuery; use \Tester\TestCase; use \Tester\Environment; require __DIR__ . '/../src/bootstrap.php'; // load Tester require __DIR__ . '/../../index.php'; // bootstrap ProcessWire Environment::setup(); class MyTest extends TestCase {     // first test (step 04)     public function testHomeTitle()     {         $expected = 'Home'; // we expect the page title to be "Home"         $actual = wire('pages')->get(1)->title; // check what's the actual title Assert::equal($expected, $actual); // check whether they are equal     }     // second test will go here (step 06)     // third test will go here (step 07) } // run testing methods (new MyTest())->run(); I've added comment placeholders for the second and third tests that we will insert later.
      05 Run Tester
      Tester can be run either from the command line or from the browser. The command line output is more verbose and colored while in the browser it's plain text only (see later).
      Running from the command line
      Navigate to the "/tester" directory in your console and execute this:
      php src/tester.php -C tests This will start "/tester/src/tester.php" and runs test files from the "/tester/tests" directory. The "-C" switch tells Tester to use the system-wide php ini file, that is required here because when bootstrapping ProcessWire you may run into errors (no php.ini file is used by default). You may load another ini file with the "-c <path>" (check the docs).
      If the title of your Home page is "Home" you should see this:

      If it's for example "Cats and Dogs", you should see this:

      Running from the browser
      First we need to create a new PHP file in ProcessWire's root, let's call it "testrunner.php". This is because ProcessWire doesn't allow to run PHP files from its "site" directory.
      The following code runs two test classes and produces a legible output. IRL you should probably iterate through directories to get test files (eg. with glob()), and of course it's better not allow tests go out to production.
      <?php ini_set('html_errors', false); header('Content-type: text/plain'); echo 'Starting tests.' . PHP_EOL; echo '--------------------------' . PHP_EOL; $file = __DIR__ . '/PATH_TO/FirstTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; $file = __DIR__ . '/PATH_TO/SecondTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; echo '--------------------------' . PHP_EOL; echo 'Tests finished.'; exit; Navigate to "DOMAIN/testrunner.php" in your browser to execute the file. If every test succeeds you should get this:

      If there are failed tests the execution stops and you can read the error message. If there were more tests (eg. ThirdTest), those won't be displayed under the failed test.

      06 DOM test
      This test will check if a page with "basic-page" template has a "h1" element. We will create the page on the fly with ProcessWire's API. To keep things simple we will add the new test as a new method to our MyTest class.
      Add this block to the MyTest class:
      public function testBasicPageHeadline() {     $p = new Page();     $p->template = 'basic-page';     $html = $p->render();     $dom = DomQuery::fromHtml($html);     Assert::true($dom->has('h1')); } This will most likely be true but of course you can check for something more specific, for example "div#main". Note that we have used the DomQuery helper here (check the "use" statement on the top of the file).
      07 Custom function test
      You will probably want to make sure your custom functions/methods will work as they should so let's write a test that demonstrates this.
      I don't want to complicate things so I'll check if the built-in "pageName" sanitizer works as expected. Add this to the myTest class:
      public function testPageNameSanitizer() {     $expected = 'hello-world';     $actual = wire('sanitizer')->pageName('Hello world!', true);     Assert::equal($expected, $actual); } This should also be true. Try to change the expected value if you are eager to see a failure message.
       
      08 Next steps
      You can add more methods to the MyTest class or create new files in the "tests" directory. Check out the range of available Assertions and other features in the docs and see how they could help you writing more fail-safe code.
      Once you make a habit of writing tests you'll see how it can assist making your code more bulletproof and stable. Remember: test early, test often 🙂
      If you find out something useful or cool with Tester make sure to share.