Jump to content
bernhard

RockGrid - powerful, performant and beautiful data listing tool

Recommended Posts

Spoiler

 

On 8/25/2018 at 10:40 PM, dragan said:

I tried it without output buffering and it works normally.

Where is this line 110 ob_start() exactly sitting? Do you use a prepend file? Is it in your basic_page.php template?

Is 

<div><?php $page->rockgrid; ?></div>

right after ob_start() ?

XAMPP here on Windows 8 and PHP 7.1.9, PW 3.0.106

Here: https://gitlab.com/baumrock/FieldtypeRockGrid/blob/master/InputfieldRockGrid.module.php#L110

I created a separate topic for my issue so as not to pollute the module topic.

 

 

Share this post


Link to post
Share on other sites
Spoiler

 

On 8/25/2018 at 10:48 PM, dragan said:

I tried it out now like this:



<div id="rockgriddemo">
  <?php
  $grid = $page->rockgriddemo;
  ob_start();
  echo $grid;
  ob_end_flush();
  ?>
</div>

And everything still works normally. But I haven't used output buffering in a long long time. Not even sure I am using it correctly...

Whoa! This solves the problem for me! Thanks for the unexpected solution 🙂

I hope some PHP guru can explain what is going on here. In any case, either the inputfield module or the documentation needs to be adjusted.

 

 

Share this post


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

<div><?php $page->rockgrid; ?></div>

inside the body

Maybe you are just missing an echo?

<div><?php echo $page->rockgrid; ?></div>

 

  • Like 1
  • Thanks 1

Share this post


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

Maybe you are just missing an echo?


<div><?php echo $page->rockgrid; ?></div>

 

Actually, this was it 😞

I can't believe I wasted 15 hours on this due to a missing echo.

  • Haha 1

Share this post


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

I can't believe I wasted 15 hours on this due to a missing echo.

Don't you use Tracy Debugger? You could have easily done a bd($page->rockgrid) or d($page->rockgrid) and should have seen and been able to debug it quickly.

fhoKV8T.png

PS: Even if you lost 15 hours - the module took many many more to develop so you are still saving loads of hours 😉 

  • Like 1

Share this post


Link to post
Share on other sites

I set up a simple RockGrid example, but see strange things in the backend, see screen capture and JS console errors (ignore the first error). Any idea what could cause this?

rockgrid-screenshot.thumb.gif.8709124de92b2b159e818d0ad5328eb7.gif

rockgrid-js-errors.thumb.PNG.f53d5c1376318188b752ea5375b9f44a.PNG

 

Share this post


Link to post
Share on other sites

Another oddity: I get sometimes 3-4 times the same page listed. Here, instead of showing 1060 pages, I get 2162:

rockgrid-showing-page-multiple-times.thumb.PNG.32751b90db833d76475a514687055733.PNG

My setup:

// example for template "project"
document.addEventListener('RockGridItemBeforeInit', function(e) {
	if(e.target.id != 'RockGridItem_project') return;
	var grid = RockGrid.getGrid(e.target.id);

	var col = grid.getColDef('vertec');
	col.headerName = 'Vertec';

	var col = grid.getColDef('title');
	col.headerName = "Titel";

	var col = grid.getColDef('client_name');
	col.headerName = "Kunde";

  var col = grid.getColDef('year');
  col.headerName = "Erscheinungsjahr";

  var col = grid.getColDef('service');
  col.headerName = "Dienstleistung";

  var col = grid.getColDef('product');
  col.headerName = "Worum geht's?";

  var col = grid.getColDef('project_desc_short');
  col.headerName = "Referenz-Beschreibung";

	// set fixed column width
	var col = grid.getColDef('created');
	col.headerName = grid.js.created;
	col.width = 150;
	col.suppressSizeToFit = true;

	// add coldef plugins (shortcuts for dates, numbers, etc)
	grid.addColDefPlugins({
		created: {name: 'date', format: 'DD.MM.YYYY HH:mm:ss'},
	});
});

document.addEventListener('RockGridItemAfterInit', function(e) {
	if(e.target.id != 'RockGridItem_transactions') return;
	var col;
	var colDef;
	var grid = RockGrid.getGrid(e.target.id);

	// hide one column
	grid.columnApi().setColumnVisible('myhiddencolumn', false);
});
<?php namespace ProcessWire;

// optional: load external asset
$this->rg->assets->add($this->config->paths->siteModules . 'FieldtypeRockGrid/lib/moment.min.js');

// set data for this grid via rockfinder
$this->setData(new RockFinder("template=project, parent=1041, sort=-created, include=all", [
    'title',
    'client_name',
    'vertec',
    'year',
    'service',
    'product',
    'project_desc_short',
    'created',
]));

Looking at the debug infos in getSQL:

SELECT
    `rockfinder`.*
FROM
    /* original pw query */
    (SELECT pages.id 
    FROM `pages` 
    WHERE (pages.templates_id=44) 
    AND (pages.parent_id=1041) 
    GROUP BY pages.id 
    ORDER BY pages.created DESC ) as `pwfinder`

/* rockfinder */
LEFT JOIN (    SELECT
      `pages`.`id` AS `id`,
      `title`.`title` AS `title`,
      `client_name`.`client_name` AS `client_name`,
      `vertec`.`vertec` AS `vertec`,
      `year`.`year` AS `year`,
      `service`.`service` AS `service`,
      `product`.`product` AS `product`,
      `project_desc_short`.`project_desc_short` AS `project_desc_short`,
      `created`.`created` AS `created`
    FROM
      `pages`
    
    /* --- join title --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `title`.`data` AS `title`
    FROM `field_title` AS `title`) AS `title` ON `title`.`pageid` = `pages`.`id`
    /* --- end title --- */
    
    
    /* --- join client_name --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `client_name`.`data` AS `client_name`
    FROM `field_client_name` AS `client_name`) AS `client_name` ON `client_name`.`pageid` = `pages`.`id`
    /* --- end client_name --- */
    
    
    /* --- join vertec --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `vertec`.`data` AS `vertec`
    FROM `field_vertec` AS `vertec`) AS `vertec` ON `vertec`.`pageid` = `pages`.`id`
    /* --- end vertec --- */
    
    
    /* --- join year --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `year`.`data` AS `year`
    FROM `field_year` AS `year`) AS `year` ON `year`.`pageid` = `pages`.`id`
    /* --- end year --- */
    
    
    /* --- join service --- */
    LEFT JOIN (SELECT
      `service`.`pages_id` AS `pageid`,
     `service`.`data` AS `service`
    FROM `field_service` AS `service`
    GROUP BY `service`.`pages_id`, `service`.`data`) AS `service` ON `service`.`pageid` = `pages`.`id`
    /* --- end service --- */
    
    
    /* --- join product --- */
    LEFT JOIN (SELECT
      `product`.`pages_id` AS `pageid`,
     `product`.`data` AS `product`
    FROM `field_product` AS `product`
    GROUP BY `product`.`pages_id`, `product`.`data`) AS `product` ON `product`.`pageid` = `pages`.`id`
    /* --- end product --- */
    
    
    /* --- join project_desc_short --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `project_desc_short`.`data` AS `project_desc_short`
    FROM `field_project_desc_short` AS `project_desc_short`) AS `project_desc_short` ON `project_desc_short`.`pageid` = `pages`.`id`
    /* --- end project_desc_short --- */
    
    
    /* --- join created --- */
    LEFT JOIN (SELECT `id` AS `pageid`, `created` FROM `pages` AS `created`) AS `created` ON `created`.`pageid` = `pages`.`id`
    /* --- end created --- */
    
) AS `rockfinder` ON `pwfinder`.`id` = `rockfinder`.`id`
/* end rockfinder */

imho, I think this is wrong:

    /* --- join title --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `title`.`data` AS `title`
    FROM `field_title` AS `title`) AS `title` ON `title`.`pageid` = `pages`.`id`
    /* --- end title --- */

Well, or any other part of the whole SQL - do you assume every title is necessarily unique? The only unique thing is the page id. Did you run into a similar wrong output, or do I have to adjust my query? (selector)

Share this post


Link to post
Share on other sites

I should have just used my brain. Luckily I am not prone to alcoholism, so this public embarrassment will not lead to pathological results.

Anyway, let's pretend nothing happened last week and move on to the next topic. I noticed the ag-Grid demo has a cool filter, which allows us to use multiple strings. However, when used with RockGrid/PW, it breaks, if the field values include null ones. Long story short, I figured the most inexpensive change perf-wise would be telling PDO to treat nulls as strings. I did the change in RockFinder. Perhaps it would be unwise to include in upstream as some users would expect nulls to stay nulls.

The change in RockFinder.module.php:

public function getObjects($array = null) {
  $timer = $this->timer('getObjects');
  try {
    $this->database->setAttribute(\PDO::ATTR_ORACLE_NULLS, \PDO::NULL_TO_STRING);
    $results = $this->database->query($this->getSql());
    $objects = $results->fetchAll($array ? \PDO::FETCH_ASSOC : \PDO::FETCH_OBJ);
  }

In RockGrid code, there is also a possibility to use sql query as datasource, but I don't see it in the interface. Anyway, in case one would need to use it somehow:

InputfieldRockGrid.module.php:

// sql query as datasource
$this->database->setAttribute(\PDO::ATTR_ORACLE_NULLS, \PDO::NULL_TO_STRING);
$results = $this->database->query($sql);
return $results->fetchAll(\PDO::FETCH_OBJ);

Edit: later I noticed that dealing with the nulls in JS does not seem to affect perf even with a big data set, so I modified the filter example below to just do if (value === null) value = '';

Using the filter from ag-Grid demo in your .js:

document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);

  var col = grid.getColDef('myfield');
  col.headerName = grid.js.myfield;
  col.filter = PersonFilter;
  col.floatingFilterComponent = PersonFloatingFilterComponent;

});

document.addEventListener('RockGridItemAfterInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var col;
  var colDef;
  var grid = RockGrid.getGrid(e.target.id);  
});

function PersonFilter() {
}

PersonFilter.prototype.init = function (params) {
    this.valueGetter = params.valueGetter;
    this.filterText = null;
    this.params = params;    
    this.setupGui();
};

// not called by ag-Grid, just for us to help setup
PersonFilter.prototype.setupGui = function () {
    this.gui = document.createElement('div');
    this.gui.innerHTML =
        '<div style="padding: 4px;">' +
        '<div><input style="margin: 4px 0px 4px 0px;" type="text" id="filterText" placeholder="Multi-string search..."/></div>' +
        '</div>';

    var that = this;
    this.onFilterChanged = function () {
        that.extractFilterText();
        that.params.filterChangedCallback();        
    };

    this.eFilterText = this.gui.querySelector('#filterText');
    this.eFilterText.addEventListener("input", this.onFilterChanged);
};

PersonFilter.prototype.extractFilterText = function () {
    this.filterText = this.eFilterText.value;
};

PersonFilter.prototype.getGui = function () {
    return this.gui;
};

PersonFilter.prototype.doesFilterPass = function (params) {
    // make sure each word passes separately, ie search for firstname, lastname
    var passed = true;
    var valueGetter = this.valueGetter;
    
    this.filterText.toLowerCase().split(" ").forEach(function (filterWord) {
        var value = valueGetter(params);
        if (value === null) value = '';
        if (value.toString().toLowerCase().indexOf(filterWord) < 0) {
            passed = false;
        }
    });

    return passed;
};

PersonFilter.prototype.isFilterActive = function () {
    var isActive = this.filterText !== null && this.filterText !== undefined && this.filterText !== '';
    return isActive;
};

PersonFilter.prototype.getModelAsString = function (model) {
    return model ? model : '';
};

PersonFilter.prototype.getModel = function () {
    return this.eFilterText.value;
};

// lazy, the example doesn't use setModel()
PersonFilter.prototype.setModel = function (model) {
    this.eFilterText.value = model;
    this.extractFilterText();
};

PersonFilter.prototype.destroy = function () {
    this.eFilterText.removeEventListener("input", this.onFilterChanged);
};

function PersonFloatingFilterComponent() { }

PersonFloatingFilterComponent.prototype.init = function (params) {
    this.params = params;
    this.eGui = document.createElement('input');
    var eGui = this.eGui;
    this.changeEventListener = function () {
        params.onFloatingFilterChanged(eGui.value);
    };
    this.eGui.addEventListener('input', this.changeEventListener);
};

PersonFloatingFilterComponent.prototype.getGui = function () {
    return this.eGui;
};

PersonFloatingFilterComponent.prototype.onParentModelChanged = function (model) {
    // add in child, one for each flat
    if (model) {
        this.eGui.value = model;
    } else {
        this.eGui.value = '';
    }
};

PersonFloatingFilterComponent.prototype.destroy = function () {
    this.eGui.removeEventListener('input', this.changeEventListener);
};

 

  • Like 1

Share this post


Link to post
Share on other sites

The blinking is one thing, but why does it also change the number of results (and hence - pages)? I've set my window to height 600px.

Share this post


Link to post
Share on other sites
9 hours ago, dragan said:

I set up a simple RockGrid example, but see strange things in the backend, see screen capture and JS console errors (ignore the first error). Any idea what could cause this?

This happens when you have a grid that tries to show more rows, then adds scrollbars and therefore does not have enough space to show those rows and removes one. Then it tries the same thing again. You can set your grid to a fixed amount of rows. The number of rows in your case do not change. It's only the number of pages that changes (and that's correct of course, if you add/remove one row you'll end up with different page numbers).

 

9 hours ago, dragan said:

Another oddity: I get sometimes 3-4 times the same page listed. Here, instead of showing 1060 pages, I get 2162:

This can happen if you have page fields or repeaters with multiple items. The RockFinder might return those values as joined results with each referenced value in a separate row. Analyze your SQL or your RockFinder and the result itself to see where this comes from. You can comment out some fields of the RockFinder then you see which field causes the number of results to increase to more than you'd expect.

You can either create a different SQL (see the RockFinder docs, or - sorry - look into the code). Another way to prevent such situations is to create a new hidden field that gets populated via saveReady hook and holds the information you need. Eg you create a field "linked_pages" that holds an array of linked pages, eg

[{id:123,title:"demo page1"},{id:456,title:"demo page2"}]

You can then use a cellRenderer to show this information as you want (eg with icons, as comma separated list, as number of linked pages etc.). It might sound complex but it totally makes sense when you build more advanced grids.

Having said that, that's how it works right now. It's not perfect for sure. If you have any suggestions for improvement let me know.

 

9 hours ago, Beluga said:

However, when used with RockGrid/PW, it breaks, if the field values include null ones.

In that case just setup a valueGetter and make sure you return a proper value for all cells. This is how you make sure it is a number (for calculating sums/avg etc):

document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);

  var col = grid.getColDef('yourcolumn');
  col.valueGetter = function(params) {
    if(typeof params.data == 'undefined') return;
    var val = params.data[colDef.field];
    return val*1; // make sure the value is a number and not a string
  }
});

 

7 hours ago, Beluga said:

Another topic: are you able to hide the id column? I tried with the methods in the readme, but I can't make it go away.

Of course you can hide it: https://www.ag-grid.com/javascript-grid-column-definitions/

document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);

  var col = grid.getColDef('id');
  col.hide = true;

  var col = grid.getColDef('title');
  col.headerName = 'MyDemoTitle';
});

aBKM24C.png

 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Cool, thanks for the hiding tip!

Hmm, now that I tested it, changing null to empty in JS does not seem to affect perf in any way. I actually did a quick JS flame graph comparison in Firefox and the relevant call took the same amount of milliseconds either way. So without any PDO hackery, the rockgrid.js PersonFilter.prototype.doesFilterPass in my previous example can be modified like this:

    this.filterText.toLowerCase().split(" ").forEach(function (filterWord) {
        var value = valueGetter(params);
        if (value === null) value = '';
        if (value.toString().toLowerCase().indexOf(filterWord) < 0) {
            passed = false;
        }
    });

Btw. has anyone tried this: https://www.ag-grid.com/javascript-grid-row-height/#auto-row-height

I tested it, but the result was just huge CPU chewing for a while (for a large data set), but row height did not adapt for cells with overflowing content. So simply col.autoHeight = true;

  • Like 1

Share this post


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

This can happen if you have page fields or repeaters with multiple items. The RockFinder might return those values as joined results with each referenced value in a separate row. Analyze your SQL or your RockFinder and the result itself to see where this comes from. You can comment out some fields of the RockFinder then you see which field causes the number of results to increase to more than you'd expect. 

Hi. I'm searching since a couple of days why I get this behavior. I follow your example for pages but it never display with separator (in my picture id=1284 or 1286 or 1290). I have no idea why, maybe an expert eye could spot something.

$finder = new \ProcessWire\RockFinder('template=activite', ['title']); //really simple example
$field =$finder->addField('discipline', ['title']);  
$field->separator = "|";
return $finder->getSQL();

 

image.thumb.png.e3aad3ba80889919d6b8c4d27ba82c9c.png

SELECT
    `rockfinder`.*
FROM
    /* original pw query */
    (SELECT pages.id 
    FROM `pages` 
    WHERE (pages.templates_id=58) 
    AND (pages.status<1024) 
    GROUP BY pages.id ) as `pwfinder`

/* rockfinder */
LEFT JOIN (    SELECT
      `pages`.`id` AS `id`,
      `title`.`title` AS `title`,
      `discipline`.`discipline` AS `discipline`,
      `discipline`.`title` AS `discipline:title`
    FROM
      `pages`
    
    /* --- join title --- */
    LEFT JOIN (SELECT
      `pages_id` AS `pageid`,
      `title`.`data` AS `title`
    FROM `field_title` AS `title`) AS `title` ON `title`.`pageid` = `pages`.`id`
    /* --- end title --- */
    
    
    /* --- join discipline --- */
    LEFT JOIN (SELECT
      `discipline`.`pages_id` AS `pageid`,
     `discipline`.`data` AS `discipline`,
      GROUP_CONCAT(`title`.`data` ORDER BY `discipline`.`sort` SEPARATOR ',') AS `title`
    FROM `field_discipline` AS `discipline`
    LEFT JOIN `field_title` AS `title` ON `title`.`pages_id` = `discipline`.`data`
    GROUP BY `discipline`.`pages_id`, `discipline`.`data`) AS `discipline` ON `discipline`.`pageid` = `pages`.`id`
    /* --- end discipline --- */
    
) AS `rockfinder` ON `pwfinder`.`id` = `rockfinder`.`id`
/* end rockfinder */

Thanks!!

  • Thanks 1

Share this post


Link to post
Share on other sites

Well, over here, when I try to open a page for editing, it never gets loaded. It just keeps on loading.... forever.

PW logs show nothing, same goes for TD.

Share this post


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

Well, over here, when I try to open a page for editing, it never gets loaded. It just keeps on loading.... forever.

I'm quite sure that this has nothing to do with either RockGrid or RockFinder. Please try a clean install and report back if you have any problems. Thanks.

Share this post


Link to post
Share on other sites

Hi @jmartsch thanks for the hint.

Regarding the alpha state: Yes. Still alpha. Whatever that means. I'm using it on several sites in production but I'm still developing things and sometimes change some concepts, so there might be breaking changes in the future. That's why it is alpha and I don't plan to change that, but it's working great for all my scenarios and it's already a huge step forward compared to the old datatables module/library 🙂 

Share this post


Link to post
Share on other sites
On 9/4/2018 at 7:19 PM, bernhard said:

@Beluga working on filters right now and just saw that your example could also be done with the quickfilter: https://www.ag-grid.com/javascript-grid-filter-quick/

maybe that's interesting for you?

Now that I looked into it, it does not seem to do what I need. The example has a separate field that filters all the columns. I couldn't figure out how to make it work so it would act as a "normal" column filter. It seems simpler to just continue using the PersonFilter thing.

Share this post


Link to post
Share on other sites

Ah, ok. Didn't know what you need exactly and thought I'd share it with you. I'll have an update filter-wise for you (and of course everybody else) soon on the dev-branch 😉 

  • Like 1

Share this post


Link to post
Share on other sites

Hey Bernhard, I get an error that moment.js could not be loaded.

Then I found a date.md file which says 

Quote

You need to include `moment.js` to your assets:
```php
$this->rg->assets->add($this->config->paths->siteModules . 'FieldtypeRockGrid/lib/moment.min.js');
```

short note: the name of the module in this file is still RockGrid instead of FieldtypeRockGrid.

So I tried to do this, but now I get an error `Call to a member function add() on null`

What am I doing wrong? Here is my code. I use RockGrid inside of a module:

 $f = $this->modules->get('InputfieldRockGrid');
    $f->rg->assets->add($this->config->paths->siteModules . 'FieldtypeRockGrid/lib/moment.min.js');
    $f->name = 'stats';
    $f->themeBorder = 'none';
    $f->height = 0;
    $f->pageSize = 50; // set initial pagination to 25 rows

    $finder = new RockFinder('template=stelle', ['title', 'created']);
    $field = $finder->addField('mitarbeiterId', ['vorname', 'nachname']);

// $sql = $finder->getSQL();
// $finder->sql = "SELECT id, SUM(value) AS revenue, DATE_FORMAT(date, '%Y-%m') AS dategroup FROM ($sql) AS tmp GROUP BY dategroup";
// d($finder->getObjects());

    $f->setData($finder);

    return $f->render();

 

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