kongondo

Module: Matrix Fieldtype & Inputfield

Recommended Posts

Thanks Adrian!

  1. Modal: CSS: Let me start with this one. I hate CSS...there I said it!  >:(  :-X  :P  :lol: . OK, I don't hate it that much...But this drove me nuts for hours! OK, so PHP has its quirkiness too but goodness, CSS! OK, maybe am not just good at it and debugging it is a pain. The modal is a jQuery UI thing and overriding its defaults caused me more pain than I want to go through again :-)...So, if anyone can send me a PR, please do. Am serious, LoL. It's either this or I go back to browser default alert box (FF's is nice btw, but Chrome, urggh!).
  2. New Rows: Maybe there's two ways around this. In an earlier post I was wondering whether we need to use pages for Row and Column headers/labels (e.g. the Nitrogen, 1987 in your screenshot). In this option, we would let the first column and first row be the row and column headers respectively. That would mean, instead of using those columns (in the db) to store references to page IDs, we would use them to store Row and Column Labels. Alternatively, we could let the user choose whether they want labels to be existing pages or if they want to import custom strings as Row/Column headers.  That would make for easier appending new rows since it wouldn't need the existence of a page. The second option here is to automatically create new row and column pages on import by reading the row/label titles (or checking if that page exists and add it to the matrix if it does). The problem here is if auto-creating new pages, what templates will they use and what page(s) will be their parents.
  3. Ignore first column/row: Makes sense, will look into it -  if you can please submit a separate GitHub feature request, thanks
  4. Checking rows means they will be exported: Good idea, will look into it - if you can please submit a separate GitHub feature request, thanks
  5. Shift+Click: - ditto, thanks
  6. Natural/Normal way of structuring CSV data: I think you misunderstood me/I wasn't clear. This is what I meant. Consider the following data, including the row and column headers as it would appear in Excel:

    A                           B      C     D     E     F    G

1 Peter 35

2 Peter 80Kg

3 Peter $50,000

4 Peter Married

5 Peter Volvo

Mary etc as above

As you can see, the first 5 rows are all about Peter. If you get data like that, normally you would change it so that all of Peter's data is on one row, with the columns each storing one property like so:

            A             B             C             D                           E              F        G

1          Age       Weight   Salary    Marital Status   Vehicle

2 Peter 35         80 kg     $50,000   Married                Volvo

3 Mary  etc....

So, whilst example 1 would have better worked for finding out what was 'null', it is not the normal way of organising data. Anyway, it's not important now, since you meant something totally different by 'append'.

  • Like 1

Share this post


Link to post
Share on other sites

I hate CSS too - not my strong point, that's for sure! Given that the PW core uses the brower's alert box, I wouldn't bother struggling with it too much. It might be nice if PW had it's own consistent alert (like the pw-modal that we have for modals), but I don't think you should put too much effort into overriding the browser in this case.

New Rows: Maybe there's two ways around this. In an earlier post I was wondering whether we need to use pages for Row and Column headers/labels (e.g. the Nitrogen, 1987 in your screenshot). In this option, we would let the first column and first row be the row and column headers respectively. That would mean, instead of using those columns (in the db) to store references to page IDs, we would use them to store Row and Column Labels. Alternatively, we could let the user choose whether they want labels to be existing pages or if they want to import custom strings as Row/Column headers.  That would make for easier appending new rows since it wouldn't need the existence of a page. The second option here is to automatically create new row and column pages on import by reading the row/label titles (or checking if that page exists and add it to the matrix if it does). The problem here is if auto-creating new pages, what templates will they use and what page(s) will be their parents.

For my purposes, I don't think I would want what you are suggesting because an incorrectly prepared CSV file could damage my site by adding additional years and indicators (nitrogen etc). The indicators are actual pages that have their own content, so I think it is important that site editors make a conscious decision first to add a new indicator which will then automatically appear in the Matrix field. This is the reason I am using Matrix and not Table - the automatic population and new indicators and years.

Natural/Normal way of structuring CSV data: I think you misunderstood me/I wasn't clear. This is what I meant. Consider the following data, including the row and column headers as it would appear in Excel:

Yes, I didn't see your initial point - sorry, but I also think that trying to deal with that is getting too complicated :)

Share this post


Link to post
Share on other sites

I was talking about appending new rows. In my current use case, each year there will be a new "year" row that will appear in the matrix. I would like users to potentially be able to import a CSV of the data for that row. Of course importing for one row may not be worth the effort, but in some cases I can have up to 20 columns, so it might just be worth it. In that case, I would want "import" to just append the new row to the blank year that is in the matrix table.

Reading this line again, if we are not CREATING new rows per se (i.e. not creating new row/column pages) but appending starting from the first AVAILABLE BLANK row, that is doable and is how I was thinking originally, before I managed to confuse myself trying to figure out what exactly you meant by append :-). In that case, the users will have to ensure that a blank row exists before attempting an 'append import'. If at least one blank row exists, that row will be populated and any other subsequent blank rows as well as long as there are still other rows of data in the imported CSV. As usual, any extraneous rows and columns will be discarded (nothing to import to). Hmm, need to see which is easier; using PHP to find the first blank row or using jQuery/JavaScript to read the matrix client-side and get the first blank row and send that with the submitted form :-). Happy days. As for your users creating new blank rows every year, am sure you can work that out :-).

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

Ah yes - perhaps I should have said: "populate blank rows" vs "overwrite all existing rows", instead of append/overwrite.

Sorry for all the confusion, but I think we are on the same wavelength now :)

Yes - creating a new blank row for each year is easy - I have a "Years" parent page and they simply create a new year under that as required - well actually it is done using Batch Child Editor and the child pages are hidden to avoid confusion.

Thanks again!

Share this post


Link to post
Share on other sites

Just a quick thought on the "Note: Empty values will be saved" message - I am not sure that this is helpful to site editors, and may even be confusing!

Maybe it is something that doesn't need to be displayed, or maybe just for superusers?

Thanks!

Share this post


Link to post
Share on other sites

OK..What about an overwrite versus append message?

I think it is important that the user knows what is about to happen regarding appending vs overwriting for sure. Are you going to make the behaviour configurable in the import section settings?

Share this post


Link to post
Share on other sites

Append vs Overwrite is configurable at both field (we set a default import mode [superuser]) and page (import section settings [page editor]; here we override the default) level. If no default has been set by superuser, it defaults to append. In addition to the note above the matrix table, if in append mode, the last blank row is highlighted, just a little visual reminder about what's about to happen if they hit save. The append note also tells the user that if a last blank row happens to have other non-blank rows beneath it, the imported values will be saved starting from the last blank row and overwrite any rows below it. If they want to avoid this, users need to make sure that the last blank row is always the last matrix table row. Thought about a pop-up warning the user instead (that there are populated rows beneath the last blank row) but didn't pursue the idea, putting the onus on the editor instead. It would mean getting the pop-up if they hit save, even for other reasons (e.g saving other fields on the page). Alternatively, we could have a separate 'save matrix' button, but that is probably complicating things. 

Share this post


Link to post
Share on other sites

Append vs Overwrite is configurable at both field (we set a default import mode [superuser]) and page (import section settings [page editor]; here we override the default) level. If no default has been set by superuser, it defaults to append. In addition to the note above the matrix table, if in append mode, the last blank row is highlighted, just a little visual reminder about what's about to happen if they hit save. The append note also tells the user that if a last blank row happens to have other non-blank rows beneath it, the imported values will be saved starting from the last blank row and overwrite any rows below it. If they want to avoid this, users need to make sure that the last blank row is always the last matrix table row. Thought about a pop-up warning the user instead (that there are populated rows beneath the last blank row) but didn't pursue the idea, putting the onus on the editor instead. It would mean getting the pop-up if they hit save, even for other reasons (e.g saving other fields on the page). Alternatively, we could have a separate 'save matrix' button, but that is probably complicating things. 

Are these new settings? I am running the latest from the dev branch and don't see these settings - am I being dumb? It's been a long week!

post-985-0-86645100-1446630559_thumb.png

post-985-0-36726200-1446630626_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

Also, what about an API method to create data - it would be nice to make it easier to create an import routine from an existing database.

You mean something more elaborate than this (which has always been possible btw)?

$p = $pages->get(1091);
$p->of(false);
$matrix = new Matrix();
$matrix->row = 1060;
$matrix->column = 1073;
$matrix->value = "This is my value";
$p->results->add($matrix);
$p->save('results');
$p->of(true);

  • Like 2

Share this post


Link to post
Share on other sites

Yeah, I was talking about the ability to import a CSV via the API - perhaps like I did with the TableCSVImportExport:

http://modules.processwire.com/modules/table-csv-import-export/

$modules->get('TableCsvImportExport'); // load module // data, delimiter, enclosure, convert decimals, ignore first row, multiple values separator, append or overwrite 
$page->fields->tablefield->importCsv($csvData, ',', '"', false, true, ',', 'append');

Share this post


Link to post
Share on other sites

Update version 1.0.4 (Dev only for now)
 
Note: Haven't had time to update README
 
Changes

  1. Import Mode for file/copy-pasted CSV: Two options, 'append' and 'overwrite'. Default setting set in Field's Details tab. The setting can be overridden at page-edit level. Default setting is append (sorry guys, you will have to inform your clients of the changes. The prospect of data loss inherent in the overwrite mode outweighed the inconvenience of re-teaching your clients about the new default append mode).
    1. Append: In this mode, the module will look for the last available empty/blank row in the matrix. If it finds one, imported rows will be inserted from that point forward. Any subsequent rows (i.e. rows beneath that 'last blank row') will be overwritten. Any rows above the 'last blank row' will have their values preserved (untouched). When in append mode, the 'last blank row' will always be highlighted. The modules (jQuery) monitors any live changes to the table rows (typing and clear data) and the highlight will shift accordingly if the 'last blank row' changes. If there is no 'last blank row' and you attempt to save in this mode, you will get an PW error message and your older values will be preserved in the matrix. Used wisely, append can actually mimic an insert. Btw, for an empty matrix, append doesn't make much sense since data will only be inserted in the very last row of the matrix :-).
    2. Overwrite: What was the default behaviour; incoming values overwrite existing values.
  2. Ignore first row and/or column: Default set independently at Field setting (i.e. can ignore one but not the other if you wish). Default is ignore both first row and column. Both settings can be independently by-passed at page-edit level. In real world examples, first rows usually store column headers/labels and first columns usually store row headers/labels.
  3. Export checked rows: You can now export only the rows you want by checking them. If nothing is checked and you attempt to export you will get a JS error alert. The 'set range to export' setting became redundant and I removed it.
  4. Shift + Click enables the selection of a range of rows. The checkbox for toggling select all still works.
  5. Lots of code re-factoring

Thanks to @adrian for suggesting all of the above features ^-^.

Please test and let me know.

I think I have given this module enough love for now. MenuBuilder has refused to talk to me until the situation improves. So, for now, there's a feature freeze on this one and let's see if I can get MenuBuilder to smile again  :lol:  :P .

post-894-0-72496200-1446755440_thumb.png

Edited by kongondo
Added screenshot
  • Like 3

Share this post


Link to post
Share on other sites

Beautiful work!

I think I might have said this just recently to some of your other new features, but it is true - this has become one of my favourite field types. 

Now go spend some time on some of those commercial modules you have cooking :)

  • Like 1

Share this post


Link to post
Share on other sites

I have been hooked on it! And I've learnt some fun jQuery stuff along the way. Btw, didn't have time to test with non-superuser account + thoroughly check if 'append' caused any performance issues..Seemed there was a slight (milliseconds) delay when I added the feature. Maybe I just need some sleep  :P .

Share this post


Link to post
Share on other sites

Hey kongondo - small bug for you. When editing a page in a modal window - eg through Lister, the Export Data button is ending up at the bottom of the modal.

post-985-0-50390800-1446848568_thumb.png

The PW modal code grabs some buttons and forces them to be in the footer, but I am not sure why "export data" is ending up there, but "clear data" isn't - likely a class that has been applied to the export button - but I haven't investigated.

Thanks!

Share this post


Link to post
Share on other sites

Hey kongondo,

I have noticed an issue when using unpublished or hidden pages.

Here is my scenario. I am using this custom php code as the row selector:

return $pages->find("parent=/report-cards/{$page->parent->parent->name}/years/, sort=sort, include=all");

The "include=all" ensures that even though the latest year is unpublished (we are currently adding data and it's not ready to be live yet), we still see that year as a row in the matrix table. 

The problem is this line: https://github.com/kongondo/FieldtypeMatrix/blob/master/InputfieldMatrix.module#L439

//remove matrix-rows that are no longer needed i.e. 'unpublished', 'hidden', 'deleted' or 'trashed'
if(!$rp || $rp->is(Page::statusUnpublished) || $rp->isHidden() || $rp->isTrash()) continue;

Even though data is saved to the db, that line prevents it from being displayed in the matrix table - you enter and save, but it appears blank.

For my needs I have commented this line and it seems to be working fine. I am not sure of the best fix - perhaps this line is simply not necessary or maybe it needs to be an option?

The same issue occurs with columns as well.

Please let me know if I haven't explained properly or if you have any other questions.

Thanks!

Share this post


Link to post
Share on other sites

Hi adrian,

I think the original idea was to avoid displaying and saving data that was 'no longer there/invalid', aka, that page is not reachable. But maybe I should have limited this to trashed pages only. I like your idea about making this configurable. Definitely I'll still exclude trashed pages but will make displaying of 'unpublished' and 'hidden' rows and columns configurable (not sure as one choice or two options [i.e. the page statuses as choices])  but separately for rows and columns .The default (for backward compatibility) will be to exclude such pages. Hope it makes sense (typing quickly...)...

Edited by kongondo
typos, etc
  • Like 1

Share this post


Link to post
Share on other sites

Just announcing that I've tested and can confirm that Matrix is compatible with ProcessWire 2.8.x and ProcessWire 3.x

  • Like 4

Share this post


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

Just announcing that I've tested and can confirm that Matrix is compatible with ProcessWire 2.8.x and ProcessWire 3.x

Just to add to your testing, I can confirm that I have been using this awesome module with 3.x for probably 6 months now without any problems!

  • Like 4

Share this post


Link to post
Share on other sites

Hey @kongondo - when adding via the API, eg:

$matrix = new Matrix();
$matrix->row = 1060;
$matrix->column = 1073;
$matrix->value = "This is my value";
$p->results->add($matrix);
$p->save('results');

is there a recommended way to overwrite existing rows? At the moment doing this when the cells are already populated results in duplicated entries in the "field_matrixfield" db table. Obviously only one set is shown when editing the field on a page in the backend, but I am worried about consistency of what will be returned (backend and frontend) and of course just wasted db space and data integrity. I am thinking that the easiest option might be to just remove the entries manually with a raw SQL statement before adding the matrix row.

Any thoughts?

Thanks!

Share this post


Link to post
Share on other sites

Hi @adrian,

Good catch. Yes, raw SQL would be the way to go. I'm still mulling and testing most efficient way to go about this. 

 

  • Like 1

Share this post


Link to post
Share on other sites

Hey @kongondo - I just went to export for the first time and noticed that all I get is the first column entitled "Row Label". Is there something I am missing, or is this a bug?

I need this pretty urgently (actually immediately), so I am going to take a look and see what I can figure out, but in case you happy to be online and have an idea for a solution, or something I am missing, that would be great :)

Share this post


Link to post
Share on other sites

Ok, I figured it out and have a quick fix in place. It was a multi-language issue.

This is my quick fix - to get the default row and column titles, rather than returning a title object.

			//prepare export values
			foreach($rows as $row) {
				$rowTitle = $row->title->getLanguageValue("default");
				//only export selected rows
				if(!in_array($row->id, $rowsChecked)) continue;

				foreach($columns as $column) {
					$columnTitle = $column->title->getLanguageValue("default");
					//get each matrix value at given coordinates (WireArray)
					$v = $values->get("rowLabel=$rowTitle, columnLabel=$columnTitle");
					$value = $v ? $v->value : '';//force blank values export
					$exportMatrix[$row->id][$this->_('Row Label')] = $rowTitle;
					$exportMatrix[$row->id][$columnTitle] = $value;
				}
			}

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

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?

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!