parseSnippets filter does not render component markup override

[jeremymouton]

The parseSnippets filter does not render component markup override, but only the default markup.

I have a plugin with a component which is also registered as a snippet using the registerPageSnippets() function. This component has default markup, but I override the component's markup in the partials directory of my theme.

When editing a page, adding the component's snippet to the default "Content" field (output using {% page %}) renders correctly using the component's markup override in the partials directory – but when I add it to a custom richeditor field using the parseSnippets filter (like {{ my_custom_field | parseSnippets }}), it renders the component's default markup.

Removing the unique aliasing from the registerComponentSnippet() function (https://github.com/inetis-ch/oc-richeditorsnippets-plugin/blob/dev/classes/SnippetLoader.php#L26-L27) fixes this issue – but I don't know what might break in the process of removing this line. Do you know what the unique alias is meant to do?

[Fl0Cri]

Sorry for the late reply, we were busy this end of year.

As you found it, overrides in OctoberCMS are based on the alias of the component. If I remember correctly there is no other way to do it (overriding by component name would be great for example).

In this plugin we need the unique aliasing because if we have multiple instances of the same component with different parameters, the alias must be different. If it is not, only the first one is rendered multiple times.
Removing the unique aliasing will work if you only use one instance of each component per page.

[tobias-kuendig]

If we add some special token like inetis_richeditorsnippets to the component's auto-generated alias, we might be able to use the cms.page.beforeRenderPartial event to clean up the component's alias and look for the partial manually.

https://github.com/octobercms/october/blob/develop/modules/cms/classes/Controller.php#L959

[Fl0Cri]

Thanks @tobias-kuendig for the suggestion, maybe it is possible after all.

It would be great to support this feature, but unfortunately we have not a lot of time these days to develop and test it.
If someone is interested in providing a PR, we'll be happy to review it.

[chocolata]

Hi guys, did anyone figure out this issue? I'm loving the richeditor snippets plugin and rely heavily on it in my projects. It would be great to keep using the construction {% filter parseSnippets %} in our projects as it is a great global solution. Thanks.

[Fl0Cri]

Hi, there may be a possibility of doing this, but it would require some time to implement and test it. Feel free to open a Pull Request if you want to look into this.

A possible implementation, as described above, could be:

1. When we generate the component alias here, prepend a special token so we can identify it later
2. In the Plugin.php, lsiten to the cms.page.beforeRenderPartial event.
3. When this event is called, test if we see a name starting with our token. We should be able to find back the original name of the component using the cache and try to load its partial from the theme (something like this, but we probably can simplify things a bit)