Jump to content
bernhard

RockGrid - powerful, performant and beautiful data listing tool

Recommended Posts

Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.

 

WHY?

ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 

 

Features/Highlights:

  • 100k+ rows
  • Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings)
  • extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection)
  • all the agGrid features (cell renderers, cell styling, pagination, column grouping etc)
  • vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)

 

Limitations:

While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.

Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.

 

Downloadhttps://gitlab.com/baumrock/FieldtypeRockGrid

Installationhttps://gitlab.com/baumrock/RockGrid/wikis/Installation

Quikckstarthttps://gitlab.com/baumrock/RockGrid/wikis/quickstart

Further instructionshttps://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions

German Translation Filesite--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json

Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md

 

Module status: alpha, License: MIT

Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.

 

Contribute:

You can contribute to the development of this and other modules or just say thank you by

 

Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour (excl vat).

 

Use Cases / Examples:

Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

reports.gif

Filters, PW panel links and instant reload on panel close:

groups.gif

You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

filter.gif

  • Like 22
  • Thanks 1

Share this post


Link to post
Share on other sites

Thank you Bernhard for finally releasing this module. I can not wait to play with it and share improvements, if I have any.

I really can think of many use cases where this grid would be mandatory because it offers so much possibilities.

  • Like 1

Share this post


Link to post
Share on other sites

I installed the module and RockFinder, but when calling "Rock Finder Tester" the SQL query works, but no grid is displayed.

There is a JavaScript error in the console which looks like this:

(index):205 Uncaught ReferenceError: RockGrid is not defined
    at initGrid_ProcessRockFinderResult ((index):205)
    at (index):216

 

Share this post


Link to post
Share on other sites

The problem was, that I did not rename the downloaded folder from Gitlab from "RockGrid-master" to "RockGrid". After doing this, it works

  • Like 1

Share this post


Link to post
Share on other sites
42 minutes ago, jmartsch said:

The problem was, that I did not rename the downloaded folder from Gitlab from "RockGrid-master" to "RockGrid". After doing this, it works

Installing the zip (either from URL or Upload), rather than manually unzipping takes care of this stuff for you 🙂

  • Like 3

Share this post


Link to post
Share on other sites

Why I'm always the one who still have the error.😂 I did install via upload of zip and I have /modules/RockGrid.

However, I still have errors:

image.thumb.png.1a690cdab44cc61ff9422825ef509b5a.png

1)The path is wrong for js, it should be : localhost/24h/site/assets/RockGrid/fields/test_grid.js

2)error mentioned earlier

 

Also, not related, but playing with the Tester, I wrote some wrong code which gave me a red error page. The problem is that I didn't know how to reset. (finally I reinstalled since of error above).

Thanks!

Share this post


Link to post
Share on other sites

Hi mel,

thanks for testing and reporting those issues 🙂 

can you please provide a reproducable step-by-step guide what you did so I can look into that?

 

9 hours ago, mel47 said:

Also, not related, but playing with the Tester, I wrote some wrong code which gave me a red error page. The problem is that I didn't know how to reset. (finally I reinstalled since of error above).

Thanks, I'm aware of that and it's definitely not nice to have this. I thought I've already fixed that 🙂 If it happens again please just delete the /site/assets/RockFinder/tester.txt file than it will create a new one. Or just edit it in your IDE and fix the problem.

Hope that helps?

Share this post


Link to post
Share on other sites

Hi

Sorry for the delay, was too sunny to stay inside... 😉

So to recap. I tried on 2 installations (one with my current site and one empty, ie no module). Both are local, running php 7.0. I'm using firefox.

  1. Install rockfinder via module repository
  2. install rockgrid by url (https://gitlab.com/baumrock/RockGrid/-/archive/master/RockGrid-master.zip)
  3. create a "projects" rock-grid field and add it to home template
  4. Go to home template; see an empty white field with this error:
     ReferenceError: RockGrid is not defined[En savoir plus] edit:118:7
    initGrid_projects http://localhost/wire/processwire/page/edit/:118:7
    <anonyme> http://localhost/wire/processwire/page/edit/:129:7
     
  5. Add to /site/assets/RockGrid/fields/projects.js and project.php (copied from usage instructions. Now see this error
    Échec du chargement pour l’élément <script> dont la source est « http://localhost/site/assets/RockGrid/fields/projects.js ». edit:61 

    as mentioned earlier it's not the good address, it missing the domain, in this case : http://localhost/wire/site/assets/RockGrid/fields/projects.

Hope it helps.

Mel
PS No error during module installation. Debug info display under the field seems ok (default mysql query):

0.4ms getSQL SELECT `rockfinder`.* FROM /* original pw query */ (SELECT pages.id FROM `pages` WHERE (pages.status<1024) GROUP BY pages.id ORDER BY pages.created DESC ) as `pwfinder` LEFT JOIN ( /* rockfinder */ SELECT `pages`.`id` AS `id`, `title`.`title` AS `title`, `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 created --- */ LEFT JOIN (SELECT `id` AS `pageid`, `created` FROM `pages` AS `created`) AS `created` ON `created`.`pageid` = `pages`.`id` /* --- end created --- */ /* end rockfinder */ ) AS `rockfinder` ON `pwfinder`.`id` = `rockfinder`.`id`
0ms executeClosures  
1.2ms getObjects Includes executeClosures
1.3ms Overall Inputfield Render  

 

Share this post


Link to post
Share on other sites

Can you please follow the quickstart guide and let me know if it works like described there? Does Rockfinder tester work?

Share this post


Link to post
Share on other sites

Same result, juste a name change.

ReferenceError: RockGrid is not defined edit:578:7

 <div class="RockGridWrapper backend InputfieldIgnoreChanges" id="RockGridWrapper_rockgriddemo">
      <div id="RockGridItem_rockgriddemo" class="RockGridItem ag-theme-balham" data-id="rockgriddemo" style='height: 300px'></div>
      <div class="init"></div>
    </div>
    <script>
    // translation strings for this grid
    var RockGridStr_rockgriddemo = {
          }

    // grid settings object
    var gridSettings_rockgriddemo = {
      grid: 'rockgriddemo',
      dataColumns: ["id","title","created"],
      data: "ajax",
      js: {"settings":{"initPageSize":10,"pageSizes":[10,25,50,100],"height":300}},
    };

    // function to init the grid
    var initGrid_rockgriddemo = function() {
      RockGrid.init(gridSettings_rockgriddemo);    //////ERROR IS HERE
      RockGrid.getGrid('rockgriddemo').str = RockGridStr_rockgriddemo    }

    // load the grid automatically or manually?
    if(typeof onLoad_rockgriddemo == 'function') {
      // load grid manually
      // sometimes this is needed when we have to wait for other grids to be loaded
      onLoad_rockgriddemo(gridSettings_rockgriddemo, RockGridStr_rockgriddemo);
    }
    else {
      // load this grid when dom is loaded
      initGrid_rockgriddemo();  ///////ERROR IS HERE
    }
    </script>

 

If I don't put the .js file I have no extra error. If I add it to /site/assets/Rockgrid/fields/

I get error (404) :

Quote

Échec du chargement pour l’élément <script> dont la source est « http://localhost/site/assets/RockGrid/fields/rockgriddemo.js ».

I try add to frontend, but same result, a white space, with same errors than below.

For the tester, don't exactly what means "work" since I never used. But there nothing in "result", but the "resulting sql" is updated accordingly of changes done in "code to execute". 

I certainly do something wrong or don't have something activated correctly. Will give up for now, since I have other things to do. I will continue to follow the thread in case a solution eventually come out. Thanks for you time.

Mel

Share this post


Link to post
Share on other sites

Hi @bernhard I tried to test and reproduce why this isn't working.

When you install RockGrid and RockFinder from URL from Gitlab, then the RockGrid is downloaded and installed into a folder named "FieldtypeRockGrid". But RockFinder tries to look for files in a folder named "RockGrid".

So Rockfinder tester isn't working and shows the error that I described and @mel47 also described. That's the first problem.
You can solve it, if you download the zip file from gitlab, unzip it in your site/modules folder and remove the "-master" from the folder name, so the name of the folder is "RockGrid".

The second problem is, that if your processwire installation is not in the root of the virtual host of Apache (for example in a subdirectory), then the URLs for loading RockGrid's assets isn't correct because it tries to load the files from the root and does not take the subdirectory into account.

In one example installation I have two separate PW installations under the same virtual host but in different subdirectories (mydomain.localhost/pw1, mydomain.localhost/pw2). That might be the exact same problem that @mel47 has. If you open RockTester then it is trying to load http://mydomain.localhost/site/modules/RockGrid/plugins/cellHoverInfo.css instead of http://mydomain.localhost/pw1/site/modules/RockGrid/plugins/cellHoverInfo.css

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for your help @jmartsch !

I renamed all references to FieldtypeRockGrid, so it should work now without renaming the folder. Thanks for that hint! Maybe someone wants to create a PR for the problem of installations inside a subfolder - I don't have any need for that and therefore will not implement it. At least not soon.

I created a screencast of a demo installation via PW Kickstart, the Kickstartfile is here: https://gitlab.com/snippets/1732038 ; Of course you can also install everything manually.

 

  • Like 3

Share this post


Link to post
Share on other sites

Thanks, looks pretty amazing even for my very small testing. I generally learning by reading other's code examples. Since there mostly anything, I have a quick question.

I could display really easily page and repeater independently. But is it possible to display the title of page found inside a repeater ? For now I only have id. I tried many ways, but without success, but I'm not sure if I'm trying to do something impossible or not.

Thanks!

 

Share this post


Link to post
Share on other sites

I think I found a little glitch in the module. I've installed the module within a subdir based pw instance. Then the module won't find the nessecary js and css files. The field shows on the page edit page only a blank value and not that it find's no data.

I fixed it - for me - with the following change at line 64 in file site/modules/FieldtypeRockGrid/FieldtypeRockGrid.module.php:

Quote

// make sure the path is relative to the rootfolder
//$asset = str_replace($this->config->paths->root, '/', $asset);
$asset = str_replace($this->config->paths->root,$this->config->urls->root, $asset);

After that it seems to work for me.

Many thanx for the great module!!!

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites
Spoiler

 

I am creating an updated web interface for an international proverb database (without pay). RockGrid should go a long way in providing a navigation system for it, so thank you very much for it! However, I can only make it work in the backend.

For the frontend, is it really enough to have $page->rockgrid; in the home.php (using blank profile)? No markup is needed in templates? I mean, it does load all the RockGrid assets in the frontend, but the grid element does not manifest. I did try a variation, where I had a div with id RockGridItem_rockgrid or the wrapper, but it did not help.

Here is my setup:

Field name is rockgrid.

home.php:


include("./basic-page.php");
$page->rockgrid;

basic-page.php loads jquery-3.3.1.min.js

rockgrid.php:


<?php namespace ProcessWire;

// set data for this grid via rockfinder
$this->setData(new RockFinder('template=A-T', ['code', 'variation']));

rockgrid.js:


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

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

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

});

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

The only JS warning is Loading failed for the <script> with source “http://localhost:2015/site/modules/RockGrid/lib/currency.min.js”, which is irrelevant.

Edit: I also tried putting it in the basic-page template. I installed Tracy Debugger, but I don't know what I should be looking for.

 

 

Share this post


Link to post
Share on other sites

Edit: silly stuff here, nothing to see.

Spoiler

 

I started fiddling with the InputfieldRockGrid.module.php file. There is something wrong with output buffering. After ob_start(); I put $status = ob_get_status(); var_dump($status); and I get nothing.

PHP setting output_buffering is 4096 in my dev env. What can I do?

Edit: in the same dev env, if I do a simple test file with only ob_start and dump, it works. So what gives in RockGrid's case? I mean, I can get the value of $data just before ob_start.

ob_start works fine in a PW template as well. The problem is only manifesting in the input field PHP.

Edit2: if I comment out ob_start(); and return ob_get_clean();, the page gets rendered twice, but at least in the second rendering the grid is included.

 

 

Share this post


Link to post
Share on other sites

Hi @Beluga please can you provide detailed step-by-step instructions so that I can try to reproduce your issue. I don't really get what is wrong. Is it not working as expected?

Edit: Sorry, I missed your first post.

Please follow the quickstart tutorial here: https://gitlab.com/baumrock/FieldtypeRockGrid/wikis/quickstart

From there you can continue adding features and always check wether it is working on the frontend or not. Some plugins do not have front-end-support yet. Most of the times it should not be hard to make them work on the frontend too.

Please report back if the quickstart tutorial is working for you.

Share this post


Link to post
Share on other sites
Spoiler

 

On 8/25/2018 at 12:26 PM, bernhard said:

Hi @Beluga please can you provide detailed step-by-step instructions so that I can try to reproduce your issue. I don't really get what is wrong. Is it not working as expected?

Edit: Sorry, I missed your first post.

Please follow the quickstart tutorial here: https://gitlab.com/baumrock/FieldtypeRockGrid/wikis/quickstart

From there you can continue adding features and always check wether it is working on the frontend or not. Some plugins do not have front-end-support yet. Most of the times it should not be hard to make them work on the frontend too.

Please report back if the quickstart tutorial is working for you.

The qs tuto is what I used. Can you shed light on the ob_start() problem? Why is it not working in the context of RockGrid?

 

 

Share this post


Link to post
Share on other sites

If you give me clear step by step instructions I can have a look. I don't understand your explanations in the previous posting

Share this post


Link to post
Share on other sites
Spoiler

 

Ok, second try, minimal example with enumerated steps.

1. Create PW install with blank profile

2. Install RockFinder & RockGrid

3. Create rockgrid field named "rockgrid"

4. Add the rockgrid field to home template

5. Edit basic-page.php and add


<script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>

inside the head and


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

inside the body

6. Create the rockgrid.php:


<?php namespace ProcessWire;

// set data for this grid via rockfinder
$this->setData(new RockFinder('template=home', ['title']));

7. Create the rockgrid.js:


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

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

});

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

8. Navigate to the home page and see that the grid is not rendered. Viewing the source, see that the RockGrid assets are in place. This means the execution of getData function in InputfieldRockGrid has been successful and it trips up at line 110 with ob_start(); for some reason.

 

 

 

Share this post


Link to post
Share on other sites

hey @Beluga

I tried your steps and cannot reproduce your error:

Fcpw64D.png

It works as expected. I used the default profile and the latest versions of rockgrid + rockfinder (used git clone with the master branches).

Share this post


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

it trips up at line 110 with ob_start();

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

Share this post


Link to post
Share on other sites

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

  • Thanks 1

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


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

×
×
  • Create New...