Better version handling

omeka-s-modules · Apr 25, 2023 · 6515b91 · 6515b91
1 parent ba53b50
commit 6515b91
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 33 deletions.
diff --git a/src/Api/Representation/CollectingFormRepresentation.php b/src/Api/Representation/CollectingFormRepresentation.php
@@ -2,9 +2,11 @@
 namespace Collecting\Api\Representation;
 
 use Collecting\Form\Element;
+use Composer\Semver\Comparator;
 use Omeka\Api\Exception\BadRequestException;
 use Omeka\Api\Exception\NotFoundException;
 use Omeka\Api\Representation\AbstractEntityRepresentation;
+use Omeka\Module\Manager as ModuleManager;
 use Laminas\Form\Form;
 use Laminas\Http\PhpEnvironment\RemoteAddress;
 
@@ -127,8 +129,13 @@ public function getForm()
         $mediaTypes = $this->getServiceLocator()->get('Collecting\MediaTypeManager');
         $api = $this->getServiceLocator()->get('Omeka\ApiManager');
         $auth = $this->getServiceLocator()->get('Omeka\AuthenticationService');
+        $modules = $this->getServiceLocator()->get('Omeka\ModuleManager');
         $user = $auth->getIdentity(); // returns a User entity or null
 
+        $customVocabModule = $modules->getModule('CustomVocab');
+        $customVocabVersion = $customVocabModule ? $customVocabModule->getDb('version') : null;
+        $customVocabActive = $customVocabModule && ModuleManager::STATE_ACTIVE === $customVocabModule->getState();
+
         $form = new Form(sprintf('collecting_form_%s', $this->id()));
         $this->form = $form; // cache the form
         $form->setAttribute('action', $url('site/collecting', [
@@ -172,43 +179,29 @@ public function getForm()
                             $element = new Element\PromptUrl($name);
                             break;
                         case 'custom_vocab':
+                            if (!$customVocabActive) {
+                                continue 3; // CustomVocab module must be active
+                            }
                             try {
                                 $customVocab = $api->read('custom_vocabs', $prompt->customVocab())->getContent();
                             } catch (NotFoundException $e) {
-                                // The custom vocab does not exist.
-                                continue 3;
-                            } catch (BadRequestException $e) {
-                                // The CustomVocab module is not installed or active.
-                                continue 3;
+                                continue 3; // The custom vocab does not exist
+                            }
+                            // Adjust handling as new CustomVocab features were introduced.
+                            //   - Items type introduced in v1.2.0
+                            //   - URIs type introduced in v1.4.0
+                            //   - Type methods return arrays in v1.7.0
+                            if (!$customVocab->terms()) {
+                                continue 3; // URIs and Items vocab types not implemented
                             }
-                            $isNewerVersion = method_exists($customVocab, 'uris');
-                            if ($isNewerVersion) {
-                                // This is a newer version of CustomVocab. Use the
-                                // original heuristic to determine which vocab type
-                                // is used.
-                                if ($customVocab->itemSet()) {
-                                    // "Items" type not implemented
-                                    continue 3;
-                                } elseif ($customVocab->uris()) {
-                                    // "Uris" type not implemented
-                                    continue 3;
-                                } elseif ($customVocab->terms()) {
-                                    // On newer versions, terms could be a newline
-                                    // -delimited string or an array.
-                                    $customVocabValues = is_string($customVocab->terms())
-                                        ? array_map('trim', explode(PHP_EOL, $customVocab->terms()))
-                                        : $customVocab->terms();
-                                } else {
-                                    // Invalid type.
-                                    continue 3;
-                                }
+                            if (Comparator::lessThan($customVocabVersion, '1.7.0')) {
+                                $customVocabTerms = array_map('trim', explode(PHP_EOL, $customVocab->terms()));
                             } else {
-                                // This is an older version of CustomVocab.
-                                $customVocabValues = array_map('trim', explode(PHP_EOL, $customVocab->terms()));
+                                $customVocabTerms = $customVocab->terms();
                             }
                             $element = new Element\PromptSelect($name);
                             $element->setEmptyOption('Please choose one...') // @translate
-                                ->setValueOptions(array_combine($customVocabValues, $customVocabValues));
+                                ->setValueOptions(array_combine($customVocabTerms, $customVocabTerms));
                             break;
                         case 'numeric:timestamp':
                             if (!$collecting->inputTypeIsAvailable('numeric:timestamp')) {

diff --git a/src/View/Helper/Collecting.php b/src/View/Helper/Collecting.php
@@ -161,10 +161,8 @@ public function customVocabs()
                 $response = $this->getView()->api()->search('custom_vocabs');
                 $this->customVocabs = [];
                 foreach ($response->getContent() as $customVocab) {
-                    $isNewerVersion = method_exists($customVocab, 'uris');
-                    if ($isNewerVersion && !$customVocab->terms()) {
-                        // The newer "URIs" and "Items" vocab types are not implemented.
-                        continue;
+                    if (!$customVocab->terms()) {
+                        continue; // URIs and Items vocab types not implemented
                     }
                     $this->customVocabs[$customVocab->id()] = $customVocab->label();
                 }