Issue schema hook 3.3.0.11

Dimitris_Sioulas · October 26, 2022, 9:37am

Describe the issue or problem
Is there any hook in order to add extra setting_names (properties) to a hook, a hook name like Schema::get::issue.

I tried it already and I can see it works for Schema::get::publication but not for an issue.

What I need is to intervene and add extra issue settings for the issue form.

Thank you in advance.

touhidur · October 27, 2022, 9:28am

At a quick glance, it seems there is none right now but it should not be too hard to add one . Take a look at some example implementation at

github.com

pkp/pkp-lib/blob/main/classes/plugins/PKPPubIdPlugin.php#L39-L63


      
          public function register($category, $path, $mainContextId = null)
          {
              if (!parent::register($category, $path, $mainContextId)) {
                  return false;
              }
              if ($this->getEnabled($mainContextId)) {
                  // Enable storage of additional fields.
                  foreach ($this->getDAOs() as $dao) {
                      // Augment the object with the additional properties required by the pub ID plugin.
                      if ($dao instanceof SchemaDAO) {
                          // Schema-backed DAOs need the schema extended.
                          Hook::add('Schema::get::' . $dao->schemaName, [$this, 'addToSchema']);
                      } elseif ($dao instanceof EntityDAO) {
                          // Schema-backed DAOs need the schema extended.
                          Hook::add('Schema::get::' . $dao->schema, [$this, 'addToSchema']);
                      } else {
                          // For non-schema-backed DAOs, DAOName::getAdditionalFieldNames can be used.
                          $classNameParts = explode('\\', get_class($dao)); // Separate namespace info from class name
                          Hook::add(strtolower_codesafe(end($classNameParts)) . '::getAdditionalFieldNames', [$this, 'getAdditionalFieldNames']);
                      }

This file has been truncated. show original

github.com

pkp/pkp-lib/blob/main/classes/plugins/PKPPubIdPlugin.php#L398-L409


      
          public function addToSchema($hookName, $params)
          {
              $schema = & $params[0];
              foreach (array_merge($this->getFormFieldNames(), $this->getDAOFieldNames()) as $fieldName) {
                  $schema->properties->{$fieldName} = (object) [
                      'type' => 'string',
                      'apiSummary' => true,
                      'validation' => ['nullable'],
                  ];
              }
              return false;
          }