horst

Pagetree Add New Child Reverse (on Top)

Recommended Posts

Pagetree Add New Child Reverse

New Pages in Descending Sortorder (newest first) while sortmode can be "Manual Drag-n-Drop"
 
When a site display an overview of the latest posts, news, image-albums, etc. the newest entries should be on top of the list. We can achieve that by using an automated setting for the sortfield e.g. when the page was created = "-created".
 
But this way we are not able to manually move a single page in the tree.
 
This module enables us to do exactly that. It works with manually created pages, with pages created via the API, also when bootstrapped by importer scripts.
 
 
 
Pagetree "Newsitems" with 3 newsitems sorted in descending order.

PageTreeAddNewChildsReverse_1.jpg

 
New created item 4 is added to the top.
 
PageTreeAddNewChildsReverse_2.jpg

 
To change the order click item 3 and drag it to the top and drop it.
 
PageTreeAddNewChildsReverse_3.jpg
 
PageTreeAddNewChildsReverse_4.jpg

PageTreeAddNewChildsReverse_5.jpg
 

How to use it

Download the module into your site/modules/ directory and install it.
 
In the config page you find a single textarea field. Here you can enter the templatename or page-ID of the page which children should get reverse added, - optionally followed by a comma and the child-templatename if you need a more precise selector.
 
You can add as many parents as you like, but only one on each line and in this format:
TEMPLATE-NAME or PAGE-ID[,CHILDTEMPLATE-NAME].
 
A few examples:

newsitems
posts,post
1042
1033,album

 
You want set your template(s) sortfield(s) to 'Manual drag-n-drop' if not have done already.

 
ATTENTION
 
You need to setup the TreeParent and the module config when there are no children in it! Otherwise it will not work!
 
Also disabling the module once you have added children and then add one new page to it will mess up all!
(You may think about to install the module as permanent in critical situations.?! see below ->)

If you need to install it in a site for an already existing branch, you can do it this way:

  1. move / rename your existing branch
  2. create a new (empty) branch with the original name
  3. move your childpages into the new branch
  4. remove the renamed (and now empty) old branch

 
 
DOWNLOAD   -  Version 1.0.2

 
 
Want to make it bulletproof?
 
If you are concerned that the module settings could be dropped by other users or that the module itself could be uninstalled by accident, you may edit the module file directly:

This way the permanent settings couldn't be dropped by accident. To change it you first need to edit the modules file again.

Example:

You have two settings in the inputfield of the modules config, without permanent setting:

parenttemplate1,childtemplate1
parenttemplate2,childtemplate2

Now you want to have the the first setting become bulletproof permanent:

a) you enable the setting in the getModuleInfo, (uncomment setting for permanent)

b) you write your permanent settings under the constant permanentValue

const permanentValue = "parenttemplate1,childtemplate1";

After both steps, the module cannot get uninstalled anymore (Step a), and the first setting cannot get deleted anymore (Step b), as it is recreated with every call of the configscreen. (See first code line of method getModuleConfigInputfields)

If you want to keep both definitions permanent, write them separated with a newline character "\n" :

const permanentValue = "parenttemplate1,childtemplate1\nparenttemplate2,childtemplate2";




History of origins

Edited by horst
added example how to make it permanent
  • Like 12

Share this post


Link to post
Share on other sites

Wow, I can't wrap my mind around this. How is this possible without heavy overhead. Great work Horst, thank You !

Sneakpeeked at the code... clever :-)

Edited by Martijn Geerts
  • Like 1

Share this post


Link to post
Share on other sites

This does look great horst.

I think it is something I am going to have to be aware of though as my page tree migrator module gets closer to release. I can see it being an issue if migrating pages from a site that has this installed, or to one that has it installed if the other doesn't. Not sure how to handle that, but we'll see :)

Just curious - did you test the idea of negative number indexing? Might be opening another can of worms though!

  • Like 1

Share this post


Link to post
Share on other sites

 ... Just curious - did you test the idea of negative number indexing? Might be opening another can of worms though!

It doesn't work with negative numbers. They get corrected to 0 (zero) at some other points in PW, not only at Pages::setupNew() :(

  • Like 1

Share this post


Link to post
Share on other sites

I have template pr-index, children (template pr-item) are reverse sorted by pubdate (Datetime field in pr-item), not reverse sorted by created date. Is it possible to have manual drag-n-drop in this situation? 

Share this post


Link to post
Share on other sites

No sorry, this isn't possible. :(

Share this post


Link to post
Share on other sites

Successfully tested with PW 3.0 today :)

  • Like 3

Share this post


Link to post
Share on other sites
On 10/18/2013 at 4:34 PM, horst said:

ATTENTION
 
You need to setup the TreeParent and the module config when there are no children in it! Otherwise it will not work!

So I can't use this module on a production site? What if I unpublish the children?

Share this post


Link to post
Share on other sites

Based on the suggestion by @abdus, put this in your ready.php file:

$this->addHookAfter("Pages::saved", function($event) {
    $this->pages->sort($event->arguments[0], 0);
});

Note that $event->arguments[0] returns the page that was just saved.

Perhaps it would be a good idea to resort all other children too - have a read more about this here:
https://processwire.com/api/ref/pages/sort/

I think in this use case you'd actually want to use the parent of the saved page so that all child pages are sorted. I honestly have played around with this, so not sure if it matters or not.

  • Like 2

Share this post


Link to post
Share on other sites
Quote
5 minutes ago, adrian said:

Perhaps it would be a good idea to resort all other children too

Thanks for the quick solution, @adrian

I'm not sure if we're talking about the same thing, but docs mention that these methods modify other siblings to accept new order.

Quote

$pages->sort($page, $n)
This method sets and saves the sort value of $page to integer $n (0 based), and then also adjusts the sort values of all sibling pages as needed to ensure consistent order.

  • Like 1

Share this post


Link to post
Share on other sites
25 minutes ago, abdus said:

I'm not sure if we're talking about the same thing, but docs mention that these methods modify other siblings to accept new order.

Yeah, I agree that it sounds like it should take care of it (and it appears to work just fine), but I guess I am wondering what the point of this is:

// re-build sort values for children of $page, removing duplicates and gaps
$pages->sort($page, true);

Why would there be duplicates/gaps in the first place if the main sort() method works as expected? Maybe it's to clean things up if you did some manual changes? I am really not sure, but it seems like it shouldn't be necessary.

Share this post


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

So I can't use this module on a production site? What if I unpublish the children?

unpublishing doesn't help. You need to start with an empty parent!

  • once I moved all children to a temporary parent,
  • installed and configured the module,
  • and then moved the children back.

But please, do a BACKUP of your DB before!

Share this post


Link to post
Share on other sites

@horst - what do you think - does the use of the new sort() method in a Pages::saved hook (like my example above) make this module obsolete or is there another scenario I am not thinking of?

Share this post


Link to post
Share on other sites

I don't know. What comes to my mind, and thats why I posted this to @PWaddict, is, that with my module simply the next free number (counted down!) is put onto the new page. No need to resort all other siblings!

With a huge amount of sibling pages, the new sort function may slow down the process. But I haven't tested it.

Share this post


Link to post
Share on other sites
1 minute ago, horst said:

the new sort function may slow down the process

I haven't tested at scale, but Ryan notes:

Quote

One nice thing about the sort() method is that it doesn't actually load any pages to do its job. It handles it all at the database level, so it can do it's job quickly regardless of scale.

https://processwire.com/blog/posts/pw-3.0.46-stocking-stuffers/#new-pages-api-manipulation-methods

  • Like 1

Share this post


Link to post
Share on other sites
14 minutes ago, adrian said:

does the use of the new sort() method in a Pages::saved hook (like my example above) make this module obsolete or is there another scenario I am not thinking of?

What about sites that still use PW 2.7? :):'(

  • Like 1

Share this post


Link to post
Share on other sites
Just now, kongondo said:

What about sites that still use PW 2.7? :):'(

Sure, but why not update the site to 3.x or at least 2.8 :) I have updated all my old sites and most involved no code changes. Only a couple of sites needed some work with bootstrapped ajax calls etc, but that was it.

Just so you know, I am not trying to say that this module should be removed, but perhaps it might be possible to say it is no longer required with PW 3. Obviously a little more testing would be beneficial - just wanting to start the dialog. 

 

Share this post


Link to post
Share on other sites
3 minutes ago, adrian said:

Sure, but why not update the site to 3.x or at least 2.8 :) I have updated all my old sites and most involved no code changes. Only a couple of sites needed some work with bootstrapped ajax calls etc, but that was it.

Just so you know, I am not trying to say that this module should be removed, but perhaps it might be possible to say it is no longer required with PW 3. Obviously a little more testing would be beneficial - just wanting to start the dialog. 

^-^:)

Share this post


Link to post
Share on other sites
5 minutes ago, adrian said:

Sure, but why not update the site to 3.x or at least 2.8 :) I have updated all my old sites and most involved no code changes. Only a couple of sites needed some work with bootstrapped ajax calls etc, but that was it.

I do not update all sites to 3.x or 2.8.x. I have sites from 2.4, 2.5, 2.6, 2.7, and some different 3.0.x. Only one of version 2.8!
(never touch a running system) :)

  • Like 1

Share this post


Link to post
Share on other sites
3 minutes ago, horst said:

never touch a running system

Hope you're still enjoying Windows 3.1 then :) Sorry I couldn't resist ... ha ha ha - not really very funny I know :)

We are obviously getting way OT, but I guess the key thing for me is that there is now an option with $pages->sort() to easily add reverse order functionality after a site is already set up if we decide it would be a better UX.

I like having options!

  • Like 1
  • Haha 1

Share this post


Link to post
Share on other sites
14 hours ago, adrian said:

 


$this->addHookAfter("Pages::saved", function($event) {
    $this->pages->sort($event->arguments[0], 0);
});

 

I'm gonna test this soon. How can I apply it only to 1 or 2 specific templates?

Share this post


Link to post
Share on other sites

@PWaddict change $templates as necessary

$this->addHookAfter("Pages::saved", function($event) {
    $templates = ['product', 'post' ];
    $page = $event->arguments[0];

    if (! in_array($page->template->name, $templates)) return;

    $this->pages->sort($page, 0);
});
  • Like 2

Share this post


Link to post
Share on other sites

I just test it and it works great. I replaced "saved" with "published" otherwise everytime my client will edit the pages sorting will applied. So for PW 3.0.46+ no need this module.

  • Like 3

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