kongondo

Module: Matrix Fieldtype & Inputfield

Recommended Posts

FieldtypeMatrix and InputfieldMatrix

Modules Directory: http://modules.processwire.com/modules/fieldtype-matrix/

GitHub: https://github.com/kongondo/FieldtypeMatrix 

The module Matrix enables you to save data from a 2D-Matrix table. The rows and columns of the matrix table are made up of pages retrieved via a ProcessWire selector or via a page field selection of parent pages. The matrix values are made up of the data input in the matrix cells, i.e. the 'intersection of rows and columns'.
 
Example Usage
You have Products whose prices vary depending on colour, size, material, etc. Using the Fieldtype, you can create a table with rows made up of colours and columns made up of sizes the combination of each making up their respective values (in this case price). So rather than creating multiple text fields to do the following:

Colour		Size		Price
Red		Small		£10
Red		Medium		£20
Red		Large		£30
Red		X-large		£35
Green		Small		£9
Green		Medium		£15
Etc...

You can instead have the following in one field:

		Small		Medium		Large 		X-Large
Red		£10		£20		£30		£35
Green		£9		£15
Blue		Etc...
Yellow
Purple

If you set a selector in the Field's settings, to retrieve pages to build your matrix's rows and columns, it follows that all pages using the template the Fieldtype is attached to will have identical rows and columns. In some cases, this could be the intention. For instance, you might have 'Car' pages, e.g. Audi, Volvo, Ford, Citroen, Mazda, BWM, etc., each of which uses a 'Cars' template that has a single FiedltypeMatrix called 'car_attributes'. If you set a selector to build the Fieldtype's rows and columns, your users can easily compare the cars based on a combination of different values. The following matrix table best illustrates this:

        Type            Engine Size Fuel Efficiency Carbon Emissions  Warranty  Road Tax  Price
1994   Audi brand 1    values, etc.            
2000   Audi brand 2             
2006   Audi brand 3              
2012   Audi brand 4            
             

Each of your car pages would have similar matrices. 

This allows you to make easy but powerful queries. Such a setup allows you to compare within and across car brands. Say you wanted to find out which car(s) offered the best value for money given certain parameters such as warranty, emissions etc. You can easily make such comparisons (see code below). You can also compare within one car type, e.g. which brand of BMWs does best in what area...The possibilities are endless.

In the database, Rows and column pages data are stored as their respective page->id. Matrix-values store any data (varchar(255)).

 
If instead you wanted a template's pages to each have a matrix built of different rows and columns, you would have to name a Multiple Page Field (attached to the same template as the as your matrix field) in the matrix field's settings. When editing those pages, your matrix table's rows and columns will be built using the published children pages of the 2 pages you select in the Multiple page field..
 
The module allows the creation of matrix tables of any sizes (rows x columns). The rows and columns dynamically grow/shrink depending on the addition of row/column pages that match what you set in the matrix field's settings (see its 'Details Tab'). Please note that, if such pages are deleted/trashed/hidden/unpublished, their data (and presence) in the matrix are also deleted.

Entering values in the matrix

You have three choices:

  • Manually entry
  • Uploading a comma delimited (CSV) file. This can be delimited by other characters (tab, pipe, etc); not just commas
  • Copy-pasting CSV values. (Tip: you can copy paste directly from an Excel spreadsheet. Such values will be 'tab-delimited').

In addition, if your server supports it, in the field's settings, you can enable the use of MySQL's fast LOAD DATA INFILE to read and save your submitted CSV values.

Note that for large tables, you may have to increase your PHP's max_input_vars from the default 1000 otherwise PHP will timeout/return an error and your values will not be saved. I have successfully tested the module with up to ~3000+ values (10x350 table), the Fieldtype is not really optimised (nor was it intended) to handle mega large matrix tables. For such, you might want to consider other strategies. 

 
Install
Install as any other module.
 
API + Output
A typical output case for this module would work like this:
 
The matrix's rows, columns and values are subfields of your matrix's field. So, if you created a field called 'products' of the type FieldtypeMatrix, you can access as:

product.row, product.column and product.value respectively

 

foreach($page->matrix as $m) {
  echo "
    <p>
    Colour: $m->row<br />
    Size: $m->column<br />
    Price: $m->value
    </p>
    ";
}

Of if you want to output a matrix table in the frontend: 
 

//create array to build matrix
$products = array();

foreach($page->matrix as $m) $products[$m->row][$m->column] = $m->value;

$tbody ='';//matrix rows
$thcols = '';//matrix table column headers

$i = 0;//set counter not to output extraneous column label headers
$c = true;//set odd/even rows class
foreach ($products as $row => $cols) {

          //matrix table row headers (first column)
          $rowHeader = $pages->get($row)->title;

          $tbody .= "<tr" . (($c = !$c) ? " class='even' " : '') . "><td class='MatrixRowHeader'>" . $rowHeader . "</td>";

          $count = count($cols);//help to stop output of extra/duplicate column headers

          foreach ($cols as $col => $value) {

                    //matrix table column headers
                    $columnHeader = $pages->get($col)->title;

                    //avoid outputting extra duplicate columns
                    if ($i < $count) $thcols .= "<th class='MatrixColumnHeader'>" . $columnHeader . "</th>";

                    //output matrix values
                    $currency = $value > 0 ? '£' : '';
                    $tbody .= "<td>" . $currency . $value . "</td>";

                    $i++;

          }

          $tbody .= "</tr>";

}

//final matrix table for output
 $tableOut =   "<table class='Matrix'>
                <thead>
                  <tr class=''>
                    <th></th>
                    $thcols
                   </tr>
                </thead>
                <tbody>
                  $tbody
                </tbody>
            </table>";

echo $tableOut;

The module provides a default rendering capability as well, so that you can also do this (below) and get a similar result as the first example above (without the captions). 

echo $page->matrix;

Or this

foreach($page->matrix as $m) {
         echo $m; 
}

Finding matrix items
The fieldtype includes indexed row, column and value fields. This enables you to find matrix items by either row types (e.g. colours) or columns (e.g. sizes) or their values (e.g. price) or a combination of some/all of these. For instance:

//find all pages that have a matrix value of less than 1000
$results = $pages->find("products.value<1000"); 
//find some results in the matrix (called products) of this page
$results = $page->products->find("column=$country, value=Singapore");//or
$page->products->find("column=$age, value>=25");
//$country and $age would be IDs of two of your column pages

Other more complex queries are possible, e.g. find all products that are either red or purple in colour, come in x-large size and are priced less than $50.

Credits
@Ryan on whose Fieldtype/InptufieldEvents this is largely based
@charger and @sakkoulas for their matrix ideas
 
Screens
 
Field Details Tab
matrix-fieldtype-selector.png
 
Inputfield
matrix-inputfield.png

Larger matrix table

matrix-csv-100x10-values.png
 
Example output
matrix-table-output.png

  • Like 29

Share this post


Link to post
Share on other sites

Some follow up questions here about select row/column pages per page vs per field:

Coming soon...pls wait...

Resolved this (answered my own questions :-)) see below update..

Edited by kongondo

Share this post


Link to post
Share on other sites

Great stuff!! Thanks a lot! I did some testing, and everything seems to work.

I have one feature that I'm missing. I'm aware this is not the core idea of this module, but I wanted to mention it anyway. Ok, so here it is:

If I have a selector for columns/rows that goes like parent=1283|1284, it works as expected by listing the children of both parents. The output could be like this:

S
M
L
Cotton
Nylon

However, it would be cool to have an option (checkbox) that creates all possible combinations of the selected children, like this:

S Cotton
M Cotton
L Cotton
S Nylon
M Nylon
L Nylon

In my case, I need this because I have multiple currencies for the rows.

As mentioned, I don't know if this too much out of scope and maybe needs an additional module.

  • Like 1

Share this post


Link to post
Share on other sites

@Charger,

I see no easy way of doing that (3-way relationship) using this particular module. I'll see if I can do a bespoke one for your needs.

Share this post


Link to post
Share on other sites

Update: version 0.0.2

Added ability to reuse a single matrix field across pages/templates to build unique matrix tables on a page by page basis. This is achieved by specifying the name of a Multiplepages select field in the Fieldtype settings (Details Tab). It allows you to select row and column parent pages from within the page containing the matrix itself. The child pages of these parents are used to build the matrix. This setting overrides the Row and Column selector settings of the fieldtype.

Example usage:

  1. Create a Multiplepages field and call it, for example, 'product_select'. Set it up as you wish (e.g. custom PHP, selectors, etc for selectable pages). You may wish to use ASM select to make things prettier/easier below.
  2. Add it to the same template(s) where you will be using a matrix field.
  3. In your matrix field's Details Tab, specify the name of the page field (i.e. 'product_select') under the 'Matrix Row and Column Parent Pages' setting.
  4. Edit the page where you will be building a matrix table.
  5. Select 2 pages in your 'product_select' whose child pages will be used to create your matrix rows and columns. The order is important! The first selected page will be assumed to be the row pages parent and the second one the column pages parent. Any additional pages here will be ignored.
  6. Save your page and your matrix table will be built using the children of the selected parent pages.
  7. Note: The usual error checking will be done and 'thrown' (e.g. if parent pages do not have children, if your specified page field is not a page field/does not return a PageArray, etc.
  8. Note 2: You can swap/change the row/column pages in your page field (product_select) HOWEVER, all previously saved values will be deleted(!) on save and your matrix table rebuilt to reflect the new specified row/column structure.

Todo/think about

  • Copy values from Excel and directly paste this in a similarly structured matrix table
  • Export matrix table?
  • 1-click clear all values entered in a matrix table
  • Etc?

Download:

https://github.com/kongondo/FieldtypeMatrix

Screens

Named Page Field to select rows and columns parent pages

post-894-0-51198400-1418959469_thumb.png

Row and Column parent pages selection in a specified Page Field

post-894-0-04615700-1418985321_thumb.png

Reusing a single matrix field on a different page(s)

post-894-0-38870300-1418985322_thumb.png

  • Like 5

Share this post


Link to post
Share on other sites

Great stuff!! Thanks a lot! I did some testing, and everything seems to work.

I have one feature that I'm missing. I'm aware this is not the core idea of this module, but I wanted to mention it anyway. Ok, so here it is:

If I have a selector for columns/rows that goes like parent=1283|1284, it works as expected by listing the children of both parents. The output could be like this:

S
M
L
Cotton
Nylon

However, it would be cool to have an option (checkbox) that creates all possible combinations of the selected children, like this:

S Cotton
M Cotton
L Cotton
S Nylon
M Nylon
L Nylon

In my case, I need this because I have multiple currencies for the rows.

As mentioned, I don't know if this too much out of scope and maybe needs an additional module.

@Charger,

I see no easy way of doing that (3-way relationship) using this particular module. I'll see if I can do a bespoke one for your needs.

Hmm, or maybe I should include this in the present module but with a max 3-way relationship? Otherwise it get messy if more. The 3rd relationship (materials in your case) would only kick in if user configures it in the Fieldtype settings as you suggested. What do you guys think?

  • Like 1

Share this post


Link to post
Share on other sites

Looks great kongondo!! Very impressed.

How are the intersection values being stored? (Sorry, I've not dug around in the code.)

  • Like 1

Share this post


Link to post
Share on other sites

...How are the intersection values being stored? (Sorry, I've not dug around in the code.)

That turned out (later) to be the easy bit :-). They are stored similar to Page Fields...(see second screenshot below)

Matrix array (see post below - we use this only for grabbing db values to later manipulate to build matrix cells/intersections. We use a different array for saving)

post-894-0-11754400-1418998901_thumb.png

Matrix db table (see update below [version 0.0.3] about avoiding saving records with empty values)

post-894-0-11824800-1418998904_thumb.png

Edited by kongondo
  • Like 6

Share this post


Link to post
Share on other sites

@kongondo, is there any need to store the empty results?

Just wondered as once you get into the world of combinatorials things quickly get memory hungry big; and PHP associative arrays aren't exactly the world's most efficient storage format. Any idea how this fieldtype works out memory wise? 

  • Like 3

Share this post


Link to post
Share on other sites

@Steve,

Good catch about empty values! Don't know how I mised that! I have corrected it in Version 0.0.3 (post here soon), thanks!

Memory issue: That was my next question. I would like to do/see some real world tests....+ there's also PHP post limits...Would appreciate if anybody could help test :-), thanks.

  • Like 3

Share this post


Link to post
Share on other sites

i do tests with matrixField and seems to be working fine, (i have edit a little the inputfieldMatrix.module to retrieve matrix_columns and matrix_rows from a pagefield inside the same page) i'm still testing it, for any issues i will post here...

Thaaaaaaanks kongondo :)

  • Like 1

Share this post


Link to post
Share on other sites

Update: version 0.0.3
 
Small but important update to correct oversight whereby records with empty values were being saved to the database, thx @netcarver.

  • Like 2

Share this post


Link to post
Share on other sites

i do tests with matrixField and seems to be [/size]working fine, (i have edit a little the inputfieldMatrix.module to retrieve matrix_columns and matrix_rows from a pagefield inside the same page) i'm still testing it, for any issues i will post here...

How is that different from version 0.0.2 I posted earlier? :-)

Share this post


Link to post
Share on other sites

hmm is it possible in settings to search for matrix_row or matrix_column  where $field = $page->field;

  

Share this post


Link to post
Share on other sites

Partial reply...

Looking at this some more I don't think this will be a major concern for most small combinations that people were suggesting (like {S, M, L, XL} crossed with {Red, Green, Blue}) but I am interested in how this might scale if people start specifying a set of pages for the x-axis with a larger number of members - say 30 options and a set of pages for the y-axis with another 20 options. Or perhaps if a user mistypes a selector and end up with 1000s of pages in one of the axis - would there be issues? (I'm kinda asking as I'm hitting an issue with a module of my own that needs a safe fallback position if something goes wrong.)

When I've looked at memory usage in the past, I've tended to use the memory_get_usage() function to track this kind of thing.

  • Like 1

Share this post


Link to post
Share on other sites

hmm is it possible in settings to search for matrix_row or matrix_column  where $field = $page->field;  

Yes. They are subfields of whatever your field is. The subfields are the names of the columns in the Fieldtype's db table, i.e. matrix_row, matrix_column and matrix_value.

The selector format would be: field.subfield=value

E.g., if your your matrix field was called 'product', you would search for: . product.matrix_row, product.matrix_column and product.matrix_value.

I'm in a hurry atm, see examples here:

http://processwire.com/api/selectors/#subfield

https://processwire.com/talk/topic/5040-events-fieldtype-inputfield-how-to-make-a-table-fieldtypeinputfield/

https://processwire.com/talk/topic/5040-events-fieldtype-inputfield-how-to-make-a-table-fieldtypeinputfield/

  • Like 1

Share this post


Link to post
Share on other sites

@kongondo, this looks great, thanks for making it available!

Will take a closer look soon, but just a (very) minor note at this point: I can't help wondering why the subfields are prefixed with matrix_ -- doesn't honestly matter that much, but I fail to see much value in that either, just slight increase in verbosity compared to non-prefixed alternatives  :)

  • Like 1

Share this post


Link to post
Share on other sites
kongondo, about the way that pagefield shows columns and rows,   i have changed inputfield Matrix.module selector and i have two pagefields one for columns and one for rows, so every time i add a page to pagefield the matrixfield shows the specific page.title. 

the problem is that if matrix_value has a value and delete the pageField with the specific matrix column the cell is not deleted until i clear the value from the specific cell and save the page. 

matrixField.jpg

Share this post


Link to post
Share on other sites

....Will take a closer look soon, but just a (very) minor note at this point: I can't help wondering why the subfields are prefixed with matrix_ -- doesn't honestly matter that much, but I fail to see much value in that either, just slight increase in verbosity compared to non-prefixed alternatives  :)

Thanks @teppo. Yeah, I battled with this one; I am not a fan of such prefixes myself :-). I was trying to avoid collision with MySQL reserved words - row(?), value and column. Funny though that in my tests selectors still work when I drop the 'matrix' prefix...hmm. 

Guys..suggestions for naming the row/column/value  COLUMNS? Maybe:

mrow - mcolumn (or mcol)  - mvalue

OR maybe...

use the PW data COLUMN for 'values' (i.e. intersection/combination cell/value of row vs column), i.e.

$page->product.mrow//rows
$page->products.mcol//columns
$page->products.data//their data/values

Any thoughts? Thanks.

Share this post


Link to post
Share on other sites

@kongondo: had to check, and apparently column is a reserved word, row and value should be fine. Either way, prefixed values make sense after all, no point in having only one prefixed. Also, I kind of prefer matrix_* over m*, and matrix_value over data, so wouldn't chance anything to be honest :)

  • Like 1

Share this post


Link to post
Share on other sites

kongondo, about the way that pagefield shows columns and rows,   i have changed inputfield Matrix.module selector and i have two pagefields one for columns and one for rows, so every time i add a page to pagefield the matrixfield shows the specific page.title. 

the problem is that if matrix_value has a value and delete the pageField with the specific matrix column the cell is not deleted until i clear the value from the specific cell and save the page. 

@sakkoulas,

Does this mean that all the rows and columns that make up your matrix table will have have their corresponding pages displayed in your page fields? It's an interesting idea but would probably not work well (visually) if you have a large table? The list of pages in your page fields could get very long :-)

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 BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      Learn more on my blog
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!