FormComponent.inc.php

<?php
namespace PKP\components\forms;
 
define('FIELD_POSITION_BEFORE', 'before');
define('FIELD_POSITION_AFTER', 'after');
 
class FormComponent {
   public $id = '';
 
   public $method = '';
 
   public $action = '';
 
   public $locales = [];
 
   public $fields = [];
 
   public $groups = [];
 
   public $pages = [];
 
   public $errors = [];
 
   public function __construct($id, $method, $action, $locales) {
      $this->id = $id;
      $this->action = $action;
      $this->method = $method;
      $this->locales = $locales;
   }
 
   public function addField($field, $position = []) {
      if (empty($position)) {
         $this->fields[] = $field;
      } else {
         $this->fields = $this->addToPosition($position[1], $this->fields, $field, $position[0]);
      }
      return $this;
   }
 
   public function removeField($fieldName) {
      $this->fields = array_filter($this->fields, function($field) use ($fieldName) {
         return $field->name !== $fieldName;
      });
      return $this;
   }
 
   public function getField($fieldName) {
      foreach ($this->fields as $field) {
         if ($field->name === $fieldName) {
            return $field;
         }
      }
      return null;
   }
 
   public function addGroup($args, $position = []) {
      if (empty($args['id'])) {
         fatalError('Tried to add a form group without an id.');
      }
      if (empty($position)) {
         $this->groups[] = $args;
      } else {
         $this->groups = $this->addToPosition($position[1], $this->groups, $args, $position[0]);
      }
      return $this;
   }
 
   public function removeGroup($groupId) {
      $this->groups = array_filter($this->groups, function($group) use ($groupId) {
         return $group['id'] !== $groupId;
      });
      $this->fields = array_filter($this->fields, function($field) use ($groupId) {
         return $field['groupId'] !== $groupId;
      });
      return $this;
   }
 
   public function addPage($args, $position = []) {
      if (empty($args['id'])) {
         fatalError('Tried to add a form page without an id.');
      }
      if (empty($position)) {
         $this->pages[] = $args;
      } else {
         $this->pages = $this->addToPosition($position[1], $this->pages, $args, $position[0]);
      }
      return $this;
   }
 
   public function removePage($pageId) {
      $this->pages = array_filter($this->pages, function($page) use ($pageId) {
         return $page['id'] !== $pageId;
      });
      foreach ($this->groups as $group) {
         if ($group['pageId'] === $pageId) {
            $this->removeGroup($group['id']);
         }
      }
      return $this;
   }
 
   public function addToPosition($id, $list, $item, $position) {
      $index = count($list);
      foreach ($list as $key => $val) {
         if ((is_a($val, 'PKP\components\forms\Field') && $id === $val->name) || (!is_a($val, 'PKP\components\forms\Field') && $id === $val['id'])) {
            $index = $key;
            break;
         }
      }
      if (!$index && $position === FIELD_POSITION_BEFORE) {
         array_unshift($list, $item);
         return $list;
      }
 
      $slice = $position === FIELD_POSITION_BEFORE ? $index : $index + 1;
 
      return array_merge(
         array_slice($list, 0, $slice),
         [$item],
         array_slice($list, $slice)
      );
   }
 
   public function getConfig() {
 
      if (empty($this->id) || empty($this->method) || empty($this->action)) {
         throw new Exception('FormComponent::getConfig() was called but one or more required property is missing: id, method, action.');
      }
 
      \HookRegistry::call('Form::config::before', $this);
 
      // Add a default page/group if none exist
      if (!$this->groups) {
         $this->addGroup(array('id' => 'default'));
         $this->fields = array_map(function($field) {
            $field->groupId = 'default';
            return $field;
         }, $this->fields);
      }
 
      if (!$this->pages) {
         $this->addPage(array('id' => 'default', 'submitButton' => array('label' => __('common.save'))));
         $this->groups = array_map(function($group) {
            $group['pageId'] = 'default';
            return $group;
         }, $this->groups);
      }
 
      $fieldsConfig = array_map([$this, 'getFieldConfig'], $this->fields);
 
      $visibleLocales = [\AppLocale::getLocale()];
      if (\AppLocale::getLocale() !== \AppLocale::getPrimaryLocale()) {
         array_unshift($visibleLocales, \AppLocale::getPrimaryLocale());
      }
 
      $config = array(
         'id' => $this->id,
         'method' => $this->method,
         'action' => $this->action,
         'fields' => $fieldsConfig,
         'groups' => $this->groups,
         'pages' => $this->pages,
         'primaryLocale' => \AppLocale::getPrimaryLocale(),
         'visibleLocales' => $visibleLocales,
         'supportedFormLocales' => array_values($this->locales), // See #5690
         'errors' => (object) [],
      );
 
      \HookRegistry::call('Form::config::after', array(&$config, $this));
 
      return $config;
   }
 
   public function getFieldConfig($field) {
      $config = $field->getConfig();
 
      // Add a value property if the field does not include one
      if (!array_key_exists('value', $config)) {
         $config['value'] = $field->isMultilingual ? array() : $field->getEmptyValue();
      }
      if ($field->isMultilingual) {
         foreach ($this->locales as $locale) {
            if (!array_key_exists($locale['key'], $config['value'])) {
               $config['value'][$locale['key']] = $field->getEmptyValue();
            }
         }
      }
 
      return $config;
   }
}