Encapsulated Plugins

[niccol]

Maybe I am misunderstanding.

I thought that I could simply reproduce the admin structure in the plugin package. So, I could put extra_functions in

/zc_plugins/package/version1/admin/functions/extra_functions

and they would get loaded. This does not happen.

Here's the relevant code from application_bootstrap.php

This does not work for functions

$fs = FileSystem::getInstance();
$fs->setInstalledPlugins($installedPlugins);
$fs->loadFilesFromPluginsDirectory($installedPlugins, 'admin/includes/extra_configures', '~^[^\._].*\.php$~i');
$fs->loadFilesFromPluginsDirectory($installedPlugins, 'admin/includes/extra_datafiles', '~^[^\._].*\.php$~i');

If I do this then it works for functions

$fs = FileSystem::getInstance();
$fs->setInstalledPlugins($installedPlugins);
$fs->loadFilesFromPluginsDirectory($installedPlugins, 'admin/includes/extra_configures', '~^[^\._].*\.php$~i');
$fs->loadFilesFromPluginsDirectory($installedPlugins, 'admin/includes/extra_datafiles', '~^[^\._].*\.php$~i');
$fs->loadFilesFromPluginsDirectory($installedPlugins, 'admin/includes/functions/extra_functions', '~^[^\._].*\.php$~i');

I am reluctant to do a PR because I don't really know the bigger picture here. But am happy to do so if required.

[mc12345678]

So, I overcame that "issue" by doing a check for a function that I expected would be relatively "constant"/remain and if it was not present then to load the associated extra_functions file using the associated relative path to load it from this plugin, but... I see the "preferred" fix as placing the function into a class that is used/called by the code instead of being a "global" function loaded for all to access...

That said, it appears that the documentation specifically omits discussion of admin/includes/functions, though that possibly also is because it is following what has been designed not necessarily what is desired... (https://docs.zen-cart.com/dev/plugin...ory_structure/) That said also though, there is no "warning" about conversion concerns for those that use the admin's extra_functions folder... (https://docs.zen-cart.com/dev/plugin...ns/converting/)

[carlwhat]

considering we are within an encapsulated plugin, what is the downside to putting any needed functions into the extra_datafiles directory?

[niccol]

Hmm, well, it is easy enough to sidestep and find some way to make the code work. It may be that there is a "preferred" way to do this.

Conceptually, the idea seems to be that the structure and functionality in the plugin admin directory is the same as that in the main admin directory. That is a simple and easy concept to understand. If the functionality was different in the two directories - as it is currently - I would say that is sub-optimal.

Whether or not it is better to use class methods or functions is a discussion that goes on forever and isn't relevant here. If the architecture forces one to go the class route in the plugin admin, then are we moving that way in the 'real' admin. If we are not then there is an inconsistency that is a bigger problem than "class or function". The reason that it is a bigger problem is that it takes a lot more knowledge of the architecture to explain it than it does to explain 'we only use class methods' . You have to say something like " we normally allow functions but there are some cases in which we don't and you have to look those up or know them from experience". My vote is for architectural consistency.

[carlwhat]

hmm... the discussion is not really about class v function... if it were, i am so much more a fan of classes, which can be extended, than functions, which seems to be more of the ZC way of doing things. but as you say, this is not what this discussion is about...

the question is whether the inclusion of functions in the extra_datafiles (or extra_configures) directory represents a problem or not....

i agree with you that, ideally, everything should be consistent.

i know that for my clients, when i do modifications that include extra functions, i put them all in one file in the extra_datafiles directory. so at least i am being consistent!

[swguy]

This might be a bug - I'm not sure. Would you please open an issue on Github with repro instructions? Thanks.

[niccol]

Thanks Scott, done.