With plugin enabled, onAdminSave event doesn't fire

[mbirth]

Since flex-objects seems to replace the admin plugin's AdminController, the events fired there are not fired. So other plugins using onAdminSave and/or onAdminAfterSave won't work anymore.

[mahagr]

This is basically because of some plugins seem to break if I used the old events. I think we just need to add a few configuration options for the events.

[mahagr]

Events were added in getgrav/grav@3a05dcf

[NicoHood]

I am not sure if this is 100% compatible.

The original code:
https://github.com/getgrav/grav-plugin-admin/blob/06c66794cc391f6d29b0261019b0a850cd0a0b84/classes/admincontroller.php#L666

The new:
getgrav/grav@3a05dcf#diff-01780a944f8c1d48066fed0f8b2391abe743e75a1b13a70ae9a4a938bd2a7a3cR243

I am not sure, I guess page must be renamed to object?

It seems those events are outdated anyways, so can you maybe point us to the new events that are able to modify the page correctly? Also is there an option to query for the grav version to subscribe to different events?

[mahagr]

Already fixed that long time ago:

https://github.com/getgrav/grav/blob/1.7/system/src/Grav/Common/Flex/Types/Pages/PageObject.php#L272

[NicoHood]

Oh, you are right! But what about Switching Flex Page object during onAdminSave event is not supported! Please update plugin., how to migrate that? What is the new event to use?

[mahagr]

It means that you have replaced the page object in your plugin with another one. You shouldn't do that as it breaks the saving.

Instead of doing that, just modify the object before it gets saved.

[NicoHood]

Alright, so nothing will break. Thanks a lot for clarifying :-)

[NicoHood]

In my plugin I am checking the type of the object like this:

if (!($page instanceof \Grav\Common\Page\Page)) {
    return;
}

Now this does not work with the new flexobject. The check is still required, as saving a plugin config also fires this event.

But even if I ignore the check for now all page content is cleared on safe. This is possibly because I am modifying the page and this fails. But no error message is displayed this could be improved. I am still searching for a solution. Is there a common way to support Flexpages and "normal/old" Pages?

Edit: It seems setting page->header() causes trouble for me. It sets the frontmatter to something completely invalid:

"\0*\0items":
    "\0*\0items":
        title: uuuykuyk
        test: ok
        structured_data:
            place:
                name: egf
    "\0*\0nestedSeparator": .
    structured_data:
        place:
            name: Berlin
    '�*�items':
        title: uuuykuyk
        test: ok
        structured_data:
            place:
                name: egf
    '�*�nestedSeparator': .
"\0*\0nestedSeparator": .

You can reproduce with:

public function onAdminSave(Event $event)
{
    $page = $event['object'];
    
    // When saving plugin configurations we should ignore the event
    if (!($page instanceof \Grav\Common\Page\Interfaces\PageInterface)) {
        return;
    }
    
    $header = new Data((array)$page->header());
    $page->header($header->toArray());
}

The getter of header() returns wrong values, here is a json dump:

$this->grav['log']->emergency(json_encode((array)$page->header()));

{"\u0000*\u0000items":{"title":"ok","menu":"ok","test":"ok"},"\u0000*\u0000nestedSeparator":"."}

Is it possible that the header is now a Data object? I've requested that some time ago, but did not notice there was a change made in 1.7
It seems it is of type Grav\Common\Page\Header now.

This is my solution:

$header = $page->header();
if (!($header instanceof \Grav\Common\Page\Header)) {
    $header = new Data((array)$header);
}

[mahagr]

Yes, check against PageInterface, it is common to all page types. Header object as toArray() method, imho.

[NicoHood]

Yeah, but the header is a breaking change that should be noted in the release notes! It is no object anymore it is Grav\Common\Page\Header now. Which makes a difference as you can see!

[mahagr]

Header class has been there since 2015, but it was not used in the event before (not sure why). You should be using something like:

if (!$page instanceof PageInterface) {
    return;
}

$header = $page->header();
if (!$header instanceof Header) {
    $header = new Header((array)$header);
}

The above code should be working starting from Grav 1.6.

[mahagr]

Added note to https://learn.getgrav.org/17/advanced/grav-development/grav-17-upgrade-guide#pages-1

[mahagr]

Also added it to changelog.