cwrc / islandora_cwrc_basexdb

Offers increased flexibility of querying/analysis by indexing XML content within a read-only XML Database. This module connects Islandora/Fedora to an XML database.
GNU General Public License v3.0
0 stars 2 forks source link

Use module machine name as key in hook_requirements(). #1

Open mparker17 opened 7 years ago

mparker17 commented 7 years ago

Problem / motivation

As a site administrator, I want separate status report items for islandora_cwrc_basexdb and islandora_cwrc_writer so that I can tell whether each module is working independently of the other. As a site administrator, I don't want to see unnecessary "Array to string conversion errors" when I go to the status report page or in my log messages, so that I can spend less time administrating the site and important messages do not get lost in the noise.

Previously, in hook_requirements(), this module prefixed all of its status information under the key cwrc, which conflicted with the islandora_cwrc_writer module (see discoverygarden/islandora_cwrc_writer#75 for a change to that module), and also caused "Array to string conversion" errors on the site's status report as two unrelated status lines were mashed together.

Proposed resolution

Prefix all of this module's status information under a key with the same machine name as the module.

Remaining tasks

User interface changes

The status report lines for islandora_cwrc_basexdb and islandora_cwrc_writer are now separate.

API changes

Anything wishing to override the status report item for this module must now override the requirement with key islandora_cwrc_basexdb.

Data model changes

None.