Jump to content
marco

Template Twig Replace

Recommended Posts

Hi folks,

as announced yesterday, I just published my new Template Twig Replace module on github.

The module lets you write Twig templates directly, making calls like $page->twig('my_template.twig') in an otherwise empty php template unnecessary.

It also seamlessly integrates with my other module Template Data Providers that can be found here and here.

Be sure to consult the README.md for further information.

Please leave your comments, opinions, and suggestions here in this forum or at github and I'll try to answer as quick as possible.

Honorable mentions go to porl and his Template Twig module for inspiring this little piece of code.

Regards,

Marco

  • Like 4

Share this post


Link to post
Share on other sites

Hi,

I just released the new minor version 1.0.4 of the TemplateTwigReplace module.

The module now lets you access the Twig_Environment instance used for rendereing pages and chunks via a public getter. So now you may customize the twig environment (e.g. by adding custom filters) to better meet your needs.

Please take a look at the modified readme.

Regards,

Marco

  • Like 1

Share this post


Link to post
Share on other sites

Just updated the Twig library that is shipped with the module to the current release v1.15.0.

  • Like 1

Share this post


Link to post
Share on other sites

Marco, do you have any pointers on how best to use Twig as a tool within the normal PW templating system? I want to have some of my PW template files prepare data, specify a path to a Twig template file and then invoke Twig to insert the data and return the result. I don't want Twig to be the default way of rendering pages.

Thanks.

Edit: I guess my question is really whether your module can be used in that way or should I just make something much more basic.

Answer!  :) 

I answered my own question. Porl's TemplateTwig module turned out to be perfect for what I'm doing. I just made one small change to point it to a newer version of Twig than the one distributed with the module.

This is part of a larger MVC-ish scheme, part of which is just like Apesia's Template Delegate approach using PW's TemplateFile class. In templates/markup/layouts/ I have the TemplateFile PHP file ('whatever.php') which, depending on what needs to be done, can prepare variables and echo them out directly or pass them in an array to Twig which will look for a similarly named file ('whatever.php.twig') of twig markup. Just to make things easier, the system behind all this passes that 'twig' filename to the TemplateFile class file so all it has to do is prepare an array of data and then: echo $page->twig->render($this->twig, $arr);
 

  • Like 1

Share this post


Link to post
Share on other sites

Sorry, dumb/newbie question,

I can't find how to use this module, should I rename all the templates to .twig and put the logic (selectors, expressions) between <?php ?> tags?

Thanks in advance

Share this post


Link to post
Share on other sites

FYI, Twig syntax has support for conditional expressions, loops, etc. Look for clues in the TemplateTwig README.md file which also mentions using the Template Data Providers module to prepare data for the template.

Share this post


Link to post
Share on other sites

Hey SteveB, Hey Manaus,

as Marco can't answer currently I'll try to answer your questions as far as I can.

@SteveB the answer is: No. As you've mentioned you can't just use PHP in Template Twig Replace. It is designed to replace the whole rendering Process and expects the input to be twig compatible. You could use Twig filters to achieve PHP execution though.

The way we (Marco works at the same company I do) use Twig Replace & Data Providers is somewhat similar to the delegate approach. We use some basic "wrapper" Templates and extend them (using blocks) with template based code.

Here is an example we actually use in a blog page from an actual project:

Base Template (_base_template.twig in /templates) which is extended later on (every %block acts as a placeholder which can be filled with stuff from templates or chunks):

<!DOCTYPE html>
<!--[if lt IE 9 ]><html class="no-js lt-ie9" lang="de"><![endif]-->
<!--[if IE 9 ]><html class="no-js ie9" lang="de"><![endif]-->
<!--[if !(IE)]><!--><html class="no-js modern" lang="de"><!--<![endif]-->
<html lang="de" xmlns:fb="http://ogp.me/ns/fb#">
    <head>
        {% include 'includes/htmlhead.twig' %}
        {% block htmlhead %} {% endblock htmlhead %}
    </head>
    <body>
        <div class="wrapper">
            {% include 'includes/header.twig' %}
            {% block stage %}{% endblock stage %}
            <main class="main">
                {% block mainContent %}{% endblock mainContent %}
            </main>
            {% include 'includes/footer.twig' %}
        </div>
        {% include 'includes/javascript.twig' %}
        {% block beforebody %} {% endblock beforebody %}
    </body>
</html>

Blog Page (blog.twig in /templates) which displays an overview of the last articles:

{% extends '_base-template.twig' %}

{% block stage %}
    <div class="stage row">
        <img class="stage__background" src="{{ config.urls.root }}dummy-data/stage_default.jpg">
        <div class="stage__inner large-12 large-offset-2 columns">
            <h1 class="stage__headline stage__headline--default headline">xxx</h1>
        </div>
    </div>
{% endblock %}

{%  block mainContent %}
    <main class="article row" role="main">
        <div class="large-offset-2 large-10 columns">

            {% for article in articles %}
                {{ page.renderChunk('includes/blogpost_preview.twig',article,'blog') }}
            {% endfor %}

            {{ page.renderChunk('includes/pager.twig',articles) }}

        </div>
        {% include 'includes/sidebar.twig' %}
        

    </main>



{% endblock mainContent%}

The Coressponding "DataProvider"/Controller (BlogPage.php in /templates/dataproviders):

<?php

/**
 * Class definition of BlogPage
 *
 * @version 1.0.2
 * @copyright Copyright (c) 2013, neuwaerts GmbH
 * @filesource
 */

/**
 * Class BlogPage
 */
class BlogPage extends \nw\DataProviders\PageDataProvider {

    public function populate() {

        // load articles
        $today = date('Y-m-d');
        $this->articles = wire('pages')->find('template=blog_article, blog_articledate<=' . $today . ', sort=-date, limit=5');
        $pages = wire('pages');
        $this->categories = $pages->get('/blog/kategorien/')->children();
		$this->authors = $pages->get('/blog/autoren/')->children();
    }
}

And (just to make it complete and show some more twig stuff) here is the chunk for displaying the blog post previews that is included in the template. The chunk gets the article as a param and has it's own controller where you can place logic (i.e. to find related articles), too. 

<article class="article__preview clearfix">
	<div class="article__content">
		<header class="article__header clearfix">
			<h2 class="article__headline"><a href="{{article.url}}">{{ article.headline ?: article.title }}</a></h2>
			<div class="article__meta">
				{% for author in article.blog_author %}
					{% if loop.length > 1 %}
					<span class="meta__author"><img class="article__avatar" src="{{ author.blog_authorimage.size(20,20).url }}" alt="{{ author }}">{{ author.title }}</span>,
					{% endif %}
					{% if loop.last %}
						<span class="meta__author"><img class="article__avatar" src="{{ author.blog_authorimage.size(20,20).url }}" alt="{{ author }}">{{ author.title }}</span>
					{% endif %}
				{% endfor %}
					 | <time datetime="{{ article.blog_articledate|date('Y-d-m', config.timezone) }} ">{{ article.blog_articledate|date('d. F Y', config.timezone) }}</time>
			</div>
		</header>
		{% if includeTemplate == 'blog' %}
				{% if article.blog_keyvisualsize == 'small' %}
					{% set size = 280 %}
				{% else  %}
					{% set size = 755 %}
				{% endif %}
				{% if article.blog_articlekeyvisual %}<img src="{{article.blog_articlekeyvisual.width(size).url}}" alt="{{article.blog_articlekeyvisual.description}}" class="article__keyvisual {{article.blog_keyvisualsize}}">{% endif %}
				<div class="article__text">
					{% if article.body|length > 350 %}
						{{ article.body[:350] }}...
					{% else %}
							{{ article.body }}
					{% endif %}
				</div>
		{% endif %}
		<div class="article__category">
			{% for category in article.blog_category %}
				{% if loop.length > 1 %}
				{{ category.title }}, 
				{% endif %}
				{% if loop.last %}
						<a class="category__link" href="{{ config.urls.root }}blog/kategorien/{{category.name}}">{{ category.title }}</a>
				{% endif %}
			{% endfor %}
			<div class="article__read-more right">
				<a class="read-more" href="{{article.url}}">Artikel lesen</a>
			</div>
		</div>
	</div>
</article>

So we're basically splitting everything in includes (DRY), template specific stuff and Controllers. That's the way we believe is the "cleanest" and best maintainable. If you'd like to output some default stuff (i.e. headline and body) you're free to add it to the base template and just overwrite the block that they are in on demand.

@Manaus: You don't HAVE to rename everything into .twig - but you CAN. If you like to do this you'll have to set this explicitly in site/config.php: $config->templateExtension = 'twig';

Enclosing everything in a <?php is not required (in fact it will output this as plaintext: <?php).

  • Like 1

Share this post


Link to post
Share on other sites

I'm sure this is a great module, I haven't tested it but thanks for your work.

I have two concerns with the module's approach though:

1.

The Twig templating engine should be stand alone/a seperate module, which is not autoloaded. The TemplateTwigReplace module then should load the Engine and work with it, this way other modules can use the Twig Engine by loading the stand alone module as well without running into any issues.

2. warning: extensive use of the word "logic" =)

I think the whole purpose of Twig is to sperate presentation from logic, so it should only be used for simple logic. Replacing the whole template system with Twig makes it necessary to write all logic (e.g. selecting data, merging data et al) in Twig templates which make them almost equally ugly as php templates with much logic in them.

I think a better way would be to use regular php templates as controllers, have them do some heavy logic lifting and then pass data to Twig views which should only be concerned with outputting/formatting strings and iterate through loops and so on.

PS: oh, and thanks, I was having problems with passed PW data to Twig so I looked at your code and discovered Page::$issetHas = true;. I then found out that Ryan implemented that feature after @porl had the same problems while coding his Twig module, so thanks to Ryan too =)

  • Like 1

Share this post


Link to post
Share on other sites

Hey owzim,

thanks for your input.

1.) I'm not sure about if it's a good idea to not include twig with the plugin. As pw is not using any dependency/package manager like composer there would always be the need of updating the twig pw-module when twig itself is updated.

2.) The Plugin was actually developed as an addition to "TemplateDataproviders" which adresses exactly the issues you've mentioned. Look at the source code from my last post: All the "heavy lifting " is done within the controllers.

Share this post


Link to post
Share on other sites

1.) I'm not sure about if it's a good idea to not include twig with the plugin. As pw is not using any dependency/package manager like composer there would always be the need of updating the twig pw-module when twig itself is updated.

Good point, have not thought of that. There should be an extra flag for the module info to specifiy the versions of the required modules. That would imply that modules should be provided in different versions, handled by ModulesManger perhaps. I think I might open an extra thread for that in the feature requests forum. Still, don't you see issues when another module uses Twig too? The only way to avoid issues would be to namespace the Twig classes. but thats extra work after each Twig update, right?

2.) The Plugin was actually developed as an addition to "TemplateDataproviders" which adresses exactly the issues you've mentioned. Look at the source code from my last post: All the "heavy lifting " is done within the controllers.

I saw that a couple of minutes after my post and wanted to edit it today, you beat me to it. I'll look into that, looks promising.

Share this post


Link to post
Share on other sites

I am wondering, if the prependTemplateFile is supported here?

I try to play around with this module over the weekend but no luck. It seems that it does not recognize the prependTemplateFile.

Share this post


Link to post
Share on other sites

Hi peterfoeng,

twig has another concept of extending templates with predefined code. It's called "extend" and is documented here.

Share this post


Link to post
Share on other sites

Awesome module, much thanks for that. One question though, how would one accomplish the following in twig?

(I’m trying to exclude the current page from it’s array of siblings)

Vanilla PHP:

foreach($page->siblings('id!='.$page->id){

This is my twig code:

{%  for sibling in page.siblings('id!=page.id') %}

I understand that page.id will not be rendered as the page it’s id, since it’s a string etc. But what is the proper way to accomplish this? I’d need to do some string concatenation within the selector there. I know I can create a dataprovider to provide a proper wirearray with actual siblings, but it seems a bit overkill.

Thanks in advance!

Share this post


Link to post
Share on other sites

Ok, this works:

{%  for sibling in page.siblings('id!=' ~ page.id) %}

Share this post


Link to post
Share on other sites

Hi peterfoeng,

twig has another concept of extending templates with predefined code. It's called "extend" and is documented here.

For markup generation I do use extends. But in another case I needed more logic which does not generate markup and therefore I wanted to use  

$config->prependTemplateFile

and this does not work.

I want to redirect the user depending on his browser language setting "Accept-Language".

I didn't want to create an own module (beforeHook) containing only a few lines of code which have to differ from project to project.

I added some code in the module to make that work. Maybe this is not the best way to solve this issue. 

Any hints would be appreciated :)

Share this post


Link to post
Share on other sites

Hi Bea, 

thanks a lot. I did see that the rendering didn't support the 2.5 attach/prepend settings but didn't have the time to implement it.

I've merged your pull-request (and restored the indention to tabs ;)!!!). Furthermore I've added a new config setting that lets you exclude templates from beeing rendered with twig. This is needed if you're using FormBuilder (and i can think of some more use cases).

Share this post


Link to post
Share on other sites

tzz tabs   ;)

I really like the new config option, I build my own contact form because I could not implement Form Template Processor.  Could not get to run the following code using twig:

$form = $modules->get('FormTemplateProcessor'); 
$form->template = $templates->get('my_contact_form_template'); // required
$form->requiredFields = array('fullname', 'email');
$form->email = 'your@email.com'; // optional, sends form as email
$form->parent = $page; // optional, saves form as page
echo $form->render(); // draw form or process submitted form

Share this post


Link to post
Share on other sites
*shameless plug*
We're using TemplateDataProviders for exactly this kind of jobs (preparing data before it's rendered). Maybe you should try it out, too.
In your case I'd use output buffer and store it inside a variable to output it using twig later on.
 
dataproviders/ContactPage.php
<?php

class ContactPage extends \nw\DataProviders\PageDataProvider {

	public function populate() {
		$modules = wire('modules');
		$templates = wire('templates');

		$form = $modules->get('FormTemplateProcessor'); 
		$form->template = $templates->get('my_contact_form_template'); // required
		$form->requiredFields = array('fullname', 'email');
		$form->email = 'your@email.com'; // optional, sends form as email
		$form->parent = $page; // optional, saves form as page

		ob_start();
		echo $form->render(); // draw form or process submitted form
		$this->formMarkup = ob_get_contents();
		ob_end_clean();
	}

}

contact.twig

{{ formMarkup }}
 
 
Alternately you could add the Form Object to the templates namespace and render it directly using the method call within twig:
 
dataproviders/ContactPage.php
class ContactPage extends \nw\DataProviders\PageDataProvider {

	public function populate() {
		$modules = wire('modules');
		$templates = wire('templates');

		$form = $modules->get('FormTemplateProcessor'); 
		$form->template = $templates->get('my_contact_form_template'); // required
		$form->requiredFields = array('fullname', 'email');
		$form->email = 'your@email.com'; // optional, sends form as email
		$form->parent = $page; // optional, saves form as page

		$this->contactForm = $form;
	}

}
contact.twig
{{ contactForm.render() }}

Share this post


Link to post
Share on other sites

thanks, I will try this  ;)

Tried to update to version 1.0.7 and got the following error:

Notice: Undefined index: ignoredTemplates in /../site/modules/TemplateTwigReplace/TemplateTwigReplace.module on line 194

The problem is that I could not submit the settings and there is no entry for the new config optionignoredTemplates atm. The second error message occurs because the entry admin is not saved as well so I got the following message (it tries to render the admin template using twig):

paths->adminTemplates . 'controller.php');

I added a simple if-condition and everything works as expected.

Share this post


Link to post
Share on other sites

Why not write this:

ob_start();
echo $form->render(); // draw form or process submitted form
$this->formMarkup = ob_get_contents();
ob_end_clean();

Like this:

$this->formMarkup = $form->render();

?

Why generate output, create an output buffer, to then assign the buffer to a variable, if you can assign the form output directly to the var?

Share this post


Link to post
Share on other sites
 

Why not write this:

ob_start();
echo $form->render(); // draw form or process submitted form
$this->formMarkup = ob_get_contents();
ob_end_clean();

Like this:

$this->formMarkup = $form->render();

?

Why generate output, create an output buffer, to then assign the buffer to a variable, if you can assign the form output directly to the var?

 

Yeah - you're right. That's why I've added the second option.


thanks, I will try this  ;)

Tried to update to version 1.0.7 and got the following error:

Notice: Undefined index: ignoredTemplates in /../site/modules/TemplateTwigReplace/TemplateTwigReplace.module on line 194

The problem is that I could not submit the settings and there is no entry for the new config optionignoredTemplates atm. The second error message occurs because the entry admin is not saved as well so I got the following message (it tries to render the admin template using twig):

paths->adminTemplates . 'controller.php');

I added a simple if-condition and everything works as expected.

I'll look into this issue asap. It was working in my test setup. I must have missed something. 

Share this post


Link to post
Share on other sites

I've just pushed a bugfix to github. The $ignoredTemplates variable wasn't populated when updating the module.

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      First a note about my other modules...
      I have three existing modules that are similar in that they allow restrictions to be placed on repeating inputfields: Limit Repeater, Limit PageTable, Limit Table
      Restrict Repeater Matrix takes a different approach to the module configuration from those other modules. The module settings for Restrict Repeater Matrix are applied in the field settings rather in a module config screen. I think this new approach is better, but it means that it isn't practical to create different settings for different roles via the admin interface. Instead the module has a hookable method, allowing roles to be targeted and other advanced usages to be achieved via a hook. The result is that the module is more flexible.
      I intend to transition my other modules to the same approach over the coming weeks, but because this will result in breaking changes I will be releasing the updated modules under new names ("Restrict Repeater", etc) to avoid users upgrading via the Upgrades module without full awareness of the changes. The old modules will be marked as deprecated.
      Restrict Repeater Matrix
      A module for ProcessWire CMS/CMF. Allows restrictions and limits to be placed on Repeater Matrix fields. Requires ProcessWire >= v3.0.0 and FieldtypeRepeaterMatrix >= v0.0.5.
      For any matrix type in a Repeater Matrix field you have the option to:
      Disable settings for items (cannot change matrix type) Prevent drag-sorting of items Prevent cloning of items Prevent toggling of the published state of items Prevent trashing of items Limit the number of items that may be added to the inputfield. When the limit is reached the "Add new" button for the matrix type will be removed and the matrix type will not be available for selection in the "Type" dropdown of other matrix items. Please note that restrictions and limits are applied with CSS/JS so should not be considered tamper-proof.
      Usage
      Install the Restrict Repeater Matrix module.
      For each matrix type created in the Repeater Matrix field settings, a "Restrictions" fieldset is added at the bottom of the matrix type settings:

      For newly added matrix types, the settings must be saved first in order for the Restrictions fieldset to appear. Set restrictions for each matrix type as needed. A limit of zero means that no items of that matrix type may be added to the inputfield.
      Setting restrictions via a hook
      Besides setting restrictions in the field settings, you can also apply or modify restrictions by hookingRestrictRepeaterMatrix::checkRestrictions. This allows for more focused restrictions, for example, applying restrictions depending on the template of the page being edited or depending on the role of the user.
      The checkRestrictions() method receives the following arguments:
      $field This Repeater Matrix field $inputfield This Repeater Matrix inputfield $matrix_types An array of matrix types for this field. Each key is the matrix type name and the value is the matrix type integer. $page The page that is open in ProcessPageEdit The method returns a multi-dimensional array of matrix types and restrictions for each of those types. An example of a returned array:

      Example hooks
      Prevent the matrix type "images_block" from being added to "my_matrix_field" in a page with the "basic-page" template:
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $page = $event->arguments('page'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && $page->template->name === 'basic-page') { $type_restrictions['images_block']['limit'] = 0; } $event->return = $type_restrictions; }); Prevent non-superusers from trashing any Repeater Matrix items in "my_matrix_field":
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && !$this->user->isSuperuser()) { foreach($type_restrictions as $key => $value) { $type_restrictions[$key]['notrash'] = true; } } $event->return = $type_restrictions; }); http://modules.processwire.com/modules/restrict-repeater-matrix/
      https://github.com/Toutouwai/RestrictRepeaterMatrix
    • By BitPoet
      Here's a little text formatter module that redirects all external links found in a textarea (e.g. for hit counting) to a given URL.
      TextformatterExternalRedirect
      GitHub repo
      As TextFormatters do, this module modifies the contents of the textarea (HTML) at rendering time. It prepends the given URL to the link address for external links (http and https), optionally makes sure that the link is opened in a new window and allows you to add css classes to such links.
      All options can be configured in the module's configuration settings.
      Usage:
      Download the zip archive and extract it to site/modules, the rename the top folder to TextformatterExternalRedirect Go to the backend and select "Modules" -> "Refresh", then click "Install" for "External Link Redirect" Click "Settings" and configure the module
      Go into the field configuration for the field(s) you want this formatter to apply to and add it from the dropdown
      Done, now any external links in the configured fields will have the configured settings applied Feel free to leave feedback and post and questions you have here.
       
    • By teppo
      Hey folks!
      Took a couple of late nights, but managed to turn this old gist of mine into a proper module. The name is SearchEngine, and currently it provides support for indexing page contents (into a hidden textarea field created automatically), and also includes a helper feature ("Finder") for querying said contents. No fancy features like stemming here yet, but something along those lines might be added later if it seems useful (and if I find a decent implementation to integrate).
      Though the API and selector engine make it really easy to create site search pages, I pretty much always end up duplicating the same features from site to site. Also – since it takes a bit of extra time – it's tempting to skip over some accessibility related things, and leave features like text highlighting out. Overall I think it makes sense to bundle all that into a module, which can then be reused over and over again 🙂
      Note: markup generation is not yet built into the module, which is why the examples below use PageArray::render() method to produce a simple list of results. This will be added later on, as a part of the same module or a separate Markup module. There's also no fancy JS API or anything like that (yet).
      This is an early release, so be kind – I got the find feature working last night (or perhaps this morning), and some final tweaks and updates were made just an hour ago 😅
      GitHub repository: https://github.com/teppokoivula/SearchEngine Modules directory: https://modules.processwire.com/modules/search-engine/ Demo: https://wireframe-framework.com/search/ Usage
      Install SearchEngine module. Note: the module will automatically create an index field install time, so be sure to define a custom field (via site config) before installation if you don't want it to be called "search_index". You can change the field name later as well, but you'll have to update the "index_field" option in site config or module settings (in Admin) after renaming it.
      Add the site search index field to templates you want to make searchable. Use selectors to query values in site search index. Note: you can use any operator for your selectors, you will likely find the '=' and '%=' operators most useful here. You can read more about selector operators from ProcessWire's documentation.
      Options
      By default the module will create a search index field called 'search_index' and store values from Page fields title, headline, summary, and body to said index field when a page is saved. You can modify this behaviour (field name and/or indexed page fields) either via the Module config screen in the PocessWire Admin, or by defining $config->SearchEngine array in your site config file or other applicable location:
      $config->SearchEngine = [ 'index_field' => 'search_index', 'indexed_fields' => [ 'title', 'headline', 'summary', 'body', ], 'prefixes' => [ 'link' => 'link:', ], 'find_args' => [ 'limit' => 25, 'sort' => 'sort', 'operator' => '%=', 'query_param' => null, 'selector_extra' => '', ], ]; You can access the search index field just like any other ProcessWire field with selectors:
      if ($q = $sanitizer->selectorValue($input->get->q)) { $results = $pages->find('search_index%=' . $query_string . ', limit=25'); echo $results->render(); echo $results->renderPager(); } Alternatively you can delegate the find operation to the SearchEngine module as well:
      $query = $modules->get('SearchEngine')->find($input->get->q); echo $query->resultsString; // alias for $query->results->render() echo $query->pager; // alias for $query->results->renderPager() Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 Note: later versions of the module may require Composer, or alternatively some additional features may require installing via Composer. This is still under consideration – so far there's nothing here that would really depend on it, but advanced features like stemming most likely would.
      Installing
      It's the usual thing: download or clone the SearchEngine directory into your /site/modules/ directory and install via Admin. Alternatively you can install SearchEngine with Composer by executing composer require teppokoivula/search-engine in your site directory.
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if someone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put I've been using MSN (...) for years, and it's been great – but there are some issues with it, particularly in the markup generation area, and it also does some things in a way that doesn't quite work for me – the xtemplates thing being one of these. In some ways less about features, and more about style, I guess 🙂
      Anyhow, in MarkupMenu I've tried to correct those little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and with PHP 7.1+ in mind, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) still on my todo list.
      One more small(ish) difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site had a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to leave that out 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM – one of those three or four letter abbreviations anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework" since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
×
×
  • Create New...