Jump to content
tpr

MarkupSrcSet

Recommended Posts

This is a very beta version of the separate functions I use to generate srcset/bgset markups. There's some similar functions floating around in the forum but this one is a bit different because you can set "named image sets" which you can use easily site-wide.

It's definitely work-in-progress so use it at your own risk.

MarkupSrcSet

Generate srcset and bgset markup for lazysizes.

Features

  • generate srcset/bgset markup for lazysizes
  • set image sizes in JSON array
  • add required JavaScripts automatically (optional)
  • fallback to smallest image size if JavaScript is not available

Usage

Image sets JSON (in module settings):

{
    "hero": [
        [640, 210], [1080, null], [1920, null]
    ],
    "featured-image": [
        [360, 240], 1.333, 2.667
    ],
    "gallery-thumb": [
        [240, 120], [480, 300], [800, 576]
    ]
}

Image methods

$image->srcset():

<img <?php echo $page->featured_image->srcset('featured-image'); ?>>
$image->bgset():
<div <?php echo $page->images->first()->bgset('hero'); ?>>Lorem ipsum</div>

https://github.com/rolandtoth/MarkupSrcSet

  • Like 20

Share this post


Link to post
Share on other sites

There are some pending updates to this, plus I guess I can't help myself to create an image method for rendering the markup instead of the global functions (eg. $img->srcset()).

Share this post


Link to post
Share on other sites
$this->addHook("Pageimage::srcset", $this, "mySrcsetFunction"); 

The image is $event->object in the hook function. From this you could simply call your current global functions if you like.

  • Like 1

Share this post


Link to post
Share on other sites

In addition to LostKobrakai, the function schema looks like:

public function mySrcsetFunction($event) {
    $image = $event->object;
        
        $markup = "<img src='{$lqip}' data-src='{$image->url}' {$aspectratio} class='lazyload lazypreload' alt='{$image->description}' />";

    $event->return = $markup;
}
  • Like 1

Share this post


Link to post
Share on other sites

Hi!
This is probably a noob question (Iam a designer and frontend guy, just learned some basic php) :

I have several functions in a _function.php that I include in my templates.
How can I use this within a function in that file? I guess I have to redefine the variables, because they are not available there, but Iam not sure how to do this.

Here is an example (not working):

// album list function ----------------------
function albumList(){
 
	// Get the list of albums 
	$albums = wire("pages")->find("parent=/work/, template=project, limit=100, sort=sort");
 
	$out =" ";
 
	//Loop through the pages
	foreach($albums as $album){
		$out .="<a href='{$album->url}' class='item {$album->thumbnail->tags} {$album->thumbnail->orientation}'>";
		if($album->images){
			$out .="<img {$album->thumbnail->srcset('thumbnail', 'lazyload my-class inline-block', array('quality' => 80))} alt='{$album->thumbnail->Alt}'>";
		}
		$out .="<div class='item-info'><h3>{$album->title}</h3><h4>{$album->thumbnail->tags}</h4></div>";
		$out .="</a>";
 
	}


So how is the syntax for this?:

<img <?php echo $page->featured_image->srcset('featured-image', 'lazyload my-class inline-block', array('quality' => 80)); ?>>

Iam using PW 3.0.25
Thanks! this module looks very promising!

Share this post


Link to post
Share on other sites

What variables are you missing? The function seems OK to me. Do you have a return $out at the end? Or do you have an error when running this?

  • Like 1

Share this post


Link to post
Share on other sites

I forgot to copy the out, but its there. here is the complete code:

/ album list function ----------------------
function albumList(){
 
    // Get the list of albums 
    $albums = wire("pages")->find("parent=/work/, template=project, limit=100, sort=sort");
 
    $out =" ";
 
    //Loop through the pages
    foreach($albums as $album){
        $out .="<a href='{$album->url}' class='item {$album->thumbnail->tags} {$album->thumbnail->orientation}'>";
        if($album->images){
            $out .="<img {$album->thumbnail->srcset('thumbnail', 'lazyload my-class inline-block', array('quality' => 80))} alt='{$album->thumbnail->Alt}'>";
        }
        $out .="<div class='item-info'><h3>{$album->title}</h3><h4>{$album->thumbnail->tags}</h4></div>";
        $out .="</a>";
 
    }
 
    echo $out;
}

I get the error:

Error: Call to a member function srcset() on null (line 14 of /homepages/11/d86659974/htdocs/website_susannerudolf/site/templates/_func.php) 


Line 14 is this:
 

$out .="<img {$album->thumbnail->srcset('thumbnail', 'lazyload my-class inline-block', array('quality' => 80))}

 

Share this post


Link to post
Share on other sites

Iam using PW 3.0.25. Maybe thats the problem?

Share this post


Link to post
Share on other sites

No, your $album->thumbnail seems NOT to be an image object.  Is thumbnail a valid field? if so, if it's set to hold multiple images, try $album->thumbnail->first()->srcset...

Share this post


Link to post
Share on other sites

Plus you check for $album->images and then use $album->thumbnail, so one if them may be invalid. You may also check for $album->images->count() if there can be more than one image in the field (and the field name may be "thumbnail").

  • Like 1

Share this post


Link to post
Share on other sites

it holds multiple images. I tryed using first().

Now I get this:
Error: Exception: Method Pageimage::first does not exist or is not callable in this context (in /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/Wire.php line 409) #0 [internal function]: ProcessWire\Wire->___callUnknown('first', Array) #1 /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/Wire.php(347): call_user_func_array(Array, Array) #2 /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/WireHooks.php(548): ProcessWire\Wire->_callMethod('___callUnknown', Array) #3 /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/Wire.php(370): ProcessWire\WireHooks->runHooks(Object(ProcessWire\Pageimage), 'callUnknown', Array) #4 /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/Wire.php(371): ProcessWire\Wire->__call('callUnknown', Array) #5 /homepages/11/d86659974/htdocs/website_susannerudolf/wire/core/Wire.php(371): ProcessWire\Pageimage->callUnknown('first', Array) #6 /homepages/11/d86659974/htdocs/website_susannerudolf/site/temp This error message was shown because: you are logged in as a Superuser. Error has been logged.


sorry my bad, it was a long day, its just an image field with a single image. And it works when I use it without the module syntax like:

// album list function ----------------------
function albumList(){
 
    // Get the list of albums 
    $albums = wire("pages")->find("parent=/work/, template=project, limit=100, sort=sort");
 
    $out =" ";
 
    //Loop through the pages
    foreach($albums as $album){
        $out .="<a href='{$album->url}' class='item {$album->thumbnail->tags} {$album->thumbnail->orientation}'>";
        if($album->images){
            $out .="<img src='{$album->thumbnail->url}' alt='{$album->thumbnail->Alt}'>";
        }
        $out .="<div class='item-info'><h3>{$album->title}</h3><h4>{$album->thumbnail->tags}</h4></div>";
        $out .="</a>";
 
    }
 
    echo $out;
}

but still no luck using the module syntax :(
 

Share this post


Link to post
Share on other sites

Try this:

foreach($albums as $album){

		// if there's no thumbnail no need to do anything
		if(!$album->thumbnail) continue;

		// save srcset tag to a variable
		$srcset = $album->thumbnail->srcset('thumbnail', 'lazyload my-class inline-block', array('quality' => 80));

        $out .="<a href='{$album->url}' class='item {$album->thumbnail->tags} {$album->thumbnail->orientation}'>";
        if($album->images){
            $out .="<img $srcset alt='{$album->thumbnail->Alt}'>";
        }
        $out .="<div class='item-info'><h3>{$album->title}</h3><h4>{$album->thumbnail->tags}</h4></div>";
        $out .="</a>";
 
    }

It's written in browser so double check the syntax.

Edited by tpr
remove "src" from markup
  • Like 3

Share this post


Link to post
Share on other sites

Its still not working. No images or html gets rendered from this function (rest of the page looks fine).
There are no error messages (debug mode turned on), so I guess the syntax is fine.
I use the image extra module with this. Could this be a problem?Anyway thanks for your help! 

Here is the complete code:

// album list function ----------------------
function albumList(){
 
    // Get the list of albums 
    $albums = wire("pages")->find("parent=/work/, template=project, limit=100, sort=sort");
 
    $out =" ";
 
    //Loop through the pages
    foreach($albums as $album){

        // if there's no thumbnail no need to do anything
        if(!$album->thumbnail) continue;

        // save srcset tag to a variable
        $srcset = $album->thumbnail->srcset('thumbnail', 'lazyload my-class inline-block', array('quality' => 80));

        $out .="<a href='{$album->url}' class='item {$album->thumbnail->tags} {$album->thumbnail->orientation}'>";
        if($album->images){
            $out .="<img $srcset alt='{$album->thumbnail->Alt}'>";
        }
        $out .="<div class='item-info'><h3>{$album->title}</h3><h4>{$album->thumbnail->tags}</h4></div>";
        $out .="</a>";
 
    }
}

 

Share this post


Link to post
Share on other sites

Do you have "return $out;" at the end of the function? If not, is there any generated markup? Or is any js or 404 error in the debug console (browser Inspector)?

  • Like 3

Share this post


Link to post
Share on other sites

I forgot the "echo $out;" at the end.
Now I feel a little stupid. My only excuse is that its monday morning without coffee :)

Everything is working now!
Thank you for this module and your patience with my problems!!


 

  • Like 1

Share this post


Link to post
Share on other sites

Hi!

I have another problem with this.
When I test my images on different resolutions, there seems to be a problem with loading the correct resources.
The images that are created in the assets folder are fine, but most of the time just the biggest image gets loaded.
I testet this with resizing the browser, reloading the page and saving the image and looking at the size.

Here are my module settings in PW:
 "albumimage": [
          [360, null], [720, null], [1300, null], [1600, null]
    ]

This is the generated markup:

<img src="/website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.360x0.jpg" data-srcset="/website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.360x0.jpg 360w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.720x0.jpg 720w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.1300x0.jpg 990w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.1600x0.jpg 1300w" data-sizes="(max-width: 1600px) calc(100vw - 20px), 1600px" class="inline-block lazyloaded" alt="" sizes="(max-width: 1600px) calc(100vw - 20px), 1600px" srcset="/website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.360x0.jpg 360w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.720x0.jpg 720w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.1300x0.jpg 990w, /website_susannerudolf/site/assets/files/1184/logo_wirtschaftsclub-stuttgart.1600x0.jpg 1300w">

Thanks for your help!

Share this post


Link to post
Share on other sites

Well, the first srcset (360,null) shouldn't be null, but perhaps this isn't the problem. Lazysizes uses the largest image even if you resize the browser. So if the page loads in desktop size, and you downsize it to 400px wide, it won't load the smaller images. In my tests it works only upwards (from small to large size).

  • Like 2

Share this post


Link to post
Share on other sites

I don't know the exact sizes of the images thats why I just set the width.
But thanks for your explanation. I will test it on different devices and see if its working

Share this post


Link to post
Share on other sites

@tpr thanks for module, can you add support for width and height attribute support for <img> tag ? Width and height attribute values could come from src attribute.

// My custom hook for $image->alt() function
$this->addHook("Pageimage::alt", function (HookEvent $event) {
    $image = $event->object;
    $return = ($image->description != '') ? $image->description : pathinfo($image->filename, PATHINFO_FILENAME);
    $event->return = " alt='{$return}'";
});

// Json array
{
    "list": [
        [400, 300], [687, 515], [385, 290], [490, 370]
    ]
}

// my usage
<img <?php echo $image->srcset('list', 'lazyload'), $image->alt(); ?>>

// result
<img src="/site/assets/files/1072/peoplelikeus-antifouling-001.400x300.jpg" data-srcset="/site/assets/files/1072/peoplelikeus-antifouling-001.400x300.jpg 480w, /site/assets/files/1072/peoplelikeus-antifouling-001.687x515.jpg 768w, /site/assets/files/1072/peoplelikeus-antifouling-001.385x290.jpg 960w, /site/assets/files/1072/peoplelikeus-antifouling-001.490x370.jpg 1220w" data-sizes="(max-width: 1220px) calc(100vw - 20px), 1220px" class="lazyload" alt='peoplelikeus-antifouling-001'>

// for this result width and height attributes must be 400x300, because our src image size is 400 x 300
<img src="/site/assets/files/1072/peoplelikeus-antifouling-001.400x300.jpg" width="400" height="300" data-srcset="/site/assets/files/1072/peoplelikeus-antifouling-001.400x300.jpg 480w, /site/assets/files/1072/peoplelikeus-antifouling-001.687x515.jpg 768w, /site/assets/files/1072/peoplelikeus-antifouling-001.385x290.jpg 960w, /site/assets/files/1072/peoplelikeus-antifouling-001.490x370.jpg 1220w" data-sizes="(max-width: 1220px) calc(100vw - 20px), 1220px" class="lazyload" alt='peoplelikeus-antifouling-001'>

For the moment i edited you module line 180 (don't like custom adds)

$markup = 'src="' . $fallbackImgSrc . '" width="'.$fallbackImg->width.'" height="'.$fallbackImg->height.'" ' . $markup;

 

Share this post


Link to post
Share on other sites

I'm not against it, but setting the lowest width-height size will be inappropriate on larger sizes (eg. 687x515 on the next breakpoint in your example). Or do you think it's OK?

Share this post


Link to post
Share on other sites
On 27.08.2016 at 10:34 PM, tpr said:

I'm not against it, but setting the lowest width-height size will be inappropriate on larger sizes (eg. 687x515 on the next breakpoint in your example). Or do you think it's OK?

I tested it and its look bad idea, if you add width and height for img tag, responsive display not working well. I removed my changes.

and can you test this image tag in chrome browser & safari :

<img
                        src="http://placehold.it/400x300"
                        data-srcset="http://placehold.it/400x300 480w, http://placehold.it/667x515 768w, http://placehold.it/385x290 960w, http://placehold.it/490x370 1220w"
                        data-sizes="(max-width: 1220px) calc(100vw - 20px), 1220px"
                        class="lazyload uk-width-1-1">

This tag generated by your module just images replaced with placehold.it, this tag working only in firefox.

I am loading js files manuelly do i need to add extra javascript codes ?

<?php
    $lazySizes = array(
        'styles/bower_components/lazysizes/lazysizes.min.js',
        'styles/bower_components/picturefill/dist/picturefill.min.js',
        'styles/bower_components/lazysizes/plugins/attrchange/ls.attrchange.min.js',
        'styles/bower_components/lazysizes/plugins/bgset/ls.bgset.min.js'
    );
    echo "\n\t\t<script src=\"" . AIOM::JS($lazySizes) . "\"></script>";
    ?>

Picture tag working much better, i was has same problem when i frist try lazysizes js, if you check post

there is funtion i made for lazysizes with picture tag, i wll try to add picture mode also. 

This is working for me, for all browsers :

<picture>
                        <!--[if IE 9]><video style='display: none;'><![endif]-->
                        <source srcset='data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==' data-srcset='http://placehold.it/400x300' media='(max-width: 479px)' />
                        <source srcset='data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==' data-srcset='http://placehold.it/667x515' media='(max-width: 767px)' />
                        <source srcset='data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==' data-srcset='http://placehold.it/385x290' media='(max-width: 959px)' />
                        <!--[if IE 9]></video><![endif]-->
                        <img src='data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==' data-srcset='http://placehold.it/490x370' alt='' class="lazyload uk-width-1-1" />
                    </picture>

 

Edited by ukyo
Added new usages

Share this post


Link to post
Share on other sites

Is it possible to have different breakpoints for different image sets? Or some way to control the value for the sizes attribute?

For instance, for hero images that are going to be full width of the page I'll want different sizes than if I'm displaying a small author headshot which just needs a 2x or 3x version for HiDPI devices.

Share this post


Link to post
Share on other sites

Currently it's not possible. I could redesign the image sets like this:

{
    "featured": [
        [435,210], 2, 4
    ],
    "hero": [
        "720w 990w 1220w" => [
            [720,320], 2, 3
        ]
     ]
}

It's getting a bit complicated but if I'll have some time I could create an UI for this so it will be easier to set.

  • Like 1

Share this post


Link to post
Share on other sites

Can anyone get bgset to work, it just always uses the fall back background image for me.

 

Nevermind. Sorted it.

Edited by neonwired

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