I'm looking into this module to solve issues associated with trying to build a set of site documentation. One aspect of the API I found confusing is that although the module name and UI refer to "import" and "export", the hook for engines is called hook_engines_get_put(), and its operations are "get" and "put." Initially I thought that my engine wasn't working, since I had coded it to be a 'get' type (thinking, "get" stuff from the database and display it, vs. "put" stuff back into the database). I finally found it on the import options screen, and realized my mistake.

Feel free to won't fix if you want to -- just figured I'd give my opinion as someone new to the API. :) And IMO using the same words consistently throughout would make the API more intuitive.

Comments

redmonp’s picture

There is probably a way to make the terminology more intuitive. From a programming standpoint, get and put would be similar to getting and posting variables. This is confusing if you are getting variables which control importing and exporting information. The problem is inherent with the API, as you are performing both the programmatic and the power user side of the module, both of which deal with data manipulation.

I'm unsure as to how to clarify this intuitively. I suppose a start would be to more explicitly state this on some online docs.

Anonymous’s picture

Version: master » 6.x-1.x-dev