Uploaded image for project: 'Islandora'
  1. Islandora
  2. ISLANDORA-1919

Undocumented function signature change in compound SP.

    Details

      Description

      In https://github.com/Islandora/islandora_solution_pack_compound/pull/107 the return of https://github.com/Islandora/islandora_solution_pack_compound/blob/7.x/islandora_compound_object.module#L559-L585 changed. Previously this function return information about the compound only when the object passed in was a compound child. This now returns compound information listing for a parent or a child.

      Seeing as the function signature changed the course of action likely warrants discussion that needs to be considered before the code freeze. Typically, something changing in this extent warrants a deprecation cycle. List of public repositories this function is used: https://github.com/search?p=1&q=islandora_compound_object_retrieve_compound_info&type=Code.

      At discoverygarden this function is used to create TNs for compound parent objects via the derivative hook as shown: https://github.com/rochester-rcl/rochdora/blob/2821107267e1293dc45eddd3e44a8589dd6966c0/includes/derivatives.inc#L52-Lundefined. With that in mind, updating these function calls (and perhaps pushing this back into the compound SP outright at some point) isn't a point of large contention.

      This ticket lives to document the function signature change potentially for the release notes and to bring light to it as there are other people in the community using this in their own code. It also serves as an avenue to begin discussion as to what to do with this, whether it moves to a new function with a different signature, deprecating the old etc.

        Attachments

          Activity

            People

            • Assignee:
              jonathan.green Jonathan Green
              Reporter:
              jordandukart Jordan Dukart
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: