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
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      180817, v1.0.6, support for joining multiple finders 180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By OLSA
      Hello for all,
      ConfigurationForm fieldtype module is one my experiment from 2016.
      Main target to build this module was to store multiple setup and configuration values in just 1 field and avoid to use 1 db table to store just single "number of items on page", or another db table to store "layout type" etc. Thanks to JSON formatted storage this module can help you to reduce number of PW native fields in project, save DB space, and reduce number of queries at front-end.
      Install and setup:
      Download (at the bottom ), unzip and install like any other PW module (site/modules/...). Create some filed using this type of field (ConfigurationForm Fieldtype) Go to field setup Input tab and drag some subfields to container area (demo). Set "Name" and other params for subfields Save and place field to templates ("Action tab") How to use it:
      In my case, I use it to store setup and configurations values, but also for contact details, small content blocks... (eg. "widgets").
      Basic usage example:
      ConfigForm fieldtype "setup" has subfields:
      "limit", type select, option values: 5, 10, 15, 20
      "sort", type select, option values: "-date", "date",  "-sort", "sort"
      // get page children (items) $limit = isset($page->setup->limit) ? $page->setup->limit : 10; $sort = isset($page->setup->sort) ? $page->setup->sort : '-sort'; $items = $page->children("limit=$limit, sort=$sort");  
      Screenshots:


       
      Notes:
      Provide option to search inside subfields Provide multilanguage inputs for text and textarea field types Provide option for different field layout per-template basis Do not place/use field type "Button" or "File input" because it won't works. Please read README file for more details and examples Module use JSON format to store values. Text and textarea field types are multilanguage compatible, but please note that main target for this module was to store setup values and small content blocks and save DB space. Search part inside JSON is still a relatively new in MySQL (>=5.77) and that's on you how and for what to use this module.
      Thanks:
      Initial point for this fieldtype was jQuery plugin FormBuiled and thanks to Kevin Chappel for this plugin.
      In field type "link" I use javascript part from @marcostoll module and thanks to him for that part.
      Download:
      FieldtypeConfigForm.zip
      Edit: 14. August 2018. please delete/uninstall previously downloaded zip
      Regards.
         
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By Thomas Diroll
      Hi guys I'm relatively new to PW and just finished developing a page for a client. I was able to include all necessary functionality using the core fieldtypes but now I it seems that I need to extend them with a custom one. What I need is a simple button, that copies the absolute url (frontend not PW-backend) of the page which is currently edited to the clipboard. As this feature is only needed inside a specific template, I tend to use a custom fieldtype which provides this feature. I've been looking inside the core modules code (eg. FieldtypeCheckbox.module) but I don't really get the structure of it and how its rendered to the admin page. I also didn't find a lot of tutorials covering custom fieldtypes.
      Maybe some of you could give me some tips on how to write a basic custom fieldtype that renders a button which copies the value of
      page->httpUrl() to the clipboard using JS. Thanks!
    • 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/RockGrid
      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
       
      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.
       
      Changelog
      180730 support subdir installations 180711 bugfix (naming issue) 180630 alpha realease  
      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: