PKPNavigationMenuItemsForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class PKPNavigationMenuItemsForm extends Form {
   var $navigationMenuItemId;
 
   var $_contextId;
 
   function __construct($contextId, $navigationMenuItemId) {
      $this->_contextId = $contextId;
      $this->navigationMenuItemId = $navigationMenuItemId;
 
      parent::__construct('controllers/grid/navigationMenus/form/navigationMenuItemsForm.tpl');
 
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
 
   //
   // Getters and setters.
   //
 
   function getContextId() {
      return $this->_contextId;
   }
 
 
   //
   // Extended methods from Form.
   //
 
   function fetch($request, $template = null, $display = false) {
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_MANAGER);
 
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('navigationMenuItemId', $this->navigationMenuItemId);
 
      $context = $request->getContext();
      if ($context) $templateMgr->assign('allowedVariables', array(
         'contactName' => __('plugins.generic.tinymce.variables.principalContactName', array('value' => $context->getData('contactName'))),
         'contactEmail' => __('plugins.generic.tinymce.variables.principalContactEmail', array('value' => $context->getData('contactEmail'))),
         'supportName' => __('plugins.generic.tinymce.variables.supportContactName', array('value' => $context->getData('supportName'))),
         'supportPhone' => __('plugins.generic.tinymce.variables.supportContactPhone', array('value' => $context->getData('supportPhone'))),
         'supportEmail' => __('plugins.generic.tinymce.variables.supportContactEmail', array('value' => $context->getData('supportEmail'))),
      ));
      import('classes.core.Services');
      $types = Services::get('navigationMenu')->getMenuItemTypes();
 
      $typeTitles = array(0 => __('grid.navigationMenus.navigationMenu.selectType'));
      foreach ($types as $type => $settings) {
         $typeTitles[$type] = $settings['title'];
      }
 
      $typeDescriptions = array();
      foreach ($types as $type => $settings) {
         $typeDescriptions[$type] = $settings['description'];
      }
 
      $typeConditionalWarnings = array();
      foreach ($types as $type => $settings) {
         if (array_key_exists('conditionalWarning', $settings)) {
            $typeConditionalWarnings[$type] = $settings['conditionalWarning'];
         }
      }
 
      $customTemplates = Services::get('navigationMenu')->getMenuItemCustomEditTemplates();
 
      $templateArray = array(
         'navigationMenuItemTypeTitles' => $typeTitles,
         'navigationMenuItemTypeDescriptions' => json_encode($typeDescriptions),
         'navigationMenuItemTypeConditionalWarnings' => json_encode($typeConditionalWarnings),
         'customTemplates' => $customTemplates,
      );
 
      $templateMgr->assign($templateArray);
 
      return parent::fetch($request, $template, $display);
   }
 
   function initData() {
      $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
      $navigationMenuItem = $navigationMenuItemDao->getById($this->navigationMenuItemId);
 
      if ($navigationMenuItem) {
         Services::get('navigationMenu')
            ->setAllNMILocalisedTitles($navigationMenuItem);
         
         $formData = array(
            'path' => $navigationMenuItem->getPath(),
            'title' => $navigationMenuItem->getTitle(null),
            'url' => $navigationMenuItem->getUrl(),
            'menuItemType' => $navigationMenuItem->getType(),
         );
 
         $this->_data =  $formData;
 
         $this->setData('content', $navigationMenuItem->getContent(null)); // Localized
         $this->setData('remoteUrl', $navigationMenuItem->getRemoteUrl(null)); // Localized
      }
   }
 
   function readInputData() {
      $this->readUserVars(array('navigationMenuItemId', 'path', 'content', 'title', 'remoteUrl', 'menuItemType'));
   }
 
   function getLocaleFieldNames() {
      $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
      return $navigationMenuItemDao->getLocaleFieldNames();
   }
 
   function execute(...$functionParams) {
      parent::execute(...$functionParams);
 
      $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
 
      $navigationMenuItem = $navigationMenuItemDao->getById($this->navigationMenuItemId);
      if (!$navigationMenuItem) {
         $navigationMenuItem = $navigationMenuItemDao->newDataObject();
         $navigationMenuItem->setTitle($this->getData('title'), null);
      } else {
         $localizedTitlesFromDB = $navigationMenuItem->getTitle(null);
 
         Services::get('navigationMenu')
            ->setAllNMILocalisedTitles($navigationMenuItem);
         
         $localizedTitles = $navigationMenuItem->getTitle(null);
         $inputLocalisedTitles = $this->getData('title');
         foreach ($localizedTitles as $locale => $title) {
            if ($inputLocalisedTitles[$locale] != $title) {
               if (!isset($inputLocalisedTitles[$locale]) || trim($inputLocalisedTitles[$locale]) == '') {
                  $navigationMenuItem->setTitle(null, $locale);
               } else {
                  $navigationMenuItem->setTitle($inputLocalisedTitles[$locale], $locale);
               }
            } else {
               if (!$localizedTitlesFromDB 
                  || !array_key_exists($locale, $localizedTitlesFromDB)) {
                  $navigationMenuItem->setTitle(null, $locale);
               }
            }
         }
      }
 
      $navigationMenuItem->setPath($this->getData('path'));
      $navigationMenuItem->setContent($this->getData('content'), null); // Localized
      $navigationMenuItem->setContextId($this->getContextId());
      $navigationMenuItem->setRemoteUrl($this->getData('remoteUrl'), null); // Localized
      $navigationMenuItem->setType($this->getData('menuItemType'));
 
      // Update or insert navigation menu item
      if ($navigationMenuItem->getId()) {
         $navigationMenuItemDao->updateObject($navigationMenuItem);
      } else {
         $navigationMenuItemDao->insertObject($navigationMenuItem);
      }
 
      $this->navigationMenuItemId = $navigationMenuItem->getId();
 
      return $navigationMenuItem->getId();
   }
 
   function validate($callHooks = true) {
      import('lib.pkp.classes.navigationMenu.NavigationMenuItem');
      if ($this->getData('menuItemType') && $this->getData('menuItemType') != "") {
         if ($this->getData('menuItemType') == NMI_TYPE_CUSTOM) {
            if (!preg_match('/^[a-zA-Z0-9\/._-]+$/', $this->getData('path'))) {
               $this->addError('path', __('manager.navigationMenus.form.pathRegEx'));
            }
 
            $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
 
            $navigationMenuItem = $navigationMenuItemDao->getByPath($this->_contextId, $this->getData('path'));
            if (isset($navigationMenuItem) && $navigationMenuItem->getId() != $this->navigationMenuItemId) {
               $this->addError('path', __('manager.navigationMenus.form.duplicatePath'));
            }
         } elseif ($this->getData('menuItemType') == NMI_TYPE_REMOTE_URL) {
            $remoteUrls = $this->getData('remoteUrl');
            foreach ($remoteUrls as $remoteUrl) {
               if(!filter_var($remoteUrl, FILTER_VALIDATE_URL)) {
                  $this->addError('remoteUrl', __('manager.navigationMenus.form.customUrlError'));
               }
            }
         }
      } else {
         $this->addError('path', __('manager.navigationMenus.form.typeMissing'));
      }
 
      return parent::validate($callHooks);
   }
 
}