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

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...