Jump to content
kongondo

Module: Matrix Fieldtype & Inputfield

Recommended Posts

Some more thoughts on this - I wonder if maybe it's just best to turn on output formatting - that should handle getting the language for the current user.

On an unrelated note, I noticed that each entry in the matrix is a full PageArray - is this necessary? I haven't looked into/thought through this, but it seems like a lot of info to have in memory when all we need is a single value with its relevant row and column page ids. Maybe the full PageArray is needed, or maybe it doesn't matter - just thought I'd ask :)

Share this post


Link to post
Share on other sites

Hi Adrian. Glad you found a solution.

10 hours ago, adrian said:

Not sure if you want to implement just like this, or whether you think it's worth adding a more complete ML solution.

I haven't looked at this module in a while. I will have a think.

10 hours ago, adrian said:

PS - what about changing "Row Label" to the title of the parent page of the first column. In my case I have a page branch of Years to control this column. It would be much nicer if this read "Years" or "Year". Would that work, or are there more things to consider?

Ditto :).

Share this post


Link to post
Share on other sites
7 hours ago, adrian said:

On an unrelated note, I noticed that each entry in the matrix is a full PageArray - is this necessary?

That's strange. Where did you see that? The module does not return Page or PageArrays anywhere . A single entry is a Matrix object (a WireData) and groups of entries are MatrixArray objects (WireArray). Maybe I haven't looked at this in a while but I am pretty sure about this :).

Share this post


Link to post
Share on other sites

Hey @kongondo - note the Page within each Matrix item. Each one of these contains a full reference to the current page. This comes from dumping $page->matrix_field

58de67f336206_ScreenShot2017-03-31at7_29_43AM.png.3bebfb53ba4d61ab004d09a691779876.png

 

Here is the dump of $rows and $columns from the export function. You can see that each row is a full PW page object.

58de6dbbe8f1d_ScreenShot2017-03-31at7_53_28AM.png.463af2d8871a92b23da4f19b82c30be3.png

Is this expected?

Share this post


Link to post
Share on other sites

@adrian,

Aah, my bad. The culprit is where I grab the respective row and column pages in order to get the friendly rowLabel and columnLabel respectively. Would uncacheAll do the trick (to clear memory)? If not I could get titles using raw SQL...

Thanks for catching this.

Share this post


Link to post
Share on other sites

Hey @kongondo - me again :)

I have another issue for you - I recently deleted a page that was driving the matrix rows (ie in the "data" field in the DB), but it didn't remove that row from the matrix table. Maybe this in intentional to prevent potential data loss, but it seems like there is no way of removing these without a manual SQL query to delete the appropriate entries from the DB. I am away from my computer the next couple of days and don't have time to test further right now, but please let me know if you have any trouble reproducing and I'll run some more tests.

Share this post


Link to post
Share on other sites

I'm trying to keep 'scores' for users on certain pages.  So far Matrix seems to do the job, as I can type a score for every user and for different assignments. 

What I'm trying to do now is to enter scores using the API, so *not* using the admin pages. 

If I understand things right, Matrix is simular to (or an instance of?) WireArray, so I should use $matrix->add(sth)?  I just can't find my way through. 

Does anyone have an example code snippet for entering values to a Matrix using the API?  It would help me a lot. 

 

edit: Of course I can always enter the data directly into the database, but I'd rather use the power of PW if possible. 

Share this post


Link to post
Share on other sites
On 2017-4-9 at 10:41 PM, adrian said:

I have another issue for you - I recently deleted a page that was driving the matrix rows (ie in the "data" field in the DB), but it didn't remove that row from the matrix table.

Thanks Adrian, I'll have a look.

On 2017-5-16 at 9:35 AM, longtom said:

Does anyone have an example code snippet for entering values to a Matrix using the API? 

Sorry for the late reply Longtom.  Here's a code snippet:

 

Share this post


Link to post
Share on other sites

Hi all. 

I am intending to ONLY support ProcessWire 3.x starting from the next version of this module. Please have a read here and let me know what you think. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Hello @Kongodo and thanks for this module,

I am always in a hurry, and probably that is the reason why I still can't find right solution how to use this field.
Please can somebody write short instruction how to get this on attached image using this field?

Thanks.

 

opening-time.png

Share this post


Link to post
Share on other sites
12 hours ago, OLSA said:

Please can somebody write short instruction how to get this on attached image using this field?

The very, admittedly limited, docs are here.

Your days of the week are Matrix Rows. Your Open and Close are Matrix Columns. I suggest you create a parent page for both. So A Days of the Week page whose children are the Days themselves and something similar for Open and Close. Then use method 1 or 2 as described in the docs to populate your rows and columns. Alternatively, see method 3 which allows you to use multi pagefields.

  • Like 1

Share this post


Link to post
Share on other sites

All,

I intend to give this module some love soon. As part of this, I'm considering how to allow custom names for Columns and Rows (i.e. other than pages). 

  • Like 2

Share this post


Link to post
Share on other sites

Hello @kongondo

only a question: is it possible to use a special field of a page for the field of the matrix (fe a date field, an integer field,..)?

Share this post


Link to post
Share on other sites
2 hours ago, Juergen said:

Hello @kongondo

only a question: is it possible to use a special field of a page for the field of the matrix (fe a date field, an integer field,..)?

For storage, no, for reference, yes. Matrix stores a page ID for Row, a page ID for Column and a varchar for the value of the matrix (i.e. row-column = value). Using the page IDs of Row and Column, you can use PW API to get the page and hence, any field on that page.

Maybe not what you are after but thought to clarify anyway.

  • Thanks 1

Share this post


Link to post
Share on other sites

Hello @kongondo,

I have discovered a strange behavior:

I use a pagetable field inside a parent page. If click on the link inside the pagetable to open a child page inside a modal, I will be logged out from the system if the child page has a matrix field inside.

I have traced down the problem and it has to do with a hook that I run on the pagetable field of the parent page (inside my ready.php):

$wire->addHookBefore('InputfieldPageTable::render', function($event) {
   if($this->process != 'ProcessPageEdit') return;
   $table = $event->object;
   $page = $this->process->getPage();
   // event table   
   if(in_array($table->name, ['datespagetable', 'specialbusinesshourstable', 'eventspagetable', 'businessvacationpagetable'])) {
       if(count($page->children) == 0){          
           $table->notes = "";
            $this->buttonHook = $this->addHookAfter("InputfieldButton::render", null, function(HookEvent $event){
                $event->return = __("Here all dates will be shown afterwards if some were created.");
            });
      } 
      //this part of the button hook is responsible for loggin me out if I click on the link to the page inside the pagetable 
      else {
      $this->addHookBefore("InputfieldButton::render", null, function(HookEvent $event){      
         $button = $event->object;
         if($button->name == 'button'){
          $button->attr('value', __('Add event'));
         }
      });
} 
}
}); 

Inside this hook there is another hook for rendering the "Add new" button. So this "InputfieldButton::render" hook is responsible for loggin me out (if I remove this part everthing is fine).

So its not a big problem for me (I have comment it out), but maybe you have an idea, why these lines of code could lead to this behavior in combination with the matrix field.

Best regards

 

Share this post


Link to post
Share on other sites
19 hours ago, Juergen said:

but maybe you have an idea, why these lines of code could lead to this behavior in combination with the matrix field.

I'm totally clueless about this :lol:. I'll have to investigate, but it might not be soon, I'm afraid. I need to finish  work on some other module first, before I can turn my attention to Matrix.

Thanks for reporting.

Share this post


Link to post
Share on other sites

@kongondo Thank you very much for this module. Very useful in a simple shop scenario that I'm building with PW 3.0.125 on PHP 7.2.

When I try to dump a Matrix field on a page with bd($p->variationmatrix) I get an error:
Exception: Class 'MatrixArray' doesn't yet implement method 'makeBlankItem()' and it needs to. on line: 190 in /var/www/hugoerke.local/wire/core/WireArray.php

Just looping over $p->variationmatrix does not throw the exception.

As a quick fix, I added the amended original method from WireArray to the MatrixArray Class like this
 

	public function makeBlankItem() {
		$class = wireClassName($this, false); 
		if($class != 'MatrixArray' && $class != 'PaginatedArray') {
			throw new WireException("Class '$class' doesn't yet implement method 'makeBlankItem()' and it needs to.");
		}
		return null;
	}

No more exception now. But still wondering why this happened, maybe something in the core changed that requires every WireArray derived class to redefine this method?

Share this post


Link to post
Share on other sites
On 2/14/2019 at 10:13 AM, gebeer said:

Thank you very much for this module

@gebeer, glad it's been of help :-).

On 2/14/2019 at 10:13 AM, gebeer said:

But still wondering why this happened, maybe something in the core changed that requires every WireArray derived class to redefine this method?

I can't remember when this was introduced, but yeah, it's now a requirement. I'll add the method though. Thanks!

On 2/14/2019 at 10:13 AM, gebeer said:

As a quick fix, I added the amended original method from WireArray to the MatrixArray Class like this

Use this instead:

/**
 * Per the WireArray interface, return a blank Matrix
 *
 * @return WireData $matrix A blank Matrix.
 *
 */
public function makeBlankItem() {
    $matrix = new Matrix();
    return $matrix;
}

 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks again for this great module. I enjoy working with it.

Found a small bug, though.

The MatrixArray->getValue() method retrieves the value from a matrix field on wire('page').

So it tries to get the matrix field of the page the code is executed on. This isn't always the page we want to process and where the matrix field actually lives on.

I changed MatrixArray.php, line 157 to

$value = $this->page->$n->get("$rowSel, $colSel");
// instaed of $value = wire('page')->$n->get("$rowSel, $colSel");

Now it is working fine.

  • Like 1

Share this post


Link to post
Share on other sites

Hi there.

I'm trying to work out if this module will suit a site I am working on, but I'm not sure how to add items via API. I saw your code snippet, but is there a way to modify individual elements rather than adding to them? What I mean is something like

$row = 1024;
$column = 2048;

$value = "hello, matrix!";

$matrix = $page->matrix_field;
$matrix->set($row, $column, $value);

or similar?

The dynamic nature of the row/column generation is perfect for my use case, but I will be needing to modify "cells" from the front end and not sure if this is how this module is designed to work or if I am just missing something obvious.

Thanks!

Share this post


Link to post
Share on other sites

Hi again.

Further to my last question, how do I use the class in the front end? I tried to copy the snippet with $matrix = new Matrix(); but it couldn't find the class. I tried to add the Matrix.php as a require_once line but now I get an error stating WireData cannot be found, so I assumed I need to instantiate the module some other way. I then tried to use the $modules->get method to load the module and changed new Matrix() to new \Matrix(). This seemed to load the Matrix class now, but it now complains with the following error:

Class 'MatrixArray' doesn't yet implement method 'makeBlankItem()' and it needs to.

I don't get this error when using the module in the back-end so I assume there is something else obvious I am missing.

Share this post


Link to post
Share on other sites

Hi @porl, @gebeer, all.

Apologies I have not been able to respond to your posts. Unfortunately I still don't have the time to look into the issues raised.

Share this post


Link to post
Share on other sites

This is a very useful module for me! But I can't figure out how the rows are sorted. When the example table is displayed, it appears sorted by name. But I need to sort it like in the admin tree or by titles, for example. Is it possible?

Share this post


Link to post
Share on other sites
On 11/21/2020 at 9:56 PM, Aleksey Popov said:

But I need to sort it like in the admin tree or by titles, for example. Is it possible?

Sorry for the late reply @Aleksey Popov,

If you mean sort the displayed table on the fly, then that's not possible currently. If you mean one off sort for the field in respect to how it retrieves pages for building the rows of the matrix, then you do this in the field's settings. See the details tab when editing the field. For instance, if using a selector, you would do it as shown below:

matrix_field_sort.thumb.png.6b2f5c25338f3b6d8cb790cdb3280298.png

I hope this answers your question. If not, please let me know.

Share this post


Link to post
Share on other sites
2 hours ago, kongondo said:

Sorry for the late reply @Aleksey Popov,

If you mean sort the displayed table on the fly, then that's not possible currently. If you mean one off sort for the field in respect to how it retrieves pages for building the rows of the matrix, then you do this in the field's settings. See the details tab when editing the field. For instance, if using a selector, you would do it as shown below:

I hope this answers your question. If not, please let me know.

Thanks a lot! I tried to do this, but using the table, as in the instructions, it did not work, I will experiment a little later. But for myself, I made a solution (simplified here) like this that works:
 

<? php
$output .= "";
$items = priceTable(pages()->find("template=page-lang, sort=sort")
foreach ($items as $item) {
  $matrixRow = $matrix->find("row={$item->id}");
  $output .="<div class='row py-1 border-bottom font-xs-sm'>";
  $output .= "
    <div class='col-4 language'>
      <a class='link text-danger' href='{$item->url}'>{$item->title}</a>
    </div>";
  foreach ($matrix->find("row=$item") as $value) {
    $output .= "<div class='col price text-right'><strong>$value->value</strong><small class='d-none d-md-inline'></small></div>";
  }
  $output .= "</div>";
}
return $output;

image.png.a6b7740c9ba05f98f1991bb40e7644e3.png

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