Unexpected results from form blueprint

[paulhibbitts]

I have the following blueprint:

        -
            name: taxonomy.tag
            type: checkboxes
            label: 'Tag for Blog Post'
            options:
                tag1: 'Tag 1'
                tag2: 'Tag 2'
                tag3: 'Tag 3'
                tag4: 'Tag 4'

And the front matter generated looks like this:

---
taxonomy:
    tag:
        taxonomy.tag-tag1: tag1
        taxonomy.tag-tag3: tag3
---

Is this an issue with my blueprint formatting or an issue with Grav blueprint processing?

Thanks very much,
Paul

[flaviocopes]

Add the use: keys (explained in https://learn.getgrav.org/forms/forms/fields-available#the-checkboxes-field) to the field definition:

            header.taxonomy.tag:
              type: checkboxes
              label: 'Tag for Blog Post'
              options:
                tag1: 'Tag 1'
                tag2: 'Tag 2'
                tag3: 'Tag 3'
                tag4: 'Tag 4'
              use: keys

It will store as

taxonomy:
    tag:
        tag1: true
        tag2: true
        tag3: true
        tag4: false

[paulhibbitts]

Thank you very much for the info @flaviocopes (I did not know about keys) but I am still unable to get the results I am trying for - setting the tags for a taxonomy as recognized by Grav.

I am trying to get this final result:

taxonomy:
  tag: [tag1,tag2,tag3]

Is this even possible then? Might there be another format accepted by Grav when building taxonomy tags?

Thanks again,
Paul

[flaviocopes]

I tried on a page blueprint. Did you use it on a page blueprint too? Or if somewhere else, where?

[paulhibbitts]

I am using it in a blueprint along with the Add Page by Form plugin (https://github.com/bleutzinn/grav-plugin-add-page-by-form), perhaps I also need to loop back with the plugin author and do some more tests. Thanks again for your help!

[flaviocopes]

Oh ok thanks, in a frontend form. I thought in an Admin blueprint. Need to test as well.

[flaviocopes]

Might as well be unique to that plugin, as the frontmatter is created upon form submit.

[bleutzinn]

In the Add Page plugin I merge the preset frontmatter with the submitted field values and format the YAML like this:
$page->frontmatter(Yaml::dump((array) $page->header(), 10, 2, false));.

I was "inspired" by the exact same line of code in the Admin plugin.
Might that be the cause of the problem with the taxonomy formatting? If so what should the format be?

[bleutzinn]

I've looked into the issue a bit. Why the Add Page plugin does is that it inserts the form field values as frontmatter of the newly created page. This goes well for simple field types such as text fields. However, with more complex field types such as checkbox this is not as straightforward.
So, I think the issue has nothing to do with the YAML formatting itself but requires a more clever way of processing input fields by the Add Page plugin.
@flaviocopes, can you confirm this?

[flaviocopes]

@bleutzinn try doing this https://github.com/getgrav/grav-plugin-admin/blob/develop/classes/admincontroller.php#L1707-L1708 which is in the method that prepares the page for storage after saving.

[bleutzinn]

Thanks flaviocopes. I've changed $page->frontmatter(Yaml::dump((array) $page->header(), 10, 2, false)); to simply $page->frontmatter(Yaml::dump((array) $page->header()));. Actually, the YAML frontmatter output reflects the data structure of $form->value()->toArray().

With four checkboxes in the form named tag1 to tag4 with only checkboxes tag2 and tag3 checked and the other two unchecked, when not using use keys, as the OP reported, the output is:

taxonomy:
    tag:
        taxonomy.tag-tag2: tag2
        taxonomy.tag-tag3: tag3

Pages with frontmatter in the above format are found when using {% for post in taxonomy.findTaxonomy({'tag':['tag3']}) %} in a template. It's not a pretty sight but it works.

With the addition of use: keys as you suggested, the YAML output becomes:

taxonomy:
    tag:
        tag2: true
        tag3: true

However, with this format pages with this tags can not be found using {% for post in taxonomy.findTaxonomy({'tag':['tag3']}) %}. Nor by {'tag3':['true']} or {'tag3':[true]}.

The above format is initially displayed as such in the Admin. Things get really weird when you edit this frontmatter in Admin and, for instance, change tag3: true to tag4: true. After doing so and saving the page in Admin suddenly the frontmatter is shown as:

taxonomy:
    tag:
        - '1'
        - '1'