Jump to content
Wanze

Module: TemplateEngineFactory

Recommended Posts

Nevermind.  Rookie mistake.  I just needed to check if the post.template == "calendar-posting" before trying to access post.event_description.

Share this post


Link to post
Share on other sites
Quote

Exception: An exception has been thrown during the rendering of a template ("Method Page::event_description does not exist or is not callable in this context") in "search.twig" at line 50. (in /Users/glenn/websites/mysite/wwwroot/site/assets/cache/FileCompiler/site/modules/TemplateEngineTwig/TemplateEngineTwig.module line 110)

@gmclelland

Twig sometimes has problems when you try to access a property via magic getter. I consistently use $page->get('my_field') to avoid this issue. So in your example, you could use {{ post.get('event_description') }}.

Share this post


Link to post
Share on other sites

Thanks @Wanze, I haven't ran into any issues so far, but that's good to know.  The only thing I'm currently stuck on right now is trying to figure out how to get the TwigExtensions module to work with the latest versions of TemplateEngineTwig.  It was working previously before TemplateEngineTwig 1.1.0.  Any help testing is appreciated.

Are you using TwigExtensions library at all in your projects?  If not, don't you need the date functions and text truncating functions?

After I get my sites upgraded to the latest version of TemplateEngineFactory and TemplateEngineTwig, I can start checking into a possible bug I think I see with the new changes to handle Wire404Exception.

Side note:  I really appreciate the work you've done on this module.  To me it is so much cleaner looking at Twig code than looking at a php mixed with html.   I like that in Processwire, I can simply build up my variables in the template to be sent to the view.  That way my views(Twig files) are very simple and contain simple logic only.

 

Share this post


Link to post
Share on other sites

Hi @Sipho

Sorry I missed your post. I don't know/use markup regions myself, so it's hard for me to help. Does your code work if you disable the TemplateEngineFactory module? If it works, then somehow markup regions are not respected when your ProcessWire templates are getting rendered by this module. I try to look into this at the end of this week.

Cheers

  • Like 1

Share this post


Link to post
Share on other sites

@Wanze It does work when I disable TemplateEngineFactory (and move my home.php file back into templates/).

I don't really know how ProcessWire renders templates under the hood but it could be that it only renders markup regions of files under templates/.

I would greatly appreciate it if you could take a look at it. You can take a look at this tutorial to get started using markup regions.

Share this post


Link to post
Share on other sites

Hi @Wanze

I don't know if it's possible in the current state of the module to disable "Global File Template" for a given template file.

I needed this feature in order to work with a REST API endpoint. The problem is when I try to get JSON data from http://my.sites.sek/api, the markup of the global template file is sent.

 

I forked your module and added an option to ignore the global template file on given template. If it make sense, I can send a pull request.

 

gft.png.0cee3346e719a4379fd2ff9d5db5f4e6.png

 

 

tef.thumb.gif.c676ea77fbb91688138eae7a995315af.gif

 

 

Edited by flydev
screencast

Share this post


Link to post
Share on other sites

Hi @Sipho

MarkupRegions is currently only processed during Page::render(). TemplateEngineProcessWire uses TemplateFile::render() to return the markup, where MarkupRegions are not recognized/populated.

Here are the relevant lines: https://github.com/processwire/processwire/blob/master/wire/modules/PageRender.module#L521-L526

It should be possible to integrate this logic into TemplateFile::render via hooks. Unfortunately I do not have much time for ProcessWire these days 😕
I'm happy to accept a pull request though :)

Cheers

Share this post


Link to post
Share on other sites

Hello @Wanse and all of you,

This plugin is a must, thank you Wanse.

For 2 days I have been searching, I guess I have a pattern problem with my twig templates.

  1. My global template is base.twig
  2. Inside I have {% block home %}{% endblock %} and several includes parts.
  3. Nothing from this block is displayed. It works only if I keep my global template file field empty.
  4. In my home.twig I have
{% extends 'base.twig' %}
{% block home %}
<div id="corps"> <div id="titres">
<div id="titre">{{ page.title }}</div>
</div>
 <div class="hr"></div>
<br>
{% block engagement %}{% endblock %}
{% endblock %}

What do you think ?

In my base.twix I have all my html code...

Thank you

Share this post


Link to post
Share on other sites

Hello @Sten So what exactly is the problem? Don't you get any output? What happens? What is you path to templates in the config of the module? I have /templates/views and with my twig files in this directory everything works fine. Did you choose twig as the template files suffix?
Your code and extend seem to be correct.
The global template file field has to be empty so you can work with extends like you do

  • Like 1

Share this post


Link to post
Share on other sites

@Sten

Your twig templates look fine, the problem is the global template file setting. Just leave that config empty. This is a "global setting" of the TemplateEngineFactory which is supported by all engines, but actually makes no sense in Twig and generally in engines supporting template inheritance. It was introduced by a feature request, but now I think it's more confusing than useful.

Cheers

Share this post


Link to post
Share on other sites

Hello Jmartsch and Wanze,

It is great to be assisted, thank you 😊. I changed my config to have the global file field empty. So I put all my *.twig files in the views directory. I created partials directory for parts included in base.twig.
So I keep home.twig and engagement.twig in views.

in home.twig I have
 

{% block home %}
<div id="corps"> <div id="titres">
<div id="titre">{{ page.title }}</div>
</div>
 <div class="hr"></div>
<br>
{% block engagement %}{% endblock %}
{% endblock %}

In engagement.twig, I have
 

{% extends 'home.twig' %}
{% block engagement %}
<p>His cognitis Gallus ut serpens adpetitus telo vel saxo iamque spes extremas opperiens et succurrens saluti suae quavis ratione colligi omnes iussit armatos et cum starent attoniti, districta dentium acie stridens adeste inquit viri fortes mihi periclitanti vobiscum.</p>
<p>Mensarum enim voragines et varias voluptatum inlecebras, ne longius progrediar, praetermitto illuc transiturus quod quidam per ampla spatia urbis subversasque silices sine periculi metu properantes equos velut publicos signatis quod dicitur calceis agitant, familiarium agmina tamquam praedatorios globos post terga trahentes ne Sannione quidem, ut ait comicus, domi relicto. quos imitatae matronae complures opertis capitibus et basternis per latera civitatis cuncta discurrunt.</p>
{% endblock %}

But still engagement block is not displayed.

 

Share this post


Link to post
Share on other sites

@Sten In home.twig, the block engagement block is nested inside the home block. In engagement.twig, this is not the case. Does it work if you either move it out of the home block in your parent template; or recreate the nested block structure in engagement.twig.

  • Like 1

Share this post


Link to post
Share on other sites

Yes Thank you Wanse. Yes it works. Well I will use this way.

 

Share this post


Link to post
Share on other sites

Hello,

I'm trying out TemplateEnginePug, and I get a blank page. I have a empty home.php and a views/home.pug. This one has a very basic paragraph. Still I get a blank page, without any error. Same with TemplateEngineJade. Can't manage to see a byte on screen no matter what.

Tested other template languages (twig, processwire, latte), and it works fine. Config debug is `true`.

Thanks!

Share this post


Link to post
Share on other sites

Hey @Manaus 

I updated the Pug Engine to work with the latest version, it should work now again, please try!

Share this post


Link to post
Share on other sites

Hi folks!

I just released a new major (2.x) version of the module. Important things first: This version includes backwards compatibility breaks. At the moment, only Twig and the bundled ProcessWire engine work with the 2.0 version. I will now contact maintainers that implemented other engines (Pug, Jade etc.) and ask them to release a 2.x version as well. The 1.x version of the module is still available on the 1.x branch and continues to exist.

So why a version 2.x? Basically it's the same concept, but done in the right way. 😉

  • The rendering via template engine is now integrated correctly into Page::render(). You can call the render() method on any page, and the module will render it via template engine. In version 1.x, this is only true for the current page.
  • Automatic page rendering is now optional, you can use the module to only integrate a template engine, without hooking into Page::render at all.
  • There are settings to enable/disable the automatic page rendering for templates. Because there might be templates where Page::render should not be replaced.
  • The module provides hooks to customize it for your needs.
  • I wrote a bunch of unit tests and use Travis for CI. Problems like "the 404 page is not displayed if a Wire404Exception is thrown in a controller" are now tested properly.

I am writing a documentation on everything, you can read it here: https://github.com/wanze/TemplateEngineFactory/blob/master/DOCUMENTATION.md

One important part is how to update from 1.x to 2.x. Depending on the feature usage of the module, this might involve some manual update steps, because the public API changed. If you try to update, please let me know about any issues you are encountering, so that we can add them to the documentation. Don't worry, you do not have to update, as the 1.x version continues to exist. For a new project, definitely start with 2.x!

Last but not least, modules providing template engines must be updated too, but this should be quite easy. For Twig, I decided to support installations only via Composer, and I think that this should be the way to go for the other modules. 3rd party dependencies must be manageable in a reliable way, and Composer is the right tool for this job.

Cheers

  • Like 4
  • Thanks 1

Share this post


Link to post
Share on other sites
12 hours ago, tiefenbacher_bluetomato said:

Nice! will you upgrade TemplateEngineSmarty also soon?

Actually I wanted to ask you if you would like to develop the 2.x version of TemplateEngineSmarty, and if you like, maintain the project? The implementation itself is really easy, you can basically copy + past from Twig and tweak/change things for Smarty. I only use Twig these days, so I might miss some useful/important stuff for Smarty. What do you think? 😄

Share this post


Link to post
Share on other sites
22 hours ago, Wanze said:

Actually I wanted to ask you if you would like to develop the 2.x version of TemplateEngineSmarty, and if you like, maintain the project? The implementation itself is really easy, you can basically copy + past from Twig and tweak/change things for Smarty. I only use Twig these days, so I might miss some useful/important stuff for Smarty. What do you think? 😄

Sure we can do that 🙂 Do you want to transfer the repo to our account: https://github.com/blue-tomato ?

You can write me also via email for the details: markus.tiefenbacher {at} blue-tomato.com

Edited by tiefenbacher_bluetomato

Share this post


Link to post
Share on other sites

Can't use this module if select any parser (smarty or twig)
Fatal Error: Uncaught Error: Class 'Twig_Loader_Filesystem' not found

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...