MadeMyDay

Module: PageTableExtended

Recommended Posts

PageTableExtended

 

Download here: http://modules.processwire.com/modules/fieldtype-page-table-extended/

 

Extends the Processwire PageTable field for rendering table row layouts. This is great for editors, because they actually see at a glance what the table rows consist of.

What it does

 

Turns the Processwire Fieldtype "Page Table" from this:

git1.jpg

 

into something like this (sorting capabilities of course still functional):

 

git2.jpg

See it in action:

Requirements

  • FieldtypePageTable installed (part of the core since Processwire 2.4.10.)
  • Templates used for PageTable need a file associated (otherwise nothing gets rendered)
  • This render method is meant for sites where the PageTable templates only render part of the layout, not complete websites. But you also can define what will be rendered (see below).

Options

git3.jpg

Render Layout instead of table rows

Check this for seeing the rows rendered. You can easily turn off the complete functionality by unchecking this.

Path to Stylesheet

Since the parts are unstyled by default, it is a good idea to define styles for them. All rendered templates are encapsulated in a div with the class "renderedLayout" so you can style them with:

div.renderedLayout h2{
color: green;
}

The path is to be set relative to your templates' folder.

Reset Admin CSS

Since the parts are rendered inside the Admin, common styles of the Admin Interface apply also to your layout parts. This is not a bad thing, because especially text styles are well integrated in your admin's theme. But if you like to override the admin styles in your table rows completely (more or less), just check this box. Don't forget to define a custom CSS then!

Advanced

 

Since this module is meant for parts of your layout you already have defined for your frontend templates, it is a good idea to use a preprocessor like Stylus, Sass or Less for building the custom CSS file. Just outsource your layout part definitions in an extra file, compile that in a separete CSS file and use this as custom CSS for this module. Since your CSS is should be built in a modular way, this works pretty well ;-) Will write a tutorial with a use case once finished testing.

 

Notes:

 

Github: https://github.com/MadeMyDay/PageTableExtended

 

If you want to get rid of the unnecessary step for entering a title before editing the page, just set the "autoformat" value as suggested in the PageTable settings. If you don't want to use a title field at all, see this post from Soma

 

Will put it in the module repository once finished testing. Please test it and give feedback. I haven't used GitHub for a long time, please check if everything is in place and if this will work with the modules manager and the new core module installer once added to the repository. Have fun :)

 

Module is in the repository now: http://modules.processwire.com/modules/fieldtype-page-table-extended/

 

Please use GitHub for instructions, I made some additions there.

  • Like 33

Share this post


Link to post
Share on other sites

Awesome! - only one suggestion - it would be great to have text fields editable inline, with ajax save - might be beyond the scope of what you want, but I think it would be cool :)

Share this post


Link to post
Share on other sites

Awesome! - only one suggestion - it would be great to have text fields editable inline, with ajax save - might be beyond the scope of what you want, but I think it would be cool :)

I am a bit ambivalent regarding such a feature. Of course it would be nice, but also would add a lot of overhead to this specific module. If there would be an existing solution for that (for the frontend), it would be easy to integrate it as well in this module (including necessary js and css files should be enough), because the layouts are rendered as in the frontend.

  • Like 1

Share this post


Link to post
Share on other sites

I guess I am mixing purposes a bit here - your goal was to style the output exactly as it will appear on the frontend, but I guess I am looking more for replicating the ease of editing that repeaters have. Maybe I'll make a different extension for PageTable that works more that way. Maybe not worry about the ajax saving and just use the page save to save each of PageTable components. I'll mull over it for a bit.

  • Like 2

Share this post


Link to post
Share on other sites

I totally agree. I was waiting for a configurable repeater (with different templates to choose from) for ages. Now PageTable has this feature, so I went with this ;) But hey, never say never. Question is... When do you want to save the changes? Autosave? No good idea as long there are no draft versions. So this is getting complicated. Either you provide a save button on each row (easy to implement, but hard to understand for editors) or you save the entries on page save (easier to understand but harder to implement). You then would have to monitor the changed fields, look for their page, save the fields on each page... well.

Share this post


Link to post
Share on other sites

Hi Marc, you know - I don't have any experience with PageTable field.

I've installed the module and added the templates. Everything works fine for me. The Elements are there, I can add content und frontend shows everything.

In your folder are two Modules.

PageTable Renderer (Renders PageTable entries in admin) and PageTable render (Adds render functionality for PageTable fields). First one is installed. The second one requires InputFieldPageTable which I can't find. I thing thats the reason, why I have no settings.

The rendering doesn't work for me yet and I've a little understanding problem, how I got this working for me…

Share this post


Link to post
Share on other sites

@yesjoar

You need to install the dev version of 2.4 instead of the stable one. PageTable is a new Fieldtype which is only available with the dev version.

Share this post


Link to post
Share on other sites

@yesjoar

You need to install the dev version of 2.4 instead of the stable one. PageTable is a new Fieldtype which is only available with the dev version.

I have the latest dev version. PageTable is installed and everything works fine for me. Like I said. ;)

But the rendering in the page itselfs doesn't work for me. Also I can't install the second rendering module.

Share this post


Link to post
Share on other sites

Have you installed the new fieldtype FieldtypePageTableExtended? And then created/changed the field with "PageTableExtended" ? It's a new field.

Share this post


Link to post
Share on other sites

Hi Yesjoar,

PageTable Renderer (Renders PageTable entries in admin) and PageTable render (Adds render functionality for PageTable fields). First one is installed. The second one requires InputFieldPageTable which I can't find. I thing thats the reason, why I have no settings.

Okay, I pushed an update to GitHub. The dependencies of the modules were not clear and the titles misleading. Please try to override the modules with the new ones.

Share this post


Link to post
Share on other sites
Hi Tobaco,
 
my setup is always the same. Doesn't matter if I use PageTable or not. Here it goes (simplified):
 
/templates
- basic-page.php
- home.php
- /tpl 
   - main.php
   - mainnav.php
   - subnav.php
   - footer.php
 
 
The tpl/main.php is the overall template like:
 
<?php
include('tpl/mainnav.php');
include('tpl/subnav.php');
include('tpl/slider.php');
?>
<!DOCTYPE html>
<html class="no-js">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
        <title><?= $page->title ?></title>
        <!--- styles and scripts -->
    </head>
    <body class='<?= $bodyclass ?>'>
        <header>
            <div class='wrap'>
                <a href="/"><img src='/site/templates/img/logo.png' class='logo' alt="Logo"></a>
                <nav class='main'>
                    <?= $mainnav ?>
                </nav>
            </div>
        </header>
        <?= $slider ?>
        <?= $subnav ?>
<section class="content">
            <div class="wrap group">
                <h1 class='v2 hide'><span><?= $page->title ?></span></h1>
                <?= $content ?>
            </div>
        </section>
        <footer>
            <div class="group">
                <?php include ('tpl/footer.php'); ?>
            </div>
        </footer> 
        <script src="/site/templates/dist/all.min.js"></script>
    </body>
</html>

basic-page template looks like this (every template renders the content and then includes the main template):

<?php
/**
 * basic page template
 *
 */
$bodyclass='inner';

$content = $page->body;

include('tpl/main.php');
 
With PageTable the structure looks like this:
 
/templates
- basic-page.php
- home.php
- part_text.php
- part_columns.php
- part_gallery.php
- /tpl 
   - main.php
   - mainnav.php
   - subnav.php
   - footer.php

The part_* templates are templates only for PageTable. part_columns.php could look like this:

<?php
$headline1 = "";
$headline2 = "";
if(!$page->checkbox1) $headline1 = "<h2>{$page->title}</h2>";
if(!$page->checkbox2) $headline2 = "<h2>{$page->text1}</h2>";

// Output

echo "
<div class='pageTableSection {$page->template->name}'>
    <div class='inner'>
        <div class='col one-half'>
                {$headline1}
                {$page->body}
         </div>
        <div class='col one-half'>
            {$headline2}
            {$page->textarea1}
        </div>
    </div>
</div>

";

And the basic page template gets enhanced by ("layout" being the PageTableExtend field):

<?php 

/**
 * basic page template
 * including PageTable layout parts
 */
$bodyclass='inner';

$content = "{$page->body}";

if(count($page->layout)>0){
     foreach($page->layout as $l){
         $content .= $l->render();
     }
}

include('tpl/main.php');
 
That way, the layout parts are easily renderable in the Admin with PageTableExtended.
 
While writing this, I want to point to another feature of the module. If rendered by PageTableExtended, the template gets an option 'pageTableExtended' which you can use in your part template:
 
// Output

echo "
<div class='pageTableSection {$page->template->name}'>
    <div class='inner'>
        <div class='col one-half'>
                {$headline1}
                {$page->body}
         </div>
        <div class='col one-half'>
            {$headline2}
            {$page->textarea1}
        </div>
    </div>
</div>

";

if(!$options['pageTableExtended']){ 
    // we are not in the Admin, so we include our social media buttons which we only need in our frontend
    include('social/socialmediabuttons.php);
}

Hope that helps.

  • Like 12

Share this post


Link to post
Share on other sites
Since your CSS should be built in a modular way, this works pretty well ;-)

Ha! that *wink* should be bigger. :P

BTW, this is so awesome!

  • Like 2

Share this post


Link to post
Share on other sites

Awesome stuff! This is one of the features i was always missing in pw. Great Job MadeMyDay.

  • Like 2

Share this post


Link to post
Share on other sites

I hadn't actually realised you could specify more than one template for a PageTable field! Did that get snuck in after one of the early versions or am I just blind in general? :)

It actually makes an "article" system a lot easier to build where an editing user might want to dump in some text, then an image, then some more text exactly as you have, but with your module it's one step better as it's pretty much WYSIWIG.

Inline edits would be nice as folks have said, but this is still really, really useful!

  • Like 1

Share this post


Link to post
Share on other sites
I hadn't actually realised you could specify more than one template for a PageTable field! Did that get snuck in after one of the early versions or am I just blind in general?
 
Wasn't there from the beginning. But as owzim posted this: https://processwire.com/talk/topic/4189-flexibility-in-page-design/page-4#entry63924 I knew, this is the key to my always wanted flexible layout parts :)
 
It actually makes an "article" system a lot easier to build where an editing user might want to dump in some text, then an image, then some more text exactly as you have, but with your module it's one step better as it's pretty much WYSIWIG.
 
exactly.
 
Inline edits would be nice as folks have said, but this is still really, really useful!
 

Of course they would be. But as I said: If there would be a solution for the frontend, it could easily be applied to this module. I think developing a solution only for this module would be out of scope.

Will try to include Apeisa's Fredi. If that works without hazzle, any inline solution should work.

Share this post


Link to post
Share on other sites

So behind the times :(

@MadeMyDay - just submitted a pull request to fix some freaky things I was experiencing either due to a template delegation situation or some freaky admin code I've done but I think it could affect certain people in certain scenarios so best to be safe.

And because I'm nice I made sure it was all still compatible with your instructions afterwards ;)

  • Like 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 bernhard
      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 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:

      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 thomasaull
      Some time ago I created a site profile for creation of a REST API with ProcessWire. Since I kept struggeling with updating stuff between different projects which use this, I decided to convert it into a module. It is now ready for testing: https://github.com/thomasaull/RestApi
      Additionally I added a few small features:
      automatic creation of JWT Secret at module install routes can be flagged as auth: false, which makes them publicly accessible even though JWT Auth is activated in module settings To check things out, download and install the module and check the folder /site/api for examples.
      If you find any bugs or can think of improvements, please let me know!
    • By kongondo
      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
      Install unlimited number of sites in one (multi-sites) or independent (single-site) ProcessWire installs. Install by completing a Form, Typing or pasting in configurations or using pre-created install configurations. Choose an Admin Theme to auto-install along with the site installation. For single-sites installation, download, save and reuse ProcessWire versions of your choice. Install and maintain site profiles for reuse to create other sites. Create install configurations to speed up installation tasks. Client and server-side validation of site creation values. Edit uploaded profiles (e.g., replace profile file). Lock installed sites, configurations and profiles to prevent editing. Bulk delete items such as site profiles, installed site directories and/or databases (confirmation required for latter two). View important site details (admin login, chmod, etc). Links to installed sites home and admin pages. 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
      @ryan: for the ProcessWire installer
      @abdus: for the index.config.php reading from JSON idea
      @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

      2

       
       
    • By Robin S
      Breadcrumb Dropdowns
      Adds dropdown menus of page edit links to the breadcrumbs in Page Edit.

      Installation
      Install the Breadcrumb Dropdowns module. The module requires ProcessWire >= v3.0.83 and AdminThemeUikit.
      There is a checkbox option in the module config that determines if the breadcrumb dropdowns will include pages that the user does not have permission to edit.
      Features/details
      The module adds an additional breadcrumb item at the end for the currently edited page. That's because I think it's more intuitive for the dropdown under each breadcrumb item to show the item's sibling pages rather than the item's child pages. In the dropdown menus the current page and the current page's parents are highlighted in a crimson colour to make it easier to quickly locate them in case you want to edit the next or previous sibling page. Unpublished and hidden pages are indicated in the dropdowns with similar styling to that used in Page List. If the option to include uneditable pages is selected then those pages are indicated by italics with a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. If the current user is allowed to add new pages under the parent page an "Add New" link is shown at the bottom of the breadcrumb dropdown. If the currently edited page has children or the user may add children, a caret at the end of the breadcrumbs reveals a dropdown of up to the first 25 children and/or an "Add New" link. Overriding the listed siblings for a page
      If you want to override the siblings that are listed in the dropdowns you can hook the BreadcrumbDropdowns::getSiblingsmethod and change the returned PageArray. For most use cases this won't be necessary.
      Incompatibilities
      This module replaces the AdminThemeUikit::renderBreadcrumbs method so will potentially be incompatible with other modules that hook the same method.
       
      https://modules.processwire.com/modules/breadcrumb-dropdowns/
      https://github.com/Toutouwai/BreadcrumbDropdowns
    • By Ken Muldrew
      I'm trying to get a short routine to run once per day that will look at some pages and send a reminder email when that customer's subscription (yearly) is about to expire. When I run the code in a template then it works without issue, but inside my lazycron service routine, I get an "Error: Uncaught Error: Call to a member function get() on null" as if the database cannot be found. My autoload module is just the sample HelloWorld module included with ProcessWire, editted to perform this task. The whole of it is included below (I've stripped out the code that generates the email because it never gets past $pages->find):
       
      <?php namespace ProcessWire;
      /**
       * ProcessWire 'LazyCronLoad'  module
       *
       */
      class LazyCronLoad extends WireData implements Module {
          public static function getModuleInfo() {
              return array(
                  'title' => 'LazyCronLoad', 
                  'version' => 1, 
                  'summary' => 'Just loads a lazy cron callback.',
                  'singular' => true, 
                  'autoload' => true, 
                  );
          }
          public function init() {
              // initialize the hook in the AutoLoad module
              $this->addHook('LazyCron::everyDay', $this, 'myHook');
              
          }
          public function myHook(HookEvent $e) {
              // called once per day
              wire('log')->save('user_activities',' lazy cron service routine');
                  $transport_pages = $pages->find("template=aggregate-entry, aggregate_type.title='Transport'");
                  foreach ($transport_pages as $page) {
                      if (($page->purchase_date + 30325800 < time()) && ($page->purchase_date + 30412600 > time())) { // between 351 and 352 days
                          wire('log')->save('user_activities', $page->id . ' email reminder sent');
                          // send email
                  }
              }
          }        
          
      }
      The first wire('log') shows up but the second one doesn't (the purchase_date condition is met (as demonstrated by running the code in a template close in time to when the lazycron routine executes)). The error log gives the Uncaught Error shown above. 
      I think this is a beginner's mistake with something obvious being missed and would be grateful for any assistance in fixing it.