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 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...