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
      After forgetting the class name of the wonderful AdminPageFieldEditLinks module for what feels like the 100th time I decided I needed to give my failing memory a helping hand...
      Autocomplete Module Class Name
      Provides class name autocomplete suggestions for the "Add Module From Directory" field at Modules > New.
      Requires ProcessWire >= v3.0.16.
      Screencast

      Installation
      Install the Autocomplete Module Class Name module.
      Configuration
      Choose the type of autocomplete options list: "Module class names from directory" or "Custom list of module class names". The latter could be useful if you regularly install some modules and would prefer a shorter list of autocomplete suggestions. The list of class names in the modules directory is generated when the Autocomplete Module Class Name module is installed. It doesn't update automatically (because the retrieval of the class names is quite slow), but you can use the button underneath when you want to retrieve an updated list of class names from the directory. The "fuzzy search" option uses custom filter and item functions for Awesomplete so that the characters you type just have to exist in the module class name and occur after preceding matches but do not need to be contiguous. Uncheck this option if you prefer the standard Awesomplete matching. Custom settings for Awesomplete can be entered in the "Awesomplete options" field if needed. See the Awesomplete documentation for more information.  
      https://github.com/Toutouwai/AutocompleteModuleClassName
      https://modules.processwire.com/modules/autocomplete-module-class-name/
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if anyone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put, I've been using MSN (...) for a number of years, and it's been great – but there have been some smallish issues with it, particularly with the markup generation part, and it's also doing some things in a way that just doesn't work for me – the xtemplates thing being one of these. In many ways it's less about features, and more about style.
      In MarkupMenu I've tried to correct these little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and PHP 7.1+, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) on my todo list.
      One smallish and rather specific difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site has a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to omit that 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By Robin S
      Repeater Images
      Adds options to modify Repeater fields to make them convenient for "page-per-image" usage. Using a page-per-image approach allows for additional fields to be associated with each image, to record things such as photographer, date, license, links, etc.
      When Repeater Images is enabled for a Repeater field the module changes the appearance of the Repeater inputfield to be similar (but not identical) to an Images field. The collapsed view shows a thumbnail for each Repeater item, and items can be expanded for field editing.
      Screencast

      Installation
      Install the Repeater Images module.
      Setup
      Create an image field to use in the Repeater field. Recommended settings for the image field are "Maximum files allowed" set to 1 and "Formatted value" set to "Single item (null if empty)". Create a Repeater field. Add the image field to the Repeater. If you want additional fields in the Repeater create and add these also. Repeater Images configuration
      Tick the "Activate Repeater Images for this Repeater field" checkbox. In the "Image field within Repeater" dropdown select the single image field. You must save the Repeater field settings to see any newly added Image fields in the dropdown. Adjust the image thumbnail height if you want (unlike the core Images field there is no slider to change thumbnail height within Page Edit). Note: the depth option for Repeater fields is not compatible with the Repeater Images module.
      Image uploads feature
      There is a checkbox to activate image uploads. This feature allows users to quickly and easily add images to the Repeater Images field by uploading them to an adjacent "upload" field.
      To use this feature you must add the image field selected in the Repeater Images config to the template of the page containing the Repeater Images field - immediately above or below the Repeater Images field would be a good position.
      It's recommended to set the label for this field in template context to "Upload images" or similar, and set the visibility of the field to "Closed" so that it takes up less room when it's not being used. Note that when you drag images to a closed Images field it will automatically open. You don't need to worry about the "Maximum files allowed" setting because the Repeater Images module overrides this for the upload field.
      New Repeater items will be created from the images uploaded to the upload field when the page is saved. The user can add descriptions and tags to the images while they are still in the upload field and these will be retained in the Repeater items. Images are automatically deleted from the upload field when the page is saved.
      Tips
      The "Use accordion mode?" option in the Repeater field settings is useful for keeping the inputfield compact, with only one image item open for editing at a time. The "Repeater item labels" setting determines what is shown in the thumbnail overlay on hover. Example for an image field named "image": {image.basename} ({image.width}x{image.height})  
      https://github.com/Toutouwai/RepeaterImages
      https://modules.processwire.com/modules/repeater-images/
    • By EyeDentify
      Hello There Guys.

      I am in the process of getting into making my first modules for PW and i had a question for you PHP and PW gurus in here.

      I was wondering how i could use an external library, lets say TwitterOAuth in my PW module.
      Link to library
      https://twitteroauth.com/

      Would the code below be correct or how would i go about this:
      <?PHP namespace ProcessWire; /* load the TwitterOAuth library from my Module folder */ require "twitteroauth/autoload.php"; use Abraham\TwitterOAuth\TwitterOAuth; class EyeTwitter extends WireData,TwitterOAuth implements Module { /* vars */ protected $twConnection; /* extend parent TwitterOAuth contructor $connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $access_token, $access_token_secret); */ public function myTwitterConnection ($consumer_key, $consumer_secret, $access_token, $access_token_secret) { /* save the connection for use later */ $this->twConnection = TwitterOAuth::__construct($consumer_key, $consumer_secret, $access_token, $access_token_secret); } } ?> Am i on the right trail here or i am barking up the wrong tree?
      I don´t need a complete solution, i just wonder if i am including the external library the right way.
      If not, then give me a few hint´s and i will figure it out.

      Thanks a bunch.

      /EyeDentify
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


×
×
  • Create New...