Jump to content
horst

Page Image Manipulator | API for 1 & 2

Recommended Posts

Hey @sarah_hue, welcome to the forums and thanks for the kind words.

The recreation is forced by the optional second param of pimLoad. If you let it out or set it to false it takes the cached variation:

$imagewithwatermark = $img->pimLoad('tw'[, false] )-> ...

.
.
PS: viele Grüße in die Narrenhochburg Köln, Tätä!  :)

  • Like 2

Share this post


Link to post
Share on other sites

Great, thank you for the explanation! I completely forgot looking up the parameters for the function. :-[

  • Like 1

Share this post


Link to post
Share on other sites

Hi Horst, thanks so much for creating this module.

I have a question regarding page images that are set to allow multiple uploads per page, and which are placed into the body with CKEditor. Is there a method you would recommend for attacking each of these images, or would I be better off forcing my authors to use Hanna to place their images and tuck the image manipulation call in the hanna code?

Share this post


Link to post
Share on other sites

Hi @creativejay, I definitely would go with Hanna codes in RTEs.

  • Like 1

Share this post


Link to post
Share on other sites

Okay, I've written a bit in Hanna Code editor, and I'm getting this error:

Exception: Cannot read the pngAlphaImageFile!

Now, if I echo the URL for the file I set as the watermark image, it's correct.

Is this error referring to the way my file was saved? I used Photoshop's Save for Web, PNG-24, with Transparency, convert to sRGB. Is there something else I ought to be doing? I checked your sample action but I don't see save settings, and it has too much styling for what I want to do (and I'm using a smaller-than-image watermark).

In case it's an error with my coding, here's my Hanna Code:

<?php

if(isset($img)) {
  $myImage = wire('page')->blog_images->eq($img);
  //echo $myImage->url;
} else {
  $myImage = wire('page')->blog_images->first();
  //echo $myImage->url;
}

if(isset($pos)) {
  // If the position is set, we're good
} else {
  // otherwise we make sure the position is set to the default.
  $pos = 'SE';
}

if(isset($pad)) {
  // If the padding is set, we're good
} else {
  // otherwise we make sure the padding is set to the default.
  $pad = '2';
}

$username = wire('user')->name;
$AlphaImageUser = "{$config->urls->assets}images/authorwmk/swmb-{$username}.png";
// echo $AlphaImageUser;
$pngAlphaImage = $AlphaImageUser;

if($myImage != '') { 
    // Here's where the PageImageManipulator watermark code goes
    $imgsrc = $myImage->pimLoad('SwMb')->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad);  // **this is the line triggering the error
    $newimg = $imgsrc->height(400)->url;
    echo $newimg;
    echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{wire('page')->title}' /></a>";
    echo "<p><small>{$myImage->description}</small></p>";
}

Share this post


Link to post
Share on other sites

Hey, I think you simply need to respect the scope here in Line 26:

$config->urls->assets ...

 Try it with:

wire("config")->urls->assets
$AlphaImageUser = wire("config")->urls->assets . "images/authorwmk/swmb-{$username}.png";
Edited by horst

Share this post


Link to post
Share on other sites
wire("config")->urls->assets
$AlphaImageUser = wire("config")->urls->assets . "images/authorwmk/swmb-{$username}.png";

Thanks for the quick reply. Unfortunately this results in no change. The echo of $AlphaImageUser is the same for both wire("config")->... and $config->... (and both result in the correct path).

Share this post


Link to post
Share on other sites

Ah, sorry. I'm in hurry. Haven't read thoroughly.

So, 24 bit photoshop png should be fine. The error is triggered here: https://github.com/horst-n/PageImageManipulator/blob/master/ImageManipulator.class.php#L1651

It is only triggered when the file isn't existing or isn't readable: https://github.com/horst-n/PageImageManipulator/blob/master/ImageManipulator.class.php#L2437

It has nothing todo with the PNG type at this point here.

Are you sure the filename is correct?

You can test it in your code here before passing it to the pim:

echo "<pre>" . $AlphaImageUser . "\n";
echo realpath($AlphaImageUser) . "\n";
echo (is_readable(realpath($AlphaImageUser)) ? 'is readable' : 'UHM, is NOT readable!') . "\n</pre>";

Share this post


Link to post
Share on other sites

Thanks! I am getting the 'UHM' version, though I'm not sure why.

The results are:

/swatchmob/site/assets/images/authorwmk/swmb-mls.png

UHM, is NOT readable!

But the image does exist at http://www.creativejay.com/swatchmob/site/assets/images/authorwmk/swmb-mls.png so I'm really not sure what makes this path unreadable.

Edited to add: I had the same problem if I called the URL from an image field (on the user's profile) as the PNG source, as well.

Share this post


Link to post
Share on other sites

Oh, so does you have differences between your path and the output from realpath:

echo "<pre>" . $AlphaImageUser . "\n";
echo realpath($AlphaImageUser) . "\n";

??

..., and what does it say here with this tests:

echo "<pre>with realpath:\n";

// test with realpath
echo (file_exists(realpath($AlphaImageUser)) ? 'file exists' : 'file do NOT exist!') . "\n;
echo (is_readable(realpath($AlphaImageUser)) ? 'is readable' : 'UHM, is NOT readable!') . "\n";

// test without realpath
echo "\nwithout realpath:\n";

echo (file_exists($AlphaImageUser) ? 'file exists' : 'file do NOT exist!') . "\n;
echo (is_readable($AlphaImageUser) ? 'is readable' : 'UHM, is NOT readable!') . "\n";

echo "</pre>";

Share this post


Link to post
Share on other sites
with realpath:file do NOT exist!UHM, is NOT readable!without realpath:file do NOT exist!UHM, is NOT readable!

As you saw, there's a path associated in the case of "without realpath" and "with realpath" outputs nothing.

Sorry to lean on you heavily for this, I've never encountered this problem before.

Share this post


Link to post
Share on other sites

AH, it says file does not exist!!!

So, we have to use path instead of url, I think. :lol:

// not ->urls
$AlphaImageUser = "{$config->urls->assets}images/authorwmk/swmb-{$username}.png";

// but ->paths
$AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
  • Like 1

Share this post


Link to post
Share on other sites

That solves the missing image.

Unfortunately there's a new error now..  :o

with realpath:/home/creative/public_html/swatchmob/site/assets/images/authorwmk/swmb-mls.pngfile existsis readablewithout realpath:/home/creative/public_html/swatchmob/site/assets/images/authorwmk/swmb-mls.pngfile existsis readable

Error: Maximum execution time of 60 seconds exceeded (line 41 of /home/creative/public_html/swatchmob/wire/core/WireData.php)
This error message was shown because you are logged in as a Superuser. Error has been logged.

Share this post


Link to post
Share on other sites

You should take out the debug code snippets, now after we have solved that path thingy.

How many images are in the pipe for processing? around 10 or more?

Share this post


Link to post
Share on other sites

On this page there are five.

No change after removing the debug code (other than the code not outputting).

I am on shared hosting, does that bump me right out of the running for using this module?

Edited by creativejay

Share this post


Link to post
Share on other sites

I know from hosts where it comes to timeouts with around 10 images in 30 seconds. So with your host it seems to be 5 images in 60 seconds, what is super lazy processing.??

Share this post


Link to post
Share on other sites

According to my host, my server has a minimum "Dual 5530 Gainstown processors with 8 cores, RAID-10 protected hard disk space, and 8 GB of RAM."

I can increase my max_execution_time in the .ini so that it hopefully has time to run. I just have to find the right folder(s) to put the .ini in. Tried to change it in /.htaccess with no success.

Default is to cache these files, right? :lol:

Share this post


Link to post
Share on other sites

I've got it running but it's painfully slow on every page load, not just the first. I built a manual check for the resized image into my HannaCode to speed it up. That made a huge difference, even though I thought PIM checks for the file before it starts. Or maybe, as usual, it's me.

Can you tell me what about the following code seems to be forcing the image to re-create every time?

<?php
if(wire('page')->template = 'blog-post') {
  $width = '375';
  $myImage = wire('page')->blog_images->eq($img);
  if($myImage->description) {$alt = $myImage->description;}
  
  if($on='Y') {
	$pimImg = $config->paths->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->width($width)->name;
    $pimImgBig = $config->paths->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->name;
    echo $pimImg;
    if(file_exists($pimImg)) { 
        $wmkImg = $config->urls->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->width($width)->name;
        $wmkImgBig = $config->urls->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->name;
        echo "<a href='{$wmkImgBig}' title='Click for Full Size' /><img src='{$wmkImg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>";
    } else { 
    $username = wire('page')->createdUser->name;
	$AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
	$pngAlphaImage = $AlphaImageUser;
	$imgsrc = $myImage->pimLoad("SwMb", false)->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad)->pimSave();
    // output image
    $newimg = $imgsrc->width($width)->url;
	echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>";
	}
} else {
	$newimg = $myImage->width($width)->url;
	echo "<a href='{$myImage->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>"; 
}
}

Thanks again!

Share this post


Link to post
Share on other sites

Strange code you have here, not really getting what you doing there manually creating img path etc.

But this condition will always be true.

if($on='Y') {

Share this post


Link to post
Share on other sites

This will also be always true:

  1. if(wire('page')->template = 'blog-post') {

Share this post


Link to post
Share on other sites

Hi Soma, thanks for reading it over!

Strange code you have here, not really getting what you doing there manually creating img path etc.

But this condition will always be true.

if($on='Y') {

As I mentioned, it seemed like Page Image Manipulator was making the images fresh each time the page loaded (with no changes to HannaCode or the page images field), so I was trying to test that theory, and also speed up the page load (which it has).

$on is a variable that I wanted to provide for the page author, so that if the image already has a watermark, or if it was sourced from another creator, we wouldn't watermark the image. is $on something global I'm not aware of? I can easily change that name.

This will also be always true:

  1. if(wire('page')->template = 'blog-post') {

I added that because on my home page (of template swmb-home) I was getting an error that I was trying to get eq() on a non object. Adding that line fixed it.

Share this post


Link to post
Share on other sites

@creativejay - what Soma is getting at is that in PHP (and many other coding languages, maybe all ?) a single equals sign does not check if one thing equals the other, but rather makes it equal. So even though you have the if(), that line is always setting $on to "Y".

You need to use two equals signs, eg:

if($on=='Y') {

In some situations you even want to make use of three. Here is a useful discussion on the differences:

http://stackoverflow.com/questions/2063480/the-3-different-equals

Share this post


Link to post
Share on other sites

Ah! Thank you for rubbing my nose in it, adrian. I would claim to know the difference, but then I do things like that. And worse, don't spot them after.

My question does remain, though. Any idea why PIM seems to re-process the image on every page load unless I check for the file and skip it manually?

<?php
if(wire('page')->template == 'blog-post') {
    // lay some ground rules
  $width = '375';
  $myImage = wire('page')->blog_images->eq($img);
  $prfix = 'swatchmob';
  if($myImage->description) {$alt = $myImage->description;}
    // check if the watermark is needed
  if($on =='Y') {
    // check if the watermark exists already
    $pimImg = $config->paths->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->width($width)->name;
    $pimImgBig = $config->paths->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->name;
    if(file_exists($pimImg)) {
        $wmkImg = $config->urls->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->width($width)->name;
        $wmkImgBig = $config->urls->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->name;
        echo "<a href='{$wmkImgBig}' title='Click for Full Size' /><img src='{$wmkImg}' class='align_center' alt='{$alt}' /></a>";
    } else {
    // build the file with the watermark
    $username = wire('page')->createdUser->name;
    $AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
    $pngAlphaImage = $AlphaImageUser;
    $imgsrc = $myImage->pimLoad($prfix, false)->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad)->pimSave();
    // output image
    $newimg = $imgsrc->width($width)->url;
    echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a>";
    }
} else {
    $newimg = $myImage->width($width)->url;
    echo "<a href='{$myImage->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a>";
}
if($alt) { echo "<p><small>{$alt}</small></p>"; }
}
Edited by creativejay

Share this post


Link to post
Share on other sites

Ah! Thank you for rubbing my nose in it, adrian. I would claim to know the difference, but then I do things like that. And worse, don't spot them after.

That wasn't my intention at all :) We have all fallen victim to this one - several times!

I don't ever remember to do it, but it is why it is recommended to do:

f("Y"==$on){

With it reversed like that, if you forget the second equals sign, it will throw an error, rather than assigning the value!

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