kixe

Name Format Children

69 posts in this topic

As described in this post (https://processwire.com/talk/topic/8551-custom-urls-for-pages/?p=82742) the option 'Name Format Children' under the tab 'Family' in template settings doesn't work properly and also not as expected. I had a look inside the code and made some changes which are working properly, which offers much more options, more consistency and less code too.

The result is the following. You have 3 Options for generating name and title, which could be combined in endless variations.
Name is always derived from title, same like creating pages manually.

  • type date: if function detects # character anywhere in the string, conversion will be: deletion of # and string will be used as format parameter for PHP date() function
  • type field: if string is a fieldname of the parent page the value of this field will be used
  • type string: if string doesn't fit to the 2 preceeding it will be taken as it is

All parts (separated by comma) will be composed in the order of setting. You can use unlimited numbers of parts

I made a pull request on github: https://github.com/ryancramerdesign/ProcessWire/pull/831

Example screenshots

Setting ...
post-1246-0-98447200-1418822310_thumb.jp

will result in
post-1246-0-97471800-1418822297_thumb.jp

 

10 people like this

Share this post


Link to post
Share on other sites

That's ultimatly what most people wanted to use there. I mostly used something like this by now "\c\o\m\m\e\n\t-Ymd-His"

1 person likes this

Share this post


Link to post
Share on other sites

Looks great. But It seemed to me that "Name format for children" option should define name of the page, not title. On the screenshot it is title that gets generated.

Share this post


Link to post
Share on other sites

@Ivan

Yes, the title is generated and the name too, as a derivation from the title. (have a look at the system notice on top of the screenshot) Derivation works completely in the same way, if you add a page manually and type in the page title. I think thats what most user would expect.

You have read the post, where I described, how it is working actually (link in the first post of this topic). This way seems to be unlogical to me.

1 person likes this

Share this post


Link to post
Share on other sites

Yes, I took part in that conversation too. But it seems to me that the way it was supposed to work is to autogenerate name for a page on a pattern at creation time but not from the title. As there is no title on creation yet we could:

  • either generate name from parent fields, dates, custon text + numbers, or
  • apply the pattern on the first save (but not generate the title field by that pattern).

If using your solution we have to:

  • either not use title field for output as you probably would not want to use something like "prefix Wednezday...", or
  • save the page to generate name field value and then change the title once again.

I could misunderstand you as I did not apply you patch to the core.

Share this post


Link to post
Share on other sites

@ Ivan

Thats not true. Now you cannot use any field of the parent page to generate the name. Only the generation from date function is possible now. Try it out!
But with my solution you could use all the parent page fields + date + some string in the order you want it. This is obviously more + inclusion what we have.

About title:
Now you get, whatever you defined in the setting the title 'untitled' or a title generated from date which you maybe want to overwrite anyway! No other possibilities until now!

Maybe I understoud you completely wrong, or you my solution. :rolleyes:  Have a look in github.

2 people like this

Share this post


Link to post
Share on other sites

did this ever get merged?  In 2.6.1,  something as simple as title_Y/m/d looks like it ends up being interpreted according to php date().

Share this post


Link to post
Share on other sites

Since there are a lot of topics about the same theme, I decided to write a small module which overwrites the core function ___SetupPageName().
The module allows now to populate the page name

  1. using proprietary date() function. Works like PHP date() with follwing exceptions: 
    Everything between the brackets is detected as format string, meaning no 2nd parameter possible. No need to use quotes around the format string. Spaces not allowed.
  2. from any page property, page field including subfields, parent property, parent field etc. Meaning everything what you get with $page->get(); including dot syntax.

The function will give error and warnings in case of unproper settings, but creates the page with name 'untitled' anyway.

Download here: http://modules.processwire.com/modules/process-setup-page-name/
Some Examples
The following settings in parent template 'Name Format Children' will

assign name immediately.

  • date(Y)
  • date('Y-m-d')
  • parent.title
  • parent.parent.title
  • parent.id
  • template.id

assign name after page saving and/or population of depending field. Overwrites 'untitled' after all fields which are defined in parent template are populated.

  • id (any other page property)
  • pagefieldname, multiple pagefieldnames

show a warning.

  • pagefieldname (value not populated)

show an error.

  • date() // empty, no format assigned
  • date(Y // missing closing bracket
  • date(Y md) // unallowed space
  • notexistingfieldname
  • notexistingproperty
  • existingfield.notexistingsubfield

The function in the module  ___SetupPageName() could be completely copied as is to the core class $pages.

@Ryan
Would be nice to see this in core. :)

Related topics:

https://processwire.com/api/modules/process-template/

Any recommandations after testing welcome. Download here:

Download here: http://modules.processwire.com/modules/process-setup-page-name/

Edit: small enhancement to prevent display of warning twice.
23.12.15 multiple values possible now
24.12.15 made compatible with PW 3.x
27.12.15 Update Version 1.0.8
09.01.16 Update Version 1.1.0

Edited by kixe
14 people like this

Share this post


Link to post
Share on other sites

From now you can use multiple values separated by space. Example: "parent.title date(Y) myfield". Page name will remain 'untitled' until last required field is populated.
You will get informed about this by a warning.

Merry Christmas.

3 people like this

Share this post


Link to post
Share on other sites

Hey kixe,

Thank you - this is awesome and solves one of my biggest issues with PageTable fields - getting meaningful page names without the possibility of conflicting names which I don't think the user should ever have to consider.

One minor thing (but critical) - when installing with PW 3.x I get this error:

Catchable fatal error: Argument 1 passed to ProcessWire\Pages::__construct() must be an instance of ProcessWire\ProcessWire, none given, called in /wire/core/Modules.php on line 481 and defined in /wire/core/Pages.php on line 128

It is easily fixed by adding an empty construct method to your module, like this:

public function __construct() {
    // intentionally empty
}

I am definitely looking forward to using this with all my PageTable fields!

2 people like this

Share this post


Link to post
Share on other sites

Could you also add the new notes to the PageTable Automatic Page Name Format section on the Input tab?

Share this post


Link to post
Share on other sites

Hello, 

Ive just installed this module but get the following error. Any Ideas?

Error: Call to undefined function _() (line 56 of F:\Programs\wamp\www\tml\site\modules\ProcessSetupPageName\ProcessSetupPageName.module) 

This error message was shown because you are logged in as a Superuser. Error has been logged.
1 person likes this

Share this post


Link to post
Share on other sites

@Jon
Thanks for reporting. I fixed this. Please update to 1.0.9

1 person likes this

Share this post


Link to post
Share on other sites

hi kixe,

thank you for your work, i can use this in my current project :)

but i found two bugs:

  • date('d.m.Y H:i:s') forename surname
    gives an error due to the space in date()
  • date('dmY',created) forename surname
    07012016-2016-01-07t22-23-12-01-00thu-07-jan-2016-22-23-12-0100europe-viennapm31europe-vienna07-test-test

i don't need date('Ymd',val), but just tried it and think it would be good to handle this one as well. didn't look at your code but i think the regex should get some fine tuning :)

Share this post


Link to post
Share on other sites

Hi Bernhard,
thanks for the effort you have made testing my module. I think my regex is ok. Maybe I have to modify the detection of multiple fields, which happens before. For now it is a single space character. Since spaces are not allowed in page names you don't need to use spaces in the date function this will be anyway translated later (space -> dash).

Does it make sense to provide a timestamp from a page property or datetime field, since you could handle this in another way?
It
s a bit painful to use the date() function, contrary to the correct PHP syntax
. Meaning I didn't define any timestamp constants like 'val' or 'created' in the module. To prevent confusion I want to stay using correct date() syntax.

For your second example you can easily use: "created forename surname" and you will get the same result.

I don't understand date('dmY',val). If val is a pagefield, which returns a timestamp please use: 'val forename username' after configuring the output of field 'val' to 'dmY' in the field settings.
If you then need other output formats in the templates you can do:

echo date('Y-m-d h:i',$page->getUnformatted('val'));

Share this post


Link to post
Share on other sites

hi kixe,

sorry - i was unclear.

"think it would be good to handle this one as well" was meant as "would be good to handle this as a wrong input" and maybe give an appropriate error message that helps the user find a correct string. "val" was just a placeholder for any value. as i said i don't need this because i switched to standard name for children + creating title field on page save per custom module.

i agree that there is room for improvement in the core at this special step of naming children automatically :)

Share this post


Link to post
Share on other sites

I dont know if this is a problem of the module or from PW in general.

The path names on a multilingual site are only changed for the default language and not for the other languages. In my case I use parent title and date. In German (default) it shows me both, but in English I only get the parent title without the date.

Best regards

It is not a big problem because you can change the pathname afterwards via a hook for the other languages.

Edited by Juergen

Share this post


Link to post
Share on other sites

@Juergen
Thanks for reporting this. If I find a little time I will have a deeper look. Multilanguage support isn't tested very well until now.

There are still some other situations where the module doesn't work:

  • If you want to generate name from a file field (selector like 'myimagefield.description') you will get an error.
  • Name generation from a ProfieldsTable column is also not possible.

I agree multilanguage name generation should be supported.

Share this post


Link to post
Share on other sites

You can do it in the module. Here is the code of an module which changes the path names for multilingual site.

<?php
/**
 * 
 * ProcessWire 2.x 
 * Copyright (C) 2014 by Ryan Cramer 
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 * 
 * http://processwire.com
 *
 */
class CorrectPagenames extends WireData implements Module
{
    public static function getModuleInfo()
    {
        return array(
            'title' => 'CorrectPagenames',
            'version' => 1,
            'summary' => 'Output custom path names multilingual',
            'singular' => true, // Limit the module to a single instance
            'autoload' => true // Load the module with every call to ProcessWire 
        );
    }
    public function init()
    {
        // init() is called when the module is loaded.
        // saveReady is a hook after processing the previous changes of the page,
        // but just before those changes are saved to the database.
        // It's called for each page that's being saved, no matter if it's in
        // the backend or in your templates via the api.

        $this->addHookBefore('Pages::saveReady', $this, 'beforeSaveReady');
    }

    public function beforeSaveReady($event)
    {
        $page = $event->arguments[0];
        //create custom path name for children events
            $datestart  = $page->publish_from;  // I use the publish from date for the path name
            $datestart  = date('Y-m-d', $datestart);
            $eventtitle = $page->parent->title; // I also use the parent title for the path name
            $page->name = $eventtitle . '-' . $datestart; //putting it all together for the default language
            foreach ($this->languages as $lang) { //multilanguage starts here
                if ($lang->isDefault())
                    continue;
                $lname               = $lang->id;
                $pageName            = $page->title->getLanguageValue($lang);
                $pageName            = $pageName . '-' . $datestart;// create custom path for other languages
                $pagelanguage        = "name" . $lang;
                $page->$pagelanguage = $pageName; //this sets the path name for each language 
            }
     
    }
}

You can take a look on how to achive it (as an inspiration ;) )

Best regards

2 people like this

Share this post


Link to post
Share on other sites

Hi,

I have install this module on PW 3.0.12 and when I try to edit a template, this error popup..​

Fatal error: Using $this when not in object context in /site/modules/ProcessSetupPageName-master/ProcessSetupPageName.module on line 68

Do you have any idea why I have this error?

Thank you

1 person likes this

Share this post


Link to post
Share on other sites

@Filkaboy
Thanks for reporting. I fixed this.

1 person likes this

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 psy
      I've configured my PW site to use regions and mostly it's fabulous. However I encountered a strange problem when appending scripts to the body tag of a template. The body tag id is "bodyTag" (duh!).
      There are 3 scripts - two external and one inline. My first attempt was to append each script individually thinking they'd appear in the same order on the output:
      <script id="googlemapskey" type="text/javascript" src="https://maps.google.com/maps/api/js?key=XXXXXXXXXXXXXXXXXXXXXX" pw-append="bodyTag"></script> <script id="localMapsJS" type="text/javascript" src="<?=$bootstrap?>js/jquery.gmap.js" pw-append="bodyTag"></script> <script type="text/javascript" pw-append="bodyTag"> jQuery(document).ready(function($){ ... }); </script> Not so! Got lots of js errors and discovered the output had placed the scripts in the incorrect order, ie:
      <script type="text/javascript" pw-append="bodyTag"> jQuery(document).ready(function($){ ... }); </script> <script id="localMapsJS" type="text/javascript" src="/site/assets/mytheme/js/jquery.gmap.js"></script> <script id="googlemapskey" type="text/javascript" src="https://maps.google.com/maps/api/js?key=XXXXXXXXXXXXXXXXXXXXXX"></script> In other places I've appended multiple HTML regions to the same tag and it's worked fine. It only happens with scripts.
      After trying a few things, I discovered a workaround which was to wrap all the scripts into one div which is then appended to the body tag. This is OK but not ideal. I think (?), the partial is rendered in its entirety before being appended to the body tag:
      <div pw-append="bodyTag"> <script id="googlemapskey" type="text/javascript" src="https://maps.google.com/maps/api/js?key=XXXXXXXXXXXXXXXXXXXXXX"></script> <script id="localMapsJS" type="text/javascript" src="<?=$bootstrap?>js/jquery.gmap.js"></script> <script type="text/javascript" pw-append="bodyTag"> jQuery(document).ready(function($){ ... }); </script> </div> Curious to know where I went wrong in the first example with each script appended individually or is this behaviour with scripts an undocumented feature of regions?
      Using PW 3.0.61 with both Chrome and Firefox
    • By louisstephens
      I have been scratching my head on this one for a while, so I thought maybe someone could shed some light on this issue. I am using a grid layout (that I have created over the years) with a class for responsive images (very similar to bootstrap, but very stripped down). Using this, I created a gallery using a foreach loop, and included a "print button" to print each image. I got the classes and everything worked out, but I ran into a small problem with the print functionality. My images (which are around 2400px wide to fill the space) are just fine in the grid and on resize, but when I print, they "run off" the page. I understand that they are just too big to be printed in portrait mode, which led to me think that I could use $image->size(); to print a scaled down version of the image (which adds a bit more load time as now the site needs to load the image large scale and the scaled down version). However, I can't seem to wrap my head around serving just the scaled down version for print only (obviously display:none; doesn't do the trick). Has anyone tackled this before, or does anyone know of a more elegant solution to the conundrum that I have found myself in?
      The Foreachloop:
      $printclass = 1; foreach($page->galleries as $gallery) { $printclass++; $printimage = $gallery->gallery_image->width(600)->url; $out = ""; $out .= "<div class=\"row\">"; $out .= "<div class=\"grid-12\">"; $out .= "<img src=\"{$gallery->gallery_image->url}\" class=\"reimage\"/>"; $out .= "</div>"; $out .= "</div>"; $out .= "<div class=\"row\">"; $out .= "<div class=\"grid-12\">"; $out .= "<a href=\"#\" onClick=\"printCoupon('printable{$printclass}');\">Print</a>"; $out .= "</div> "; $out .= "</div> "; $out .="<div id=\"printable{$printclass}\"><img src=\"{$printimage}\"/></div>"; echo $out; }  
       
    • By cosmicsafari
      Hi All,
      I was playing around with the settings for various templates as I had created a new role and have inadvertantly locked myself out.
      I changed some of the settings on the Admin template, so I assume this is what has caused the lock out.
      I have direct access to the database but I have no idea what I would need to change in it to regain access.
      Probably also worth mentioning that all the existing pages are still accessible, but /processwire throws a 404.
    • By Martin Muzatko
      Hello!
      I'm trying to use the data I create in Processwire as much as possible.
      So for a form, I try to use the fields description, name and also its built-in validation rules I defined in ProcessWire on the front-end. (minlength, ranges, patterns, etc)
      I already looked into this tutorial, but it is using external resources to validate the form.
      Since ProcessWire does all the heavy lifting, when processing data, I don't have to sanitize anything - ___processInput should do the job just fine.
      However, it is not actually working correctly. 
      $fields = $templates->get('user')->fields; $submission = $input->post; foreach ($submission as $key => $value) { $field = $fields->{$key}; if ($field instanceof Field) { $field = $field->getInputfield($user); $field->___processInput(new WireInputData([$key => $value])); var_dump($field->getErrors(true)); // retrieve validation error } } This works for some constraints, but the values are not correctly validated.
      Example: 

      All the fields are required and zip is an integer field.
      Yet, I get no validation error for zip, although it was entered as a string, and not an integer. Funny enough: if I provide a number outside the range, I get "Specified value 2 removed because it is out of bounds (min=1000, max=99999)".
      firstname will not return any error for being a required field.
      From what I have looked through the source code, there is no check for "required". Some fields only validate on setAttribute. Am I missing anything or am I doomed to build my own validation process?
      Thank you in advance!
      Best,
      Martin
    • By thomas
      Hi,
      I want to extend PagesType to get a new `Product $products` variable in the API. Problem is, I have about a million (well, about 50) different templates for the products so `addTemplates()`  can be difficult. Without a template, `pagesType` throws notices (`Trying to get property of non-object in wire/core/PagesType.php on line 161`). Is there a way to extend `pagesType` without specifing templates or by specifying a template group?
      Thanks, thomas