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 21

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

I have issues regarding responsive images. I have used Markup srcset for images but the problem is I am not able to call the images added in repeater field as well as Multiple image field..

 

My code

<?php
    $i = 2;
    foreach($page->page_content as $each) {
    if( $i%2 == 0 ){
?>
   <section class="imageblock about-1">
          <div class="imageblock__content col-md-6 col-sm-4 pos-left">
              <div class="background-image-holder">
<img alt="image"
 src=" '<?php echo $each->single_image->srcset('mode07');?>' "/>
              </div>
          </div>
                  <div class="container container-body">
                      <div class="row">
                          <div class="col-md-5 col-md-push-7 col-sm-8 col-sm-push-4">
                              <?php echo $each->body; ?>
                          </div>
                      </div>
                      <!--end of row-->
                  </div>
                  <!--end of container-->
     
   </section>

Share this post


Link to post
Share on other sites

Hi Pravin,

I think common mistake of newbies of the forum is to not contextualize the situation they're are asking help with.

If you want help (and this is the right place :)) try first to help us understand at best what is your setup. Take for example some screenshots of your fields (the repeater containing the images or whatever it is involved in this particular situation).

Hint: wrap html, php, or js code inside the "<>" icon you have in the editor, it greatly improves readability :)

  • Like 5

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

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 David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...