Jump to content
David Karich

Module: AIOM+ (All In One Minify) for CSS, LESS, JS and HTML

Recommended Posts

Hi David, I'll try out that change you mentioned, and I appreciate the whitelist feature - thanks!

I'm trying to imagine a scenario where including a javascript/css/less file outside of the templates directory poses a security risk. How could that be exploited?

Hi Jonathan , 

yes, in this function paths are filtered to prevent directory traversal attacks. AIOM+ loads only allowed files that are located in the template folder. I think about it, in one of the upcoming versions, introduce a whitelist for asset folder.

For a workaround change the following line (749) in AllInOneMinify.module

$_path  = str_ireplace(array('../', './', '%2e%2e%2f', '..%2F'), '', (wire('config')->paths->templates.$_file));

to 

$_path  = wire('config')->paths->templates.$_file; 

I have not tested it and I can not recommend it too.

Share this post


Link to post
Share on other sites

Hi David, I'll try out that change you mentioned, and I appreciate the whitelist feature - thanks!

I'm trying to imagine a scenario where including a javascript/css/less file outside of the templates directory poses a security risk. How could that be exploited?

The easiest way is by infected third-party applications. Also on Bower or Composer, its possible, that compromised packages can be delivered. I have currently identified no scenario targeted at Process Wire, rather it is one of my personal programming rules. Just do not make it possible. Asset files belong in the template folder. This approach I have always in development, regardless of platform or environment. I have some clients who work with sensitive data, and the safety requirements are very high. Therefore, this is my natural data schizophrenia. :D

  • Like 3

Share this post


Link to post
Share on other sites

I have the new version of AIOM+ uploaded (3.1.2). From this version it is now possible to disable the directory traversal filter. Also, the LESS parser was updated. Now compatible with the official LESS version 1.7.

post-1973-0-14216100-1394147982_thumb.pn

  • Like 4

Share this post


Link to post
Share on other sites

Would it be possible to provide an alternate less compiler for those with node available on the server? 

I'm not really familiar with Node.js and I have no test environment. You're welcome to implement an alternative and send a pull request on GitHub. I think it requires only an option in the backend more and instead of PHP-based LESS parser an exec-command-line function call.

The question is rather, the detour via PHP is really faster? Because you can embed the LESS files directly into the template and can render there via LESS.js or over the Node.js package. The Node.js package has a minimization option on board.

  • Like 1

Share this post


Link to post
Share on other sites

I'm not really familiar with Node.js and I have no test environment. You're welcome to implement an alternative and send a pull request on GitHub. I think it requires only an option in the backend more and instead of PHP-based LESS parser an exec-command-line function call.

The question is rather, the detour via PHP is really faster? Because you can embed the LESS files directly into the template and can render there via LESS.js or over the Node.js package. The Node.js package has a minimization option on board.

Compiling all of bootstrap with the php implementation takes 3+ seconds which is an annoyance when developing themes, with the node.js implementation it's half a second. I agree that using less in the template being a great option. I think I'll set things up that way. Thanks David

Share this post


Link to post
Share on other sites
Hey guys, 

i have released a new version of AIOM+. The update to version 3.1.3 includes a few improvements in the LESS parser and CSS minification. Also, I have set the status from AIOM+ to stable.

  • Like 4

Share this post


Link to post
Share on other sites

Hi David,

Thanks again for a great module. Just wondering if you did any experimenting with other js minification libraries? I am no expert on this, but noticed that I can get significantly smaller files (in one case 400kb down to 300kb) by minifying using http://jscompress.com/ I know that runs on nodejs, but there are other php alternatives out there, although maybe none of them are any better.

Maybe you've already been through this process and decided JSMin is the best option, but just thought I'd ask :)

Share this post


Link to post
Share on other sites

Hi David,

Thanks again for a great module. Just wondering if you did any experimenting with other js minification libraries? I am no expert on this, but noticed that I can get significantly smaller files (in one case 400kb down to 300kb) by minifying using http://jscompress.com/ I know that runs on nodejs, but there are other php alternatives out there, although maybe none of them are any better.

Maybe you've already been through this process and decided JSMin is the best option, but just thought I'd ask :)

Hi adrian,

for sure. JSMin is a little bit outdated and generates not the best compression result, but it is the only stable php port without any conditions to third party libraries. Some other minifications libraries destroyed the compressed js code and JSMin is the only one, with which I never had such a problem. Anyway, i'm thinking about, to integret the google closure compiler as an alternative third party service.

Share this post


Link to post
Share on other sites

Thanks for the explanation. I am sure you've seen it, but this looks promising:

https://github.com/tedivm/JShrink

Anyway, thanks again for this module - it's a real time saver.

On an unrelated note - I did notice something yesterday when using the loadOn option. It worked fine for CSS, but it didn't seem to work properly with JS. Before you go delving too deep, I should do some more testing and see what I can find - might have been an issue at my end. I'll try again soon and let you know how it goes.

Share this post


Link to post
Share on other sites

Thanks for the explanation. I am sure you've seen it, but this looks promising:

https://github.com/tedivm/JShrink

Anyway, thanks again for this module - it's a real time saver.

On an unrelated note - I did notice something yesterday when using the loadOn option. It worked fine for CSS, but it didn't seem to work properly with JS. Before you go delving too deep, I should do some more testing and see what I can find - might have been an issue at my end. I'll try again soon and let you know how it goes.

Oh, no. This library has not yet come under my eyes. I'll be looking at this a bit more detail when I have more time again. Thanks for the tip.

Yes, check again and let me know, because it is the identical function that is called. If there should be a bug, CSS should not work as well. If you were able to find something, then just open a ticket on Github. :)

Share this post


Link to post
Share on other sites

Author of JShrink here (I found you guys in my web logs). I thought I'd pop in and say hello, and talk about JShrink a bit. 

I originally made it as a drop in replacement for JSMin, because JSMin is technically not open source (it has the "do no evil" license, so projects that take open source seriously, such as Debian, won't bundle projects with it). Since then I've made improvements on speed, added additional features like support for conditional comments and license preservation, and have really  put work into the test suite itself. Ryan Grove, who originally ported JSMin to PHP, has officially dropped the JSMin project and is referring people to JShrink on the Github page for it.

Yesterday, after several years of being in the "beta" phase, I launched the JShrink v1.0 to make the API official and stable. 

On a tangental note, I also maintain a caching library called Stash that may be useful to you.

  • Like 5

Share this post


Link to post
Share on other sites

AIOM minifies my CSS file without any problems, but for some reason I have not been able to minify any javascript files. 

While outputing javascript the old way works:

// _init.php
$jsPath = $config->urls->templates . 'styles/js/';

// _init.php
$page->jsFiles = array(
    'jquery.min.js',
    'bootstrap.min.js',
    'jquery.fancybox.pack.js',
    'jquery.isotope.min.js',
    'jquery.sticky.js',
    'retina.js',
    'scripts.js',
);

// _done.php
foreach ($page->jsFiles as $file) {
    $fullPath = $jsPath . $file;
    echo "<script src='{$fullPath}'></script>\n";

}

// Output
// <script src='/processwire/site/templates/styles/js/jquery.min.js'></script>
// <script src='/processwire/site/templates/styles/js/bootstrap.min.js'></script>
// <script src='/processwire/site/templates/styles/js/jquery.fancybox.pack.js'></script>
// <script src='/processwire/site/templates/styles/js/jquery.isotope.min.js'></script>
// <script src='/processwire/site/templates/styles/js/jquery.sticky.js'></script>
// <script src='/processwire/site/templates/styles/js/retina.js'></script>
// <script src='/processwire/site/templates/styles/js/scripts.js'></script>
 
Using AIOM as shown below always resulted in a file with the content of
/** Generated: Thursday, 8th of May 2014, 11:36:39 PM // Powered by AIOM+ (All In One Minify) by www.flipzoom.de **/:
 
// _done.php
$jsFiles = array();

foreach ($page->jsFiles as $js) {
  $fullPath  = $jsPath . $js;
  $jsFiles[] = $fullPath;
}

$minified = AIOM::JS($jsFiles);

echo "<script src='{$minified}'></script>";

// Output 
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>

I also tried to output each javascript file one by one using AIOM, but this did not work, either: 

  foreach ($page->jsFiles as $file) {
    $fullPath = $jsPath . $file;
    $minJS = AIOM::JS($fullPath);
    echo "<script src='{$minJS}'></script>\n";
  }

Output:
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>
// <script src='/processwire/site/assets/aiom/js_d41d8cd98f00b204e9800998ecf8427e_dev.js?no-cache=1399617391'></script>

Interestingly, each time the same file is output.

I installed AIOM version 3.1.3 with Processwire 2.4

 
I am probably missing the obvious, but I haven't been able to spot it. 
 
Cheers, 
 
Stefan

Share this post


Link to post
Share on other sites

EDIT: Ah, you have it in the first line:

// _init.php
$jsPath = $config->urls->templates . 'styles/js/';

try it with changed this to:

// _init.php
$jsPath = $config->paths->templates . 'styles/js/';

-------------

I don't know if it needs the fullpath or only a url, but you are definietly provide the url and not the fullpath:

$fullPath = $jsPath . $file;   // = /proseeswire/site/assets/...

I would do a quick try with:

$_SERVER['DOCUMENT_ROOT'] . $jsPath . $file;

If this succeeds, I would change the "$_SERVER['DOCUMENT_ROOT'] . $jsPath" to some PW $config-var (e.g. $config->paths ...)

Edited by horst

Share this post


Link to post
Share on other sites

@horst

Thanks for your reply. 

Unfortunately, replacing $config->urls with $config->paths lead to the same result and at the same time got me 'Page not found' errors for all script files added the normal way:

// _init.php
$jsPath = $config->urls->templates . 'styles/js/';

// _init.php
$page->jsFiles = array(
    'jquery.min.js',
    'bootstrap.min.js',
    'jquery.fancybox.pack.js',
    'jquery.isotope.min.js',
    'jquery.sticky.js',
    'retina.js',
    'scripts.js',
);

// _done.php
foreach ($page->jsFiles as $file) {
    $fullPath = $jsPath . $file;
    echo "<script src='{$fullPath}'></script>\n";
}

// Output:
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/jquery.min.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/bootstrap.min.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/jquery.fancybox.pack.js'>//

// </script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/jquery.isotope.min.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/jquery.sticky.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/retina.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/codeslider.js'></script>
// <script src='/home/sovonex/Programs/rubystack-2.0.0-12/apps/processwire/htdocs/site/templates/styles/js/scripts.js'></script>
 
I installed Processwire via the Bitnami stack, that's where the long path names are coming from. 
 
To be fair, I am not quite sure, when to use $config->paths and when to use $config->urls most of the time.
 
As for CSS and javascript files, I chose $config->urls, because I saw it done this way on the skyscraper installation:
 
Cheers, 
 
Stefan
 
 
 

Share this post


Link to post
Share on other sites

@Stefan: unfortunately I don't know the AIOM well. It was just a thought.

I would think one mostly need the $config->urls->something if one have to provide a link to the clients browser

and need the $config->paths->something mostly to tell a php-script / function where to grap the file(s) in filesystem for preprocessing something.

Share this post


Link to post
Share on other sites

The instructions for this module say to use the path relative to your templates directory, eg:

styles/mystyles.css or scripts/myscript.js

There is a setting in the module config:

"Allow Directory Traversal: Enable the directory traversal option to make it possible to add files from outside of the template folders. (../)"
 
which you can use if you need to access css and js files above the templates directory, but otherwise they should all be in subfolders of "templates" and linked to with a path relative to templates.
 
Make sense?
 
EDIT: not relevant to this module, but path vs url - depends on what is being done with the file being linked to. If it's a css or js file, typically you are going to want the url option. The path option is the full server path to the file which is useful for php operations on files, but no good for front-end display/calling of files. 
  • Like 4

Share this post


Link to post
Share on other sites

@adrian

Using the relative path from the template folder did the trick and so the following code is working:

 
// _init.php
// Relative path from the templates folder to the javascript folder
$relativeJSPath = 'styles/js/';

// _init.php
$page->jsFiles = array(
    'jquery.min.js',
    'bootstrap.min.js',
    'jquery.fancybox.pack.js',
    'jquery.isotope.min.js',
    'jquery.sticky.js',
    'retina.js',
    'scripts.js',
);

$jsFiles = array();
foreach ($page->jsFiles as $js) {
  $fullPath  = $relativeJSPath . $js;
  $jsFiles[] = $fullPath;
}

$minified = AIOM::JS($jsFiles);

echo "<script src='{$minified}'></script>";
 
However, now the code in scripts.js, where I initialize all plugins, does not work anymore. Only when I copy its content inside script tags below the javascript file produced by AIOM does it work again. This is regardless of whether the javascript files have been minified or just been merged into a single file (developer mode). 
 
Does anyone have any idea what might have happened here?
 
Cheers, 
 
Stefan

Share this post


Link to post
Share on other sites

However, now the code in scripts.js, where I initialize all plugins, does not work anymore. Only when I copy its content inside script tags below the javascript file produced by AIOM does it work again. This is regardless of whether the javascript files have been minified or just been merged into a single file (developer mode). 

 
Does anyone have any idea what might have happened here?
 
Cheers, 
 
Stefan

The generated code can be incorrect if your code is not written cleanly. A missing semicolon can already generate faulty code. Please inspect your script, for example, with jslint.com.

  • Like 1

Share this post


Link to post
Share on other sites

Hi David,

sorry for my late response. I missed the notification email and thought there was no new reply.

You suggestion was spot on! The problem was in fact a syntax error in my Javascript code. Once I fixed that, AIOM worked again.

Today I have one other question:

When using AIOM, the paths to background images, icons, etc. in my CSS files somehow get changed and cannot be found anymore.

Here is an example

CSS code

.some-class {
    background: url(images/sprite.png);
}

This path works

// _init.php
$cssPath = $config->urls->templates . 'styles/stylesheets/';

// _done.php
<link href="<?= $cssPath . 'main.css' ?>" rel="stylesheet">

Path: background: url(h

                                      ttp://localhost:8080/processwire/site/templates/styles/stylesheets/images/sprite.png.); 

This path does not work

<link href="<?= AIOM::CSS('styles/stylesheets/main.css') ?>" rel="stylesheet">

Path: background: url(re/htdocs/site/templates/styles/stylesheets/images/sprite.png);

Do you have any any idea what is happening here?

Cheers,

Stefan

Edited by bytesource

Share this post


Link to post
Share on other sites

Sorry, I copied the wrong code above, which probably made my question completely incomprehensible. 

I edited my previous comment and hope that now everything is correct. 

Share this post


Link to post
Share on other sites

I wanted to bring up this question again as I haven't found a solution yet.

Does anyone have any idea of why the paths inside a CSS file are not translated correctly?

Share this post


Link to post
Share on other sites

CSS code

.some-class {
    background: url(images/sprite.png);
}

This path works

// _init.php
$cssPath = $config->urls->templates . 'styles/stylesheets/';

// _done.php
<link href="<?= $cssPath . 'main.css' ?>" rel="stylesheet">

Path: background: url(http://localhost:8080/processwire/site/templates/styles/stylesheets/images/sprite.png.); 

How can the path be different here at once if you have only "images/sprite.png" in CSS? There is no URL rewriting or parsing with direct linked CSS.

I wanted to bring up this question again as I haven't found a solution yet.

Does anyone have any idea of why the paths inside a CSS file are not translated correctly?

Stefan, I'm sorry. I can not reproduce your problem. For me it works with your folder structure. 

Share this post


Link to post
Share on other sites
How can the path be different here at once if you have only "images/sprite.png" in CSS?

That is exactly what I don't understand, either. 

Maybe I should add that the file main.css is the result of using the SASS compass plugin stitching together several SASS (SCSS) files. But then again, without AIOM everything works fine, so I don't think using a CSS preprocessor is what causes the problem here. 

I guess I just have to keep looking...

Cheers, 

Stefan

Share this post


Link to post
Share on other sites

Hello, is there any way for AIOM to accept a FilenameArray object for minifying or do I need to convert the object to an array manually first?

  • Like 2

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 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-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 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 Multi currency support Custom order and cart fields 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 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 Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • 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 If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...