Jump to content
apeisa

Release: Thumbnails

Recommended Posts

Haven't thought about that use case at all, to be honest. I think that best way to support that would be offering "real" image cropping tool, that creates copies of original image, not just reference.

Share this post


Link to post
Share on other sites

The main reason I asked was due to the fact that adding a resized image with a link to the fullsize image just acts as a hardlink to it. i guess i could override this with jquery for javascript enabled users to load the image in a lightbox type thing instead.

Share this post


Link to post
Share on other sites

Thanks apeisa, I'm currently again testing with repeaters and there seems an issue with cropimages (not sure if images suffer the same) when I add a new repeater element on page with an cropimage field and upload an image, after saving the page the added element dissapears. Though after adding an element again there's still the image uploaded before (already reported issue on repeater thread, but think not solved yet). But after saving the page again then, it stays there and when clicking the "thumbnail" link a new window opens with this error:

Fatal error: Call to a member function get() on a non-object in /Applications/XAMPP/xamppfiles/htdocs/pw-dev/site/modules/Thumbnails/ProcessCropImage/ProcessCropImage.module on line 50

@soma did you resolve this issue? I am getting the same error when trying to open up the thumbnail cropper on all my CropImage fields (I have about 6). Not sure when this happened - I am using the field in some repeater elements - however the error is affecting all CropImage fields even those not in a repeater element.

The CropImage field is still working and creating all the thumbnails, it's just the crop edit window that is showing this error.

Share this post


Link to post
Share on other sites

@soma did you resolve this issue? I am getting the same error when trying to open up the thumbnail cropper on all my CropImage fields (I have about 6). Not sure when this happened - I am using the field in some repeater elements - however the error is affecting all CropImage fields even those not in a repeater element.

The CropImage field is still working and creating all the thumbnails, it's just the crop edit window that is showing this error.

Nope sorry.

Share this post


Link to post
Share on other sites

@apeisa

A client complained about not seeing the whole image if it is larger then his screen. I was able to fix this simply by adding 2 lines (boxWidth and boxHeight) in ProcessCropImage2.js. Maybe you can add something like this to your official release too?

Btw, this module so really great, and my customers are loving it! Thank you so much for releasing it!

$(function(){
$crop = $('#jcrop_target');
if ($crop.length > 0) {
 var w = $('#jcrop_target').data('width');
 var h = $('#jcrop_target').data('height');
 $crop.Jcrop({
  onChange: showCoords,
  onSelect: showCoords,
  aspectRatio: w/h,
  boxWidth: screen.width - 100,
  boxHeight: screen.height - 100
 });
}
$('#show_preview').click(function(){
 $('#preview-container').toggleClass('hide');
})
});
  • Like 2

Share this post


Link to post
Share on other sites

I had the same repeater problem that Soma reported some time ago. Following changes to ProcessCropImage.module got it working:

			   $this->setFuel('processHeadline', 'Crop images');

+			   $field = $this->input->get->field;
+			   if (preg_match("/_repeater[0-9]+$/", $field)) {
+				   $pages_id = (int) end(explode("_repeater", $field));
+				   $field = str_replace("_repeater$pages_id", "", $field);
+			   } else {
			   $pages_id = (int) $this->input->get->pages_id;
+			   }
		   $filename = $this->input->get->filename;
-			   $field = $this->input->get->field;
		   $height = $this->input->get->height;
		   $width = $this->input->get->width;
		   $prefix = $this->input->get->prefix;

This is a bit of a hack and I haven't even tested it properly, so I'm definitely not saying that anyone should use the same method -- but it worked for me :)

  • Like 2

Share this post


Link to post
Share on other sites

Thanks Guys.

Interrobang: tested and worked nicely - thanks for the tip, I just committed it. Great improvement.

Teppo: I think there should be cleaner way to see if field is repeater. Probably by getting the actual field an checking it's fieldtype. But this is great news to know the solution for this problem. Will look into this soon (before holidays I hope).

  • Like 2

Share this post


Link to post
Share on other sites

So I have a simple question. I am doing something very wrong I guess, I have two issues.

Issue 1. When I go to hover over the thumbnail in the images field, it breaks. Not really sure what is going on here, but I can live with this issue. (found solution to this one.)

Issue 2. I can't figure out how to pull the thumbnails, if they exist into my template. I am currently using this:

<ul class='gallery'>
<?php
foreach($page->images as $image) {
$thumb = $image->size(500, 400);
echo "<li class='gallery-item'>";
echo "<a href='{$image->url}' class='albumImageLinks fancybox-button' rel='fancybox-button'>";
echo "<img class='gallery-image' src='{$thumb->url}' alt='{$thumb->description}' /></a>";
echo "</li>";
}

?>
</ul>

However, I want to pull a thumbnail if it exist for certain images which I need to crop using your module. I have tried everything in the directions, but I keep getting errors involving eq.

Sorry I am not the best at php.

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

Solved my problem: for people in the future here is the code that worked for me:

<ul class='gallery'>
<?php
foreach($page->port_images as $image) {
  $thumb = $image->getThumb('thumbnail');
  echo "<li class='gallery-item'>";
  echo "<a href='{$image->url}' class='albumImageLinks fancybox-button' rel='fancybox-button'>";
  echo "<img class='gallery-image' src='{$thumb}' /></a>";
  echo "</li>"; 
}

?>
</ul>

Also you need to create a thumbnail settings that matches what you were going to use for the size parameters. For me I was using 500/400, if you describe these settings, they are defaulted, then you can crop to the size you need for specific pictures, the rest are center cropped, which is exactly what I needed! Thanks for this fantastic solution for cropping images!

  • Like 2

Share this post


Link to post
Share on other sites

The problem you might have (I think) is if you change the fieldtype from Image to cropImage, it automatically creates a default thumbnail so you can't test for the absence of one and use your original Image fieldtype-cropped image. I might be totally wrong here though.

If you were using a one-page-per-image setup it might be easier because you can just serve an alternative cropped image.

[example written in the browser so not sure it works exactly]

<?php
$featured = $pages->get("/page/")->children;
foreach($featured as $feature) {
$thumbnail = $feature->thumbfield; /*check for the thumbnail field */
 if(!$thumbnail) {
 $thumbnail = $feature->imagefield->size(400,500); /* if no thumbnail field just use the regular image field */
 echo "<img src='{$thumbnail->url}' alt='{$feature->title}'/>";
} else {
 echo "<img src='{$thumbnail->getThumb('thumbs')}' alt='{$feature->title}'/>";
}

Regards

Marty

Share this post


Link to post
Share on other sites

Just merged pull request from Ryan, which includes few nice improvements to this module:

1. Support for securefiles (coming in 2.3)

2. Works on regular image files

3. Some minor code tweaks (sanitizing & indentation)

Ryan: about "works on regular image field also": how does it work? Thumbnail settings are set per field basis, and the setting field is visible only when fieldtype is cropImages - so where does it get thumbnail sizes for regular images?

I tested the commit before merging and it didn't break anything on my test installation - so it should be safe to just pull in the latest changes.

Thanks for the update Ryan!

  • Like 3

Share this post


Link to post
Share on other sites

4. One other thing I added: If you delete an image, it won't leave the crops behind (they get deleted too). Previously the crop files would stick around even after the original image was gone.

Ryan: about "works on regular image field also": how does it work? Thumbnail settings are set per field basis, and the setting field is visible only when fieldtype is cropImages - so where does it get thumbnail sizes for regular images?

The field config is defined in InputfieldCropImage.module rather than FieldtypeCropImage.module, so that's why it works. It's more your doing than mine, as I only had to tweak a couple things to make it work. It was an accidental find too. Meaning, I wasn't intending to add this specifically, but noticed it worked through my own error of forgetting to change the fieldtype. It's possible I'm missing something, but it all seemed to work fine here. Of course, the FieldtypeCropImage is still a necessary component. But it's acting like an autoload module, adding hooks to Pageimage and Pageimages.

  • Like 2

Share this post


Link to post
Share on other sites

Ah, actually the per field settings were another community contribution. I think it wouldn't be too hard to get rid of the FieldtypeCropImage alltogether, need to take a good look at it some point.

Share this post


Link to post
Share on other sites

I just added this module to a standard 2.2.9 installation, had two existing posts with images already uploaded using the core 'Image' field type and changed the 'images' field's type and input field type to 'CropImage'.

Now I am getting a 'There is no thumb called thumbnail' message (with the rest of the page being blank, no input forms displayed) whenever I open an existing post with previously uploaded images. When I create a new post, I get the same message within the image upload form after uploading an image.

Any idea what I am doing wrong?

Share this post


Link to post
Share on other sites

From mobile: check field settings and resave the field. Empty modules cache.

Share this post


Link to post
Share on other sites

From mobile: check field settings and resave the field. Empty modules cache.

Emptying the cache and resaving did the job. I also temporarily added a second thumbnail configuration but removed it again, so I am not sure what the actual problem was. Thanks for the lightning fast support!

By the way: the whole UI is really state of the art, props!

Share this post


Link to post
Share on other sites

It has problems if you change a image field to cropimage field. At least it was for me.

Share this post


Link to post
Share on other sites

Thanks a lot for this great module, this really makes image handling in Processwire a breeze.

That said, I'm looking for a quite specific feature that seems to be hard to accomplish with the current module. I'd like to recrop a given image with the same visible section as a given image version. Imagine I have an image version for crop image set up to be 150x100. Then I need a version of that image in 100x100, but cropping from the section that was selected for the 150x100 version. The new image should be generated from the originally uploaded one to not run into more issues with quality, for sure.

Does anyone see a way how this might be possible already?

And can this be integrated in the module? I'm imagining something like

$page->myImage->getThumb('sizename', 100, 100);

With kind regards, Marc

Share this post


Link to post
Share on other sites

That is really special edge case, I don't think I'll take this module into that direction, sorry Marc. But of course you could use this module as a starting point for your need for sure. Difficult to say how to achieve that goal though...

Share this post


Link to post
Share on other sites

Thanks for your quick answer, Anttii!

I can really understand that this doesn't fit in there too well. Still I'm wondering how to do it, too.

One option would be to define addional sizes that inherit proportions and section from another size in the field settings already:

thumbnail, 150, 100
thumbnailvariant, 100, 100, thumbnail

'thumnailvariant' would then not be shown when editing the field and might be generated right after 'thumbnail' is generated. This wouldn't enable to get arbitrary sized images, but should be relatively easy to accomplish and would definitely fit my needs at the moment.

To enable this, it would be necessary to store the data from jCrop (x and y coordinates, width and height) in it's own table in the DB to do custom crops based on that data later. This variant sounds like a lot of work but also would be a great basis for a lot of other features that might come later (i.e. being able to change the proportions of certain image sizes without losing all custom crops already done by batch processing existing images).

I'll definitely wrap my head around this, might take some time though.

Share this post


Link to post
Share on other sites
Does anyone see a way how this might be possible already?

I think that you can do this all with CSS. Once you've got a crop, you can automatically CSS position it within a markup container (that has overflow hidden) to achieve variations like those you mentioned. That is, so long as the crop is something smaller than the original. You could go about it either using an <img> in a <div>, or just a <div> with a background image. If you need to just scale, or scale and crop, you'd probably want to use an actual <img> tag that specifies either the target width OR height (not both) with the other dimension overflow:hidden by the container. If you are supporting high DPI/retina displays, you are probably already doing this to some extent, in terms of the scaling aspect. 

  • Like 1

Share this post


Link to post
Share on other sites

Hi Ryan, thanks for your answer. I think you're pretty right for a lot of use cases, but this doesn't serve my use case here.

I think I didn't make it clear enough that I don't only want to crop but zoomcrop, cropping of the larger dimension so that after zooming the smaller dimension fits. Also I want to use these different versions of the image on different pages (overviews, recommendations to other pages, etc).

I still might scale browserside with an <img> tag resized with CSS, but this isn't a good practice, the resizing of older browser is quite bad and it will limit me to an aspect ratio.

For the project I'm working on now, I'm just going to add another image variant in the CropImage field settings. This is a little less comfort, but since this won't be used too much either way, I can't afford to spent the time to rewrite the CropImage module to serve my needs. I'll definitely come back to this, because I think that I'd still want to see this in the module.

Thanks for all your help so far,

Marc

Share this post


Link to post
Share on other sites
I still might scale browserside with an <img> tag resized with CSS, but this isn't a good practice, the resizing of older browser is quite bad and it will limit me to an aspect ratio.

This was a bad practice years ago. Correct me if I'm wrong, but this is not a bad good practice now, at least if you want to support high DPI screens? I mean if you go inspect the ProcessWire logo in the upper left hand corner and open it in a new window, you'll see the actual image is much larger than it appears on the site. That's the only reason it looks sharp on a retina screen. Yes, this might make it look bad on IE6, but well… if you are using IE6, life is already a bummer. :)

The purpose of specifying one dimension with the <img> tag and using an overflow:hidden for the other is to prevent any stretching of the image (maintain aspect ratio).

I've not personally used this technique, so not speaking from experience. But it seems so simple that I'm inclined to try it. 

I think I didn't make it clear enough that I don't only want to crop but zoomcrop, cropping of the larger dimension so that after zooming the smaller dimension fits

Unless you are talking about upscaling an image (I'm guessing not) then it just means you've got to start with a bigger crop, in terms of physical dimensions.

Share this post


Link to post
Share on other sites

Ryan, you're pretty right about everything you said there, but I just didn't make my use case clear:

I don't want to support retina screens, but I want completely different version of an image while saving the same clipping. What I want is for example let the user crop an image to 400x300 with the CropImage-Inputfield and use this image somewhere (i.e. as a preview in article overviews) as it is.

At another place I want the same image sized to 200x100. Everything's different about this, the size and the aspect ratio. I don't want my user to crop to this size on his own (because that might get a lot of different versions of an image for a large site) and I just assume, that what is in the 400x300 version is the most important part of the image and will work in the smaller dimension, too. So I want to zoomcrop my 200x100 version from the center of the 400x300 version, but not working with that image again but with the original image to get the best quality.

I hope this is more understandable now :-)

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 bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      http://modules.processwire.com/modules/process-admin-actions/
      https://github.com/adrianbj/ProcessAdminActions
       
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
       
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
       
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
       
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      http://mysite.dev/processwire/setup/admin-actions/options?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add
      or you can execute immediately:
      http://mysite.dev/processwire/setup/admin-actions/execute?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add

      Note the “options” vs “execute” as the last path before the parameters.
       
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
       
       
    • By joshua
      ---
      Module Directory: https://modules.processwire.com/modules/privacy-wire/
      Github: https://github.com/blaueQuelle/privacywire/
      Packagist:https://packagist.org/packages/blauequelle/privacywire
      Module Class Name: PrivacyWire
      Changelog: https://github.com/blaueQuelle/privacywire/blob/master/Changelog.md
      ---
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Functional
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The data-attributes (data-type and data-category) are required to get recognized by PrivacyWire. the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button>  
      I would love to hear your feedback 🙂
      CHANGELOG
      You can find the always up-to-date changelog file here.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!


×
×
  • Create New...