Jump to content
kongondo

Sites Manager (ProcessSitesManager)

Recommended Posts

Sites Manager

 

16 September 2018:

FOR NOW, PLEASE DO NOT USE THIS MODULE IN A PRODUCTION SITE. A  RECENT ProcessWire UPDATE HAS BROKEN THE MODULE. I AM WORKING ON A FIX.

 

################

 

Sites Manager is a module for ProcessWire that allows Superusers to easily create/install ProcessWire sites on the same serverspace the module is running in. Only Superusers can use the module. You can create both stand-alone and multi-sites.

 

Single/Stand-alone Sites

Stand-alone or single-sites are sites that will run in their own document root/directory with their own wire and site folders, .htaccess, index.php, etc. In other words, a normal ProcessWire site.

Multiple Sites

Multi-sites are sites that will run off one wire folder (shared amongst two or more sites) each having their own site folder and database. In this regard, it is important to note that Sites Manager is not in itself a multiple sites solution! Rather, it is a utility that helps you create multi-sites to be run using the ProcessWire core multiple sites feature. For more on this core feature, see the official ProcessWire documentation, specifically the solution referred to as Option #1.

Option #1 approach requires the site admin to initially install ProcessWire in a temporary directory for each new site. The directory then needs to be renamed as site-xxx, where ‘xxx’ is any name you want to use to differentiate the installation from other sites, before it is moved to the webroot. For instance, site-mysite, site-another, site-whatever. In addition, the /wire/index.config.php file must be copied/moved to the webroot. Each time a site is added, the index.config.php has to be edited to add ‘domain’ => ‘site-directory’ key=>value pairs for the site. This process can become a bit tedious. This module aims to automate the whole multi-site site creation process.

The module is based off the official ProcessWire installer. Creating a site is as simple as completing and submitting a single form! You also have the option to type and paste values or reuse a pre-defined install configuration.

 

The module will:

  • Install a ProcessWire site in your named directory, applying chmod values as specified

  • Move the directory to your webroot

  • Update/Create a Superuser account as per the submitted form, including setting the desired admin theme and colour

  • For multi sites, update sites.json (used by index.config.php to get array of installed sites)

 

For multi sites, the only difference in relation to the core multi-sites index.config.php is that this file is slightly different from the one that ships with ProcessWire.

Download from GitHub: Sites Manager (Beta Release)

Features

  1. Install unlimited number of sites in one (multi-sites) or independent (single-site) ProcessWire installs.
  2. Install by completing a Form, Typing or pasting in configurations or using pre-created install configurations.
  3. Choose an Admin Theme to auto-install along with the site installation.
  4. For single-sites installation, download, save and reuse ProcessWire versions of your choice.
  5. Install and maintain site profiles for reuse to create other sites.
  6. Create install configurations to speed up installation tasks.
  7. Client and server-side validation of site creation values.
  8. Edit uploaded profiles (e.g., replace profile file).
  9. Lock installed sites, configurations and profiles to prevent editing.
  10. Bulk delete items such as site profiles, installed site directories and/or databases (confirmation required for latter two).
  11. View important site details (admin login, chmod, etc).
  12. Links to installed sites home and admin pages.
  13. Timezones auto-complete/-suggest.

Pre-requisites, Installation & Usage

Please see the documentation.

Technicalities/Issues

  • Only Superusers can use the module.

  • ProcessWire 2.7 - 3.x compatible

  • Currently using ProcessWire 2.7 installer (install.php)

  • For multi-sites, potential race condition when sites.json is being updated on a new site install vs. index.config.php accessing the json file?

  • Not tested with sub-directory installs (for instance localhost/pw/my-site-here/)

  • Currently not doing the extra/experimental database stuff (database charset and engine)

Future Possibilities

  • Install specified modules along with the ProcessWire install

  • Profile previews?

Credits

  1. @ryan: for the ProcessWire installer

  2. @abdus: for the index.config.php reading from JSON idea

  3. @swampmusic: for the challenge

Video Demo

Demo  showing how quick module works on a remote server [YMMV!]. Video shows downloading and processing two versions of ProcessWire (~takes 7 seconds) and installing a single/stand-alone ProcessWire 3 site using the new Admin Theme UI Kit (~2 seconds) on a remote server.

 

Screens

1

sites-manager-001.thumb.png.114a764e0d801f4c367d037147dbd552.png

2

sites-manager-002.thumb.png.f1b6f75cf5dcb2df9661a0f21664baca.png

 

 
  • Like 18

Share this post


Link to post
Share on other sites

Looks great! Makes me eager to set up a multisite :)

  • Like 1

Share this post


Link to post
Share on other sites

Really cool project. I am used to developing individual sites that with separate wire directories but it gets tedious to update each and every one of them, and not to mention duplicate /wire/ directories. I was thinking of moving to the official multi-site solution, but I'll start with your module. Thanks for sharing it with us.

50 minutes ago, kongondo said:

index.config.php reading from JSON idea

Although for simple configurations this may not matter, I've found out that using PHP files for configuration files are much easier to handle, and doesn't need parsing at all. It's as simple as this:

<?php // mysite.config.php

return [
    'site' => 'mysite',
    'domain' => 'mysite.com'
];

<?php // ConfigReader.php

$configs = [];
foreach(configFiles in configDir) {
    $configs[] = include(configFile);
}

https://github.com/mrkrstphr/array-config

To export as php configuration files you can use

http://php.net/manual/en/function.var-export.php

Major disadvantage is that it's php only whereas JSON is almost universal.

 

  • Like 5

Share this post


Link to post
Share on other sites

Cool stuff!

The profiles you mention: are they a different format from the profiles produced by ProcessExportProfile?

Just wondering because you said...

51 minutes ago, kongondo said:

Future Possibilities

  • Install specified modules along with the ProcessWire install

...but site profiles from ProcessExportProfile can include modules, so wasn't sure.

  • Like 2

Share this post


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

but it gets tedious to update each and every one of them

so why do you do that? ;)

  • Like 2

Share this post


Link to post
Share on other sites

To live on the bleeding edge

  • Like 2
  • Haha 2

Share this post


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

The profiles you mention: are they a different format from the profiles produced by ProcessExportProfile?

Just wondering because you said...

...but site profiles from ProcessExportProfile can include modules, so wasn't sure.

No, they are not different. I have not used ProcessExportProfile (but I've been thinking, how nice we have it; it will play nicely with ProcessMultiSites). I assume though that it exports the same type of profiles that ship with ProcessWire (the site-default, etc). so it should work.

What I meant is that, say, you have a blank profile. You want to use that to install several sites. Those sites have different module needs. When creating a site you will be able to paste or select module class names to fetch (live) and install along with the site creation. I haven't thought it through properly and it would mean a delay while the modules are being downloaded.  

Edited by kongondo
  • Like 3

Share this post


Link to post
Share on other sites
4 minutes ago, kongondo said:

What I meant is that, say, you have a blank profile. You want to use that to install several sites. Those sites have different module needs. When creating a site you will be able to paste or select module class names to fetch (live) and install along with the site creation. I haven't thought it through properly and it would mean a delay while the modules are being downloaded.  

exactly what i was talking about here: 

 

see also @abdus comment on top of page2

i don't like site profiles. i think they are far too unflexible mostly because of the reason kongondo said. a possibility to define modules that get installed by default would be great! maybe this module could be extended to a kind of advanced PW installation kit? for example it could also be nice to use it to install a single-site setup in a different directory on the server (in other words, having the possibility to choose wheter the new site should be installed as single or as multisite).

it would also be easy to choose the core version to use for single-site setups by defining the URL like this: https://github.com/processwire/processwire/archive/3.0.36.zip or that https://github.com/ryancramerdesign/ProcessWire/archive/2.7.2.zip

thanks for creating and sharing this module with us kongondo!

  • Like 3

Share this post


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

i don't like site profiles. i think they are far too unflexible

They ARE useful though ;) Think of them as the simplest way of SHARING a site – as a starting point – with the community and it is also needed by the PW installer. No more, no less. Great feature! :D

  • Like 1

Share this post


Link to post
Share on other sites

@kongondo,

It was a joy to wake up and see this effort you have undertaken!  Good luck on making this work.

  • Like 1

Share this post


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

for example it could also be nice to use it to install a single-site setup in a different directory on the server (in other words, having the possibility to choose wheter the new site should be installed as single or as multisite).

Yeah, I had similar thoughts when drafting the module. This is quite easy to accomplish. Actually, one other reason the module is alpha is that it could end up being more than a multi site thingy, hence I would need to change the Class name. 

3 hours ago, bernhard said:

it would also be easy to choose the core version to use for single-site setups by defining the URL like this: https://github.com/processwire/processwire/archive/3.0.36.zip or that https://github.com/ryancramerdesign/ProcessWire/archive/2.7.2.zip

Cool idea. I'll have a think.

  • Like 2

Share this post


Link to post
Share on other sites

great to hear that :)

hm... what do you think of splitting it into 3 parts:

  1. some kind of advanced pw-installer
  2. a process module to handle multisite installations
  3. a single php file that grabs the pw-installer similar to the online installer from soma (https://github.com/somatonic/PWOnlineInstaller/blob/master/grabpw.php)

hm... thinking about point 3 i'm not sure if that makes sens, but i'll leave it here for discussion. maybe it would be easier to do a git clone kongondos-great-pw-installer than creating an index.php, copying some lines of php that basically would do the same as my mentioned git clone?! what do you think?

i think it would be great to make the installation process as easy as possible and on the other hand more flexible than the one we already have (yes, i know we already have site profiles and whoever likes them please continue using them :D;) ). so if the installer was able to install a list of modules it could also install point 2 of my list!

i also think that this installer should be able to load standard setups of a pw-site from any url. be it a json file or some php-setup like abdus mentioned - don't know what would be better. but imagine an installer with one inputfield at the top that says:

Quote

load installation-configuration from URL: ...

this would make it possible to

  1. save your own basic pw-setups as simple gists
  2. share setups with others (eg on the forum for debugging, similar to the concept of VMs)

and all you would have to do was to put in an URL form the basic setup (that the browser should remember), choose admin username + password and database connection info. done :)

maybe a lot of what i want is already doable by adrians module toolkit? but still i think the process of installing pw in general can be optimized. or am i just missing some great options we may already have (like wireshell for example)? or can we use composer like this?

  • Like 1

Share this post


Link to post
Share on other sites
On 05/10/2017 at 7:07 AM, abdus said:

I was thinking of moving to the official multi-site solution, but I'll start with your module.

Just to clarify to those that might be confused by this line. This module is not a multi-site solution. It is a multi-site helper. You will still be using the official ProcessWire mulit-site solution. The module only helps you to auto-mate some of the manual tasks. The only notable difference is the how index.config.php is structured.

 

20 hours ago, bernhard said:

hm... what do you think of splitting it into 3 parts:

  1. some kind of advanced pw-installer
  2. a process module to handle multisite installations
  3. a single php file that grabs the pw-installer similar to the online installer from soma

I am not keen on splitting the module like this since it can, with a little tweaking, already achieve a standalone(single) installation. The only differences between a multi-site and single site are:

multi-site

  1. location of site folder -  located in same folder as the main site folder (e.g. /www/main-site/site/ for the main site and /www/main-site/site-something/ for the installed site
  2. site folder named site-something
  3. uses the existing wire folder (/www/main-site/wire/)
  4. needs index.config.php

single site

  1. location of site folder - located in its own folder (e.g. /www/another-site/site/)
  2. site folder named 'site'
  3. uses its own wire folder (/www/another-site/wire/)
  4. does not need the index.config.php

This means that all we have to do is (like you suggested earlier) tell the module in which directory on your server you want to install the single site, do the htaccess.txt renaming and copy over the wire folder as well as its index.php, LICENSE.txt, etc. That's all there is to it. The database stuff routines remain the same. So, I am thinking of a radio button to choose whether you are installing a single versus multi site, blah blah.

Edit:

In respect of selecting ProcessWire versions,  the module could check if you have a zip file in a designated folder to unzip from and if not, download the ProcessWire version of your choice, or something along those lines.

20 hours ago, bernhard said:

i also think that this installer should be able to load standard setups of a pw-site from any url. be it a json file or some php-setup like abdus mentioned - don't know what would be better. but imagine an installer with one inputfield at the top that says:

What is a standard setup :)? I am a bit jittery about the module communicating with any URL. I would prefer all that such setups are loaded locally. Maybe I am just being paranoid here :)

20 hours ago, bernhard said:

save your own basic pw-setups as simple gists

I was thinking of saving this locally. That's what I was intimating by this:

On 05/10/2017 at 6:57 AM, kongondo said:

Create installation profiles and/or allow JSON/CSV install configurations (useful for repetitive values, e.g. where Superuser email doesn’t change)

 

  • Like 4

Share this post


Link to post
Share on other sites

Update: Multi Sites Version 0.0.2.

Multi Sites can now install single/stand-alone sites! The Multi Sites in the name now means installing and managing multiple sites :P! For single sites use, the module now downloads, strips, compresses and save ProcessWire versions of your choice for reuse (rather than downloading each time you install a single site). These ProcessWire files can be refreshed on demand, e.g. when a new version of ProcessWire comes out. README is now complete. See changelog for more details.

Download from GitHub.

Changelog

  1. Support for installing single/stand-alone sites.
  2. Added Type or Paste and Install Configuration methods for creating sites.
  3. Create and edit site install configurations.
  4. Download, store and restore various versions of ProcessWire (for single-site installations).
  5. UI enhancements.

I'll update first post later.

Screens

1

multisites-version-002-001.thumb.png.68d53d6c6b893052a71068bfb71627b9.png

2

multisites-version-002-002.thumb.png.45bfc60ef15cda727665baa8a3e12bf5.png

3

multisites-version-002-003.thumb.png.094b8fe96bf13f28ec7f71f445aa7501.png

4

multisites-version-002-004.thumb.png.ead01014f6e663b87376a995b6d56ac8.png

Edited by kongondo
  • Like 6

Share this post


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

Multi Sites in the name now means installing and managing multiple sites :P!

Great news! Now I just have to find the time to try it out... BTW, how about renaming it to something like Sites Manager? Is it too late to rename it to something more descriptive and less confusing? There is another group of modules with almost the same name:

also:

Multiple solutions with multiple multies in their names are a bit confusing ;) 

  • Like 1

Share this post


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

BTW, how about renaming it to something like Sites Manager? Is it too late to rename it to something more descriptive and less confusing? There is another group of modules with almost the same name:

Not, it's not late at all. In fact, I forgot to mention it. I was looking for name suggestions! (one of the reasons I still left it in Alpha, actually). Thanks! I like sites manager. Let's see if there are more suggestions.

All,

Module Name

Name suggestions for this module please? We currently have:

  1. Sites Manager

Upgrading

Please note, version 002 includes some templates not in version 001. A re-installation is required I am afraid.

  • Like 1

Share this post


Link to post
Share on other sites

Wow! So cool @kongondo.

Only just seen this, I am buried deep in vuejs these last weeks. Will definitely have a look when I am back into Processwire again.

 

  • Like 1

Share this post


Link to post
Share on other sites

Can't wait to use this for something... Now all I need is a nice big client that needs multiple sites. ;-)

59 minutes ago, swampmusic said:

I am buried deep in vuejs these last weeks

In this boat as well. Vue is awesome! Somewhat of a paradigm shift, but fine - just the reactivity system on its own is great!

Share this post


Link to post
Share on other sites

Update: Multi Sites Sites Manager Version 0.0.3.

Multi Sites is dead! :o Long live Multi Sites!! :)

Happy to announce Beta Release of Sites Manager.

Please note, no upgrade path from versions 001 or 002 of Multi Sites. I have updated the first post.

Download: GitHub

Demo: Remote server single site install (PW 3.x + AdminThemeUIKit).  YouTube

Documentation: GitHub

Changelog

  1. Changed name to Sites Manager (formerly Multi Sites). Thanks to @szabesz for suggestion.
  2. Fixed bugs in Type or Paste method (key=value pairs must now be separated by new line).
  3. Beta release.
Edited by kongondo
minor cleanup
  • Like 3

Share this post


Link to post
Share on other sites

trying this out for the first time. I get this error every time i try to add my first site. Am i doing something wrong?

 

"Error saving admin account"

Screen Shot 2018-09-15 at 7.24.40 PM.png

Share this post


Link to post
Share on other sites

Hi @DxJR,

Welcome to the forums and ProcessWire. Thanks for testing the module. What ProcessWire version are you using? A recent ProcessWire update seems to have broken the module. I noticed this when setting up some sites last week. I've not had a chance to debug it yet. I am quite busy at the moment and don't know when I'll look into it. Until then, please do not to use the module in production sites. I'll update the first post.

Share this post


Link to post
Share on other sites

@kongondo thanks so much for your quick response. Newish to the forums, but been a processwire devoted user for YEARS! Excited to see what this module can do.

  • Like 2

Share this post


Link to post
Share on other sites

@kongondo hey, i know you're busy and probably haven't had time, just wanted to know if you found a solution to this yet. Thanks so much

Share this post


Link to post
Share on other sites

@DxJR Sorry, I haven't had a chance to look at it yet. If you are able to help debug it please, that would help get us there.

  • Thanks 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      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.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--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
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      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 (please contact me via PM).
       
      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:

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

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

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...