Jump to content
Jonathan Dart

Module: Spex: An asset and template management module

Recommended Posts

Hi Guys,

I'd like to share a module the development team at metric marketing and I came up with. I have a lot of experience with the Symfony framework, and when working with PW I came to miss some of the practices I grew accustomed to when working with PW. This module is aimed at bridging my previous experience with doing things to PW way.

I have a big readme on the github project so be sure to check that out to get all the details: https://github.com/jdart/Spex

From the readme "The project makes use of lessphp, less.js, jQuery, modernizr, Minify and the ProcessWire Minify Module."

There's an example site in the github repo that illustrates how Spex works:

https://github.com/jdart/Spex/tree/master/example-site

In short your template file isn't responsible for including the head and foot etc... and instead is injected into a layout. In addition to this is adds some conventions for adding css/less/js to the page so that it can be combined and minified.

Have a look through it and let me know if you have any feedback.

  • Like 8

Share this post


Link to post
Share on other sites

Looks cool Jonathan! I look forward to taking a closer look soon. In reading the notes, I noticed what you said of head.inc/foot.inc and just wanted to mention that most of us don't actually use that method. It's just what it is in the default profile purely because it's the simplest for newbies to understand (and most similar to the WordPress approach). So the use of head.inc/foot.inc is really more about making things easy to understand and a gentle introduction, but it's probably not the way to go as your needs grow. 

I also noticed that you use _init.php – is this related to ProcessWire's _init.php using the $config->prependTemplateFile and $config->appendTemplateFile options, or is this something different? I also see in your API methods addStyles/addScripts -- do these use the $config->styles and $config->scripts or is this something different? Maybe I will find my answers when I get more time to explore the module. Thanks for your work and sharing this with us. 

  • Like 1

Share this post


Link to post
Share on other sites

That's fair enough regarding the head.inc etc...

I used the convention of a file named _init.php based on the way you use prependTemplateFile in your example site profiles, but spex just automatically calls is before the page render event.

addStyles/etc... are in fact using $config->styles internally. They're just there as a bit of syntactical sugar and to handle the compiling of .less files.

  • Like 1

Share this post


Link to post
Share on other sites

I've updated Spex to include support for "slots" and image preloading.

Check out the details below: 

https://github.com/jdart/Spex#slot--hasslot

https://github.com/jdart/Spex#addimage

I'd also like to add that there are equivalent procedural helpers available that don't require the $spex variable:

https://github.com/jdart/Spex#procedural-helpers

  • Like 2

Share this post


Link to post
Share on other sites

Jonathan, when ready, would you mind adding this to the modules directory? Not everyone sees the modules here in the forums and we want to make sure those interested are able to find it. 

Share this post


Link to post
Share on other sites

Hi Jonathan, it's really nice & fun to use Spex!
 
Now as I have played around with it when switching debug mode to false I run into an issue that breaks the minify process and end up with a page without styles.
 
In the modules method compileStyle a link to a stylesheet appended by a ?v=100 isn't recognized correctly. A vardump of the pathinfo outputs something like:

array(4) { 
    ["dirname"]   => string(34) "/site/modules/AdminTemplateColumns" 
    ["basename"]  => string(30) "AdminTemplateColumns.css?v=100" 
    ["extension"] => string(9) "css?v=100" 
    ["filename"]  => string(20) "AdminTemplateColumns" 
} 

The extension isn't recognized. As the $stylesheet is a URL at first and not a filesystem link I come up to pass it through parse_url() first and use that path. Also needed is to keep the extracted path and return it back if it isn't a less-file:

	$sheetInfo1 = parse_url($stylesheet);
	$sheetInfo2 = pathinfo($sheetInfo1['path']);

	if ($sheetInfo2['extension'] != 'less')
		return $sheetInfo1['path'];

This solved the issue with breaking the Minify.

Share this post


Link to post
Share on other sites

Hi Guys,

Based on some feedback I decided to favour the AIOM+ module over the Minify module, which means I no longer need the less compiler in Spex, I also removed all other 3rd party libraries to make it less opinionated. Starting with v0.8.0 the Spex module no longer bundles less.js, less.php, modernizr and jquery. Spex is actually a lot less code now which is fine by me.

Check out the base template now: https://github.com/jdart/Spex/blob/master/example-site/layouts/_base.php

vs before:

https://github.com/jdart/Spex/blob/0dd56629232d68be4f6248555caf47f6972dad87/example-site/layouts/_base.php

  • Like 3

Share this post


Link to post
Share on other sites

I have one question that becomes a problem for me. I have pages with children as something like content blocks. One should render a image, another a text and so on. When i loop through the children and render it, then i became the whole page... Maybe i overlooked something but is there a way to render only the template file without the _base.php markup?

Share this post


Link to post
Share on other sites

How do you do the loop? Some code would be useful, also which template (file/s?) do they use and which one(s) uses the parent (where the loop happens)?

Share this post


Link to post
Share on other sites

I have set up the _base.php file with the markup for header and footer. Then i have a default layout file with only one line:

echo $spex->slot('content')

Now i have a page, lets say a feature page of an application. As childrens of these page i have pages with feature 1, feature 2 and so on. Feature 1 should render a headline, feature 2 an image and maybe feature 3 a table.

In the parent page i loop over the childrens:

foreach ($page->children() as $c) {
  echo $c->render();
}

The result is, that i became the whole page markup with header and footer with each call of the render method. This is probably the expected result. But maybe there a way to render only the content of the template file without the html from the _base.php file.

Share this post


Link to post
Share on other sites

EDIT:

now I'm on desktop.

You can simply set a temporary $config var to force the output of the $layout_body without the content of the _base.php.

Simply define $config->onlybodycontent = true before starting the loop and in top of your _base.php check for it:

<?php
if($config->onlybodycontent) {
	echo $layout_body;
	return;
}
?>
<!DOCTYPE html>
<head>
   ...

This is same like you can use it with content loading via ajax into a page:

if($config->ajax || $config->onlybodycontent) {
Edited by horst

Share this post


Link to post
Share on other sites

Regarding the below, you can also $spex->setLayout(false) to disable the layout.

EDIT:

now I'm on desktop.

You can simply set a temporary $config var to force the output of the $layout_body without the content of the _base.php.

Simply define $config->onlybodycontent = true before starting the loop and in top of your _base.php check for it:

<?php
if($config->onlybodycontent) {
	echo $layout_body;
	return;
}
?>
<!DOCTYPE html>
<head>
   ...

This is same like you can use it with content loading via ajax into a page:

if($config->ajax || $config->onlybodycontent) {
  • Like 1

Share this post


Link to post
Share on other sites

This is tricky, maybe I should only enable the layout stuff if the page being rendered is the current $page and bail otherwise... I'll try some stuff out.

I have set up the _base.php file with the markup for header and footer. Then i have a default layout file with only one line:

echo $spex->slot('content')

Now i have a page, lets say a feature page of an application. As childrens of these page i have pages with feature 1, feature 2 and so on. Feature 1 should render a headline, feature 2 an image and maybe feature 3 a table.

In the parent page i loop over the childrens:

foreach ($page->children() as $c) {
  echo $c->render();
}

The result is, that i became the whole page markup with header and footer with each call of the render method. This is probably the expected result. But maybe there a way to render only the content of the template file without the html from the _base.php file.

Share this post


Link to post
Share on other sites

@geniestreiche 

I've updated the master branch of the github repo with a change that might solve the problem for you, let me know what you find.

This is tricky, maybe I should only enable the layout stuff if the page being rendered is the current $page and bail otherwise... I'll try some stuff out.

Share this post


Link to post
Share on other sites

This is tricky, maybe I should only enable the layout stuff if the page being rendered is the current $page and bail otherwise... I'll try some stuff out.

But then, is it possible to force rendering _with_ layout from a (let's say kind of) controller page?

Share this post


Link to post
Share on other sites

But then, is it possible to force rendering _with_ layout from a (let's say kind of) controller page?

Can you give me a bit more detail of an example when you'd want that?

Share this post


Link to post
Share on other sites

Thanks guys.

With Horsts suggestion and with $spex->setLayout(false) i became a blank site where only the child templates are rendered, no header, no footer in my case. With the update from Jonathan it seems we are on the right road again  :blink:. I have the _base markup and within the child templates. But now in the child templates the $page variable contains not the fields from the child template but from the parent page.

Share this post


Link to post
Share on other sites

Can you give me a bit more detail of an example when you'd want that?

For example if you have a hidden tree with children containing different downloadable content and one public page with url /download/ that get information which downloadable page is requested by session or some input. The current page is /download/ but I want to render and display another page. Does this make sense?

Share this post


Link to post
Share on other sites

Thanks guys.

With Horsts suggestion and with $spex->setLayout(false) i became a blank site where only the child templates are rendered, no header, no footer in my case. With the update from Jonathan it seems we are on the right road again  :blink:. I have the _base markup and within the child templates. But now in the child templates the $page variable contains not the fields from the child template but from the parent page.

I was overriding the $page variable naively, I've pushed a change that should address the issue. Let me know if it addresses your issue. 

Share this post


Link to post
Share on other sites

For example if you have a hidden tree with children containing different downloadable content and one public page with url /download/ that get information which downloadable page is requested by session or some input. The current page is /download/ but I want to render and display another page. Does this make sense?

Hi Horst,

I added a function to the Spex class that hopefully solves that use case: renderPage

So in the template for the page at the url "/download/" you might do something like... 

echo $spex->renderPage($the_real_page);

That changes the page that Spex treats as the request page, i.e. it's as if the request was for $the_real_page rather than wire('page').

It's a bit ugly but seems to be a edge case, so maybe it's ok. What do you think?

  • Like 1

Share this post


Link to post
Share on other sites

I had a dream last night that Jonathan updated the module. When i woke up i realize that was not a dream  :grin: . It works now for me. Thanks for your work...

  • Like 1

Share this post


Link to post
Share on other sites

@Jonathan: looks good! Thanks.

  • 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 bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...