Jump to content
bernhard

RockGrid - powerful, performant and beautiful data listing tool

Recommended Posts

Crud will not be that easy. It's easier to open pages in a panel via the regular PW page editor. Linking the page title is very easy using cell renderers. See the aggrid docs.

  • Like 1

Share this post


Link to post
Share on other sites

I've been looking into External filter. There is a problem, though: rockgrid.js gets loaded in the head element, so we cannot use an external element rendered outside rockgrid.js. I am having trouble figuring out how I should go about using and rendering markup that goes outside the grid in rockgrid.js. Or should I just modify things so that rockgrid.js loads at the end of the document?

Share this post


Link to post
Share on other sites

Sorry @Beluga but I don't understand your question. What is the exact szenario? What is the exact problem? You have all the aggrid api available with all your RockGrids. The most important events are BeforeInit and AfterInit, then you have your RockGrid instances available for any further actions.

d3vecEG.png

Share this post


Link to post
Share on other sites

The idea is to have an additional dropdown to filter the items. It is not possible to have two filters in the same column, so I have to use the external filter feature. Thanks for nudging me in the right direction. I include a minimised version of my current code.

When I started writing this reply, I was stuck, but I continued banging my head against the wall. Now I have a solution, where the dropdown completely overrides the smart filter. This might actually be useful, as then you can filter further (by typing) the already filtered content, but I should turn it off by default and include a checkbox to control it.

Something that I don't understand is: why do I have to have both onchange="" in the select element and the addEventListener for the thing to work? I hope it will not be troublesome to create the checkbox solution to control the listener (tips welcome, I'm taking a break).

Edit: I added a checkbox and tied the isExternalFilterPresent function to it and now it is perfect to me!

document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);
  grid.gridOptions.isExternalFilterPresent = isExternalFilterPresent;
  grid.gridOptions.doesExternalFilterPass = doesExternalFilterPass;
  
  var col = grid.getColDef('code');
  col.headerName = grid.js.code;

  var col = grid.getColDef('variation');
  col.headerName = grid.js.variation;

  col.filter = RockGrid.filters.smart;
  col.floatingFilterComponent = RockGrid.filters.smartFloating;

});

var grid = null;
var eFilterText = null;
var dropcheck = null;

document.addEventListener('RockGridItemAfterInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var col;
  var colDef;
  grid = RockGrid.getGrid(e.target.id);
  grid.setColumns(['code', variation]);
  var selectoptions = '';
  // let's build the select element and its options by using a pre-populated object
  // with key:value pairs like A1a:"water and fire as natural elements"
  var codeskey = Object.keys(codesarray);
  Object.values(codesarray).forEach(function(item, index) {
      selectoptions += '<option value="' + codeskey[index] + '">' + item + '</option>';
  });
  var dropgui = document.createElement('div');
  dropgui.innerHTML = '<select id="filterText" onchange="externalFilterChanged(eFilterText, grid)">' + selectoptions + '</select><input id="dropcheck" type="checkbox" onchange="externalFilterChanged(eFilterText, grid)" />';
  e.target.prepend(dropgui);

  dropcheck = document.getElementById('dropcheck');
  eFilterText = document.getElementById('filterText');
  eFilterText.addEventListener("change", externalFilterChanged(eFilterText, grid));
});

var filterText = null;

// dropdown filter is present, if the checkbox is checked
function isExternalFilterPresent() {
  return (dropcheck !== null && dropcheck.checked);
}

// this is given a rowNode by ag-Grid
function doesExternalFilterPass(node) {
  var passed = true;  
  var filterWord = filterText.toLowerCase();
  var value = node.data.code;
  if (value === null) value = '';
  if (value.toString().toLowerCase().indexOf(filterWord) < 0) {
      passed = false;
  }
    
  return passed;
}

function externalFilterChanged(eFilterText, grid) {
  filterText = eFilterText.options[eFilterText.selectedIndex].value;
  grid.gridOptions.api.onFilterChanged();
}

 

Share this post


Link to post
Share on other sites

Glad my answer helped you somehow. I don't have time to look into that in detail. You can have a look at how I built the smartfilter. It's a 100% custom filter and you can build your very own filter as well.

I'd be happy to help you if you are building something like the https://www.ag-grid.com/javascript-grid-filter-set/ , because that's definitely something others (including me) would benefit of.

You might also want to use my debounce function so that the filter does not fire on every single key press.

Share this post


Link to post
Share on other sites
1 hour ago, Beluga said:

It is not possible to have two filters in the same column, so I have to use the external filter feature.

BTW: My smart filter does already support multiple filters (AND and OR)

>50 <100

would list all items that are above 50 and below 100

ber bau

would find Bernhard Baumrock, but not "Bernhard Muster"

bernhard | beluga

would find both "Bernhard Baumrock", "Bernhard Muster" AND "beluga"

 

PS: So maybe you could just create a custom button wherever you want that sets my smart filter to one of those options. Even Regex is possible.

Share this post


Link to post
Share on other sites

Just pushed v0.0.14 to github - caution, there is a BREAKING CHANGE (but a small one 😉 )

Initially I implemented a concept of column definition plugins to reuse column modifications ( for example you almost always want icons to show/edit/delete the row instead of showing the page id). Now that works with helper functions that are available through the RockGrid.colDefs object (and you can of course extend that with your own helper functions).

It's easy to create those functions:

document.addEventListener('RockGridReady', function(e) {
  RockGrid.colDefs.fixedWidth = function(col, width) {
    col.width = width || 100;
    col.suppressSizeToFit = true;
    return col;
  };
});

And using them is a lot easier than before:

// before
grid.addColDefPlugins({
	id: 'rowactions',
});

var col = grid.getColDef('id');
col.headerName = 'ID';
col.width = 70;
col.suppressSizeToFit = true;
col.suppressFilter = true;
col.pinned = 'left';


// after
var col = grid.getColDef('id');
col = RockGrid.colDefs.rowActions(col);
col.pinned = 'left';

It will replace your ID with those icons:

1kkWfRA.png

 

There are plugins available to add your custom actions to that column (or any other column) and you can even combine those plugins:

  col = grid.getColDef('title');
  col = RockGrid.colDefs.fixedWidth(col, 100);
  col = RockGrid.colDefs.addIcons(col, [{
    icon: 'file-pdf-o',
    cls: 'pw-panel',
    dataHref: function(params) {
      if(!params.data.pdfs) return;
      var pdfs = params.data.pdfs.split(',');
      if(!pdfs.length) return;
      return '/site/assets/files/' + params.data.id + '/' + pdfs[pdfs.length-1];
    },
    label: function(params) {
      return 'show invoice PDF ' + params.data.id;
    },
  }]);

 

  • Like 2

Share this post


Link to post
Share on other sites

I solved my external filter setup with a checkbox (edited the original code block with the changes) and I am happy! I can create a series of screenshots during the weekend to illustrate how it works 🙂

  • Like 1

Share this post


Link to post
Share on other sites

The latest version makes it possible to put your rockgrid files in a custom directory. That's handy (necessary) when you are developing modules that ship with rockgrids. A processmodule would be as simple as that:

  /**
   * manage all lists
   */
  public function executeLists() {
    $form = $this->modules->get("InputfieldForm");

    $form->add([
      'type' => 'RockGrid',
      'name' => 'lists',
      'assetsDir' => __DIR__."/grids",
    ]);
    
    return $form->render();
  }

 

  • Like 1

Share this post


Link to post
Share on other sites

Here is how I do linkifying, any tips for improvements or alternatives welcome:

In rockgrid.php I include 'name' as a column, but then in RockGridItemAfterInit I do grid.setColumns(['code', 'variation']); to make it hidden.

I have these to get the urls I want:

var url = document.URL;
// URL API's origin gets us a href of the hostname without the trailing slash (does not work with IE11)
var domain = new URL(url).origin;

For the 'variation' column I have a cellRenderer to link to the children of the page using the 'name' column data:

col.cellRenderer = function(params) {    
  if(params.value !== null) {
  return '<a href="' + url + params.data.name + '">' + params.value + '</a>';
  }
}

For the 'code' column I have a valueGetter to pull the human-readable name for the category from a JS object and stick it after the code. Then I use a cellRenderer to link the text to anywhere I want:

// let's combine the code with its meaning
col.valueGetter = function(params) {    
  return params.data.code + ' ' + codesarray[params.data.code];
}
col.cellRenderer = function(params) {    
  return '<a href="' + domain + '/clas2/">' + params.value + '</a>';
}

 

Share this post


Link to post
Share on other sites

Glad to see RockGrid in action, thx for the screenshots 🙂

21 minutes ago, Beluga said:

Here is how I do linkifying, any tips for improvements or alternatives welcome:

What kind of improvements do you mean? Only thing I can think of is that you use ActionIcons for that. You can add them before or after the cell content. And you can show them always or only on hover:

aggrid.gif.4989549327d0e551355ce20bb2af66b3.gif

Sample code is some posts above, see RockGrid.colDefs.addIcons()

PS: On non-fixed-width columns it's better to add icons BEFORE so that they are still visible even if the cell has more content than can be displayed.

 

Share this post


Link to post
Share on other sites

Pushed v0.0.16: Now you can also set a custom assets folder in the field's config:

w76z3Wn.png

Share this post


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

What kind of improvements do you mean?

Those kinds that I can't think of before I hear them 🙂

  • Haha 1

Share this post


Link to post
Share on other sites

I am having trouble with events. In my RockGridItemAfterInit block I have

grid.gridOptions.onFilterChanged = afterFilter();

Then outside it the function

function afterFilter() {
    console.info("filter changed");
}

The function fires exactly once - when the grid is initialised. It does not fire when the filters are changed.

If I instead use

grid.gridOptions.api.addEventListener('filterChanged', afterFilter());

It fires when the grid is initialised and when I change a filter, I get this in the console (the first time, on further tries I get nothing):

TypeError: t is not a function ag-grid.min.js:26:2395
    p</e.prototype.dispatchToListeners/</< http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2395
    p</e.prototype.flushAsyncQueue/< http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2814
    forEach self-hosted:262:13
    p</e.prototype.flushAsyncQueue http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2785
    <anonymous> self-hosted:973:17

What am I doing wrong?

Share this post


Link to post
Share on other sites

Sorry, I can't provide free support here for such specific problems atm. You might try to search the repository for "filterchanged" and see how I use it in different occations,

yVzw9X0.png

  • Thanks 1

Share this post


Link to post
Share on other sites

Thanks for the free support 😉 I got it working with the syntax

grid.gridOptions.api.addEventListener('filterChanged', function() { afterFilter() });

This allows me to pass the grid object to afterFilter and then do interesting stuff with grid.gridOptions.api.getModel().rootNode.childrenAfterFilter

I am going to mess around with dynamic charting!!

  • Like 1

Share this post


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

I am going to mess around with dynamic charting!!

Glad you got it working, seems you start having fun using it? 😉 What chart library are you using?

Share this post


Link to post
Share on other sites

The new concept of function for manipulating the columns really makes sense and is great to work with 🙂 Whenever you create useful coldef functions please let me know - maybe others can also benefit from it. Here is one new that I just added:

RockGrid.colDefs.yesNo()

Here a simple example showing the status of an E-Mail (sent yes or no):

  col = grid.getColDef('rockmailer_sent');
  col = RockGrid.colDefs.yesNo(col, {headerName: 'Status'});

l8Woi3J.png

And here a "more complex" example that splits a page reference field with a list of IDs and returns true if a page is part of that list and false if is not:

    col = RockGrid.colDefs.yesNo(col, {
      headerName: grid.js.listtitle,
      isYes: function(val) {
        if(!val) return false;
        val = val.split(",");
        return val.indexOf(String(grid.js.list)) > -1 ? true : false;
      }
    });

nGKWtt4.png 

  • Like 1

Share this post


Link to post
Share on other sites
On 11/4/2018 at 3:53 PM, bernhard said:

Glad you got it working, seems you start having fun using it? 😉 What chart library are you using?

I am using ApexCharts.js, which is kind of a spiritual successor to Chartist.js in that they both produce SVG charts. I am experimenting with what is possible, trying to figure out visualisations of the data that would be useful and attractive.

Here is a screenshot of ApexCharts playing together in real time with RockGrid filtering (edit: nevermind the incorrect/repeating data labels, I only noticed and corrected later):

a-t-chart.thumb.png.2234eb32c3e17f2f78e752e81327936b.png

We see a stacked bar chart representation of the number of literature references per filtered proverb type. I intend to split the thing into separate charts for each of the 13 top level categories (ApexCharts unfortunately does not support multiple series of stacked bars in a single chart). This will make it readable even with the unfiltered view of all 325 proverb types.

It was quite convoluted to get the libraries to play together - grid.gridOptions.api.getModel().rootNode.childrenAfterFilter did not want to yield its contents, but guarded it like a jealous dragon. To get access to the data, I had to brute-force dispatch an input event like so:

  var inputTarget = document.querySelector('.ag-floating-filter-full-body:first-child input');
  var inputEvent = new Event('input', {'bubbles': true, 'cancelable': true});
  // have to use delta timing to delay the input event - in
  // case of big existing CPU load, it will fire too soon!
  var start = new Date().getTime();
    setTimeout(function() {
    var now = new Date().getTime(), delta = now-start;
    inputTarget.dispatchEvent(inputEvent);
    },500);

Then, to initialise the Apex chart in proper order, I had to wrap its stuff into a function. I called the function from my afterFilter:

function afterFilter(grid) {
    var filterKids = grid.gridOptions.api.getModel().rootNode.childrenAfterFilter;
    var mapCodes = filterKids.map(x => x.data.code);
    var countedCodes = mapCodes.reduce((r,k)=>{r[k]=1+r[k]||1;return r},{});
    apexseries = Object.entries(countedCodes).map(([p, v]) => ({'name':p, 'data':[v]}));
    var apexdiv = document.querySelector("#chart");
    if(!apexdiv.hasChildNodes()) { apexi(); } else { ApexCharts.exec('proverbs', 'updateSeries', apexseries); }
}

 

  • Like 1

Share this post


Link to post
Share on other sites

Awesome to see that, need to look at that library as I've never heard about it...

30 minutes ago, Beluga said:

It was quite convoluted to get the libraries to play together - grid.gridOptions.api.getModel().rootNode.childrenAfterFilter did not want to yield its contents, but guarded it like a jealous dragon. To get access to the data, I had to brute-force dispatch an input event like so:

I've built a function to get data instantly very easily - have a look at the pluck() function in RockGridItem.js; It works similar to jQuery Datatables library that I've used before. And I found getting data there quite easier than with aggrid. That's why I built a similar replacement.

See this example where I can select selected or filtered items:

kMG8EFm.png


    // get items
    var rockmailer_to = $('input[name=rockmailer_to]:checked').val();
    var items;
    var testmail = false;
    if(rockmailer_to == 'selected') items = grid.pluck('id', {selected: true});
    else if(rockmailer_to == 'filtered') items = grid.pluck('id', {filter: true});
    else {
      // custom test address
      var testmail = $('#Inputfield_rockmailer_test').val();
      if(!testmail) {
        ProcessWire.alert('You need to specify a Test-Mail-Address!');
        return;
      }
      items = [testmail];
      testmail = true;
    }
    if(!items.length) ProcessWire.alert('No items selected/filtered');

 

Wow @Beluga just had a look at apex charts and that looks fantastic! I was short before creating a module for chartjs but then quite a lot of client work popped in... I'd be very happy to assist you in creating a charting module that plays well together with RockGrid, so if you are interested please drop me a line via PM 🙂 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

v18 adds a plugin that can sync page fields with rockgrid columns:

Example Setup

Adding the asm in a processmodule. $fs is a fieldset where we add our InputField to. $gridname is the name of the grid that is connected.

    // which lists to show
    $this->wire->config->scripts->append($this->wire->urls($this) . "scripts/manageLists.js");
    $fs->add([
      'type' => 'InputfieldAsmSelect',
      'name' => 'listsToShow',
      'label' => __('Show list membership for...'),
      'attr' => ['data-grid' => $gridname],
      'asmOptions' => ['sortable'=>false],
    ]);
    $f = $fs->getChildByName('listsToShow');
    $f->setAsmSelectOption('sortable', false);
    foreach($pages->get('template=rockmailer_lists')->children as $item) {
      $f->addOption($item->id, $item->title);
    }

And the portion of the javascript file:

// sync ASM field with displayed lists in grid
// attach event listener when document is ready
$(document).ready(function() {
  var $select = $('#Inputfield_listsToShow');
  var colPrefix = 'rockmailer_list_';
  
  RockGrid.plugins.syncAsmSelect({
    asm: $('#Inputfield_listsToShow'),
    grid: RockGrid.getGrid($select.data('grid')),
    colName: function(pageId) { return colPrefix + pageId; },
    colDef: function(col) {
      col = RockGrid.colDefs.yesNo(col, {
        isYes: function(params) {
          var pageId = String(params.column.colId).replace(colPrefix, '');
          var lists = String(params.data.rockmailer_lists).split(',');
          return lists.indexOf(pageId) > -1 ? true : false;
        }
      });
      col.pinned = 'left';
      return col;
    }
  });
});

In this case we set a custom callback to modify the colDef for the column. It uses the yesNo plugin to show icons instead of true/false values:

screenshot

  • Like 4

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.4.2
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Robin S
      Sanitizer EasySlugger
      Allows the use of the EasySlugger library as Sanitizer methods.
      Installation
      Install the Sanitizer EasySlugger module.
      Usage
      The module adds four new sanitizer methods.
      slugger($string, $options)
      Similar to $sanitizer->pageName() - I'm not sure if there are any advantages over that method. Included because it is one of the methods offered by EasySlugger.
      $slug = $sanitizer->slugger('Lorem Ipsum'); // Result: lorem-ipsum utf8Slugger($string, $options)
      Creates slugs from non-latin alphabets.
      $slug = $sanitizer->utf8Slugger('这个用汉语怎么说'); // Result: zhe-ge-yong-han-yu-zen-me-shuo seoSlugger($string, $options)
      Augments the string before turning it into a slug. The conversions are related to numbers, currencies, email addresses and other common symbols.
      $slug = $sanitizer->seoSlugger('The price is $5.99'); // Result: the-price-is-5-dollars-99-cents See the EasySlugger readme for some more examples.
      seoUtf8Slugger($string, $options)
      A combination of utf8Slugger() and seoSlugger().
      $slug = $sanitizer->seoUtf8Slugger('价钱是 $5.99'); // Result: jia-qian-shi-5-dollars-99-cents $options argument
      Each of the methods can take an $options array as a second argument.
      separator (string): the character that separates words in the slug. Default: - unique (bool): Determines whether a random suffix is added at the end of the slug. Default: false $slug = $sanitizer->utf8Slugger('这个用汉语怎么说', ['separator' => '_', 'unique' => true]); // Result: zhe_ge_yong_han_yu_zen_me_shuo_3ad66c4  
      https://github.com/Toutouwai/SanitizerEasySlugger
      https://modules.processwire.com/modules/sanitizer-easy-slugger/
    • By Robin S
      If you've ever needed to insert links to a large number of files within CKEditor you may have found that the standard PW link modal is a somewhat slow way to do it.
      This module provides a quicker way to insert links to files on the page being edited. You can insert a link to an individual file, or insert an unordered list of links to all files on the page with a single click.
      CKEditor Link Files
      Adds a menu to CKEditor to allow the quick insertion of links to files on the page being edited.

      Features
      Hover a menu item to see the "Description" of the corresponding file (if present). Click a menu item to insert a link to the corresponding file at the current cursor position. The filename is used as the link text. If you Alt-click a menu item the file description is used as the link text (with fallback to filename if no description entered). If text is currently selected in the editor then the selected text is used as the link text. Click "* Insert links to all files *" to insert an unordered list of links to all files on the page. Also works with the Alt-click option. Menu is built via AJAX so newly uploaded files are included in the menu without the page needing to be saved. However, descriptions are not available for newly uploaded files until the page is saved. There is an option in the module config to include files from Repeater fields in the edited page. Nested Repeater fields (files inside a Repeater inside another Repeater) are not supported. Installation
      Install the CKEditor Link Files module.
      For any CKEditor field where you want the "Insert link to file" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "LinkFilesMenu" to the "CKEditor Toolbar" settings field.
       
      http://modules.processwire.com/modules/cke-link-files/
      https://github.com/Toutouwai/CkeLinkFiles
    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate a repeater item from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
×
×
  • Create New...