NavigationMenuItemDAO.inc.php

<?php
 
import('lib.pkp.classes.navigationMenu.NavigationMenu');
import('lib.pkp.classes.navigationMenu.NavigationMenuItem');
 
class NavigationMenuItemDAO extends DAO {
   function getById($navigationMenuItemId) {
      $params = array((int) $navigationMenuItemId);
      $result = $this->retrieve(
         'SELECT  * FROM navigation_menu_items WHERE navigation_menu_item_id = ?',
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getByPath($contextId, $path) {
      $params = array($path, (int) $contextId, 'NMI_TYPE_CUSTOM');
      $result = $this->retrieve(
         'SELECT  * FROM navigation_menu_items WHERE path = ? and context_id = ? and type= ?',
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getByContextId($contextId) {
      $params = array((int) $contextId);
      $result = $this->retrieve(
         'SELECT * FROM navigation_menu_items WHERE context_id = ?',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   public function getByMenuId($menuId) {
      $params = array((int) $menuId);
      $result = $this->retrieve(
         'SELECT nmi.*
            FROM navigation_menu_item_assignments as nmh
            LEFT JOIN navigation_menu_items as nmi ON (nmh.navigation_menu_item_id = nmi.navigation_menu_item_id)
            WHERE nmh.navigation_menu_id = ?
            ORDER BY nmh.seq',
         $params
      );
 
         return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   public function getByTypeAndTitleLocaleKey($contextId, $menuItemType, $menuItemTitleLocaleKey) {
      $params = array(
         $menuItemType,
         $menuItemTitleLocaleKey,
         (int) $contextId
      );
      $result = $this->retrieve(
         'SELECT *
            FROM navigation_menu_items
            LEFT JOIN navigation_menu_item_settings ON (navigation_menu_items.navigation_menu_item_id = navigation_menu_item_settings.navigation_menu_item_id)
            WHERE navigation_menu_items.type = ?
            AND (navigation_menu_item_settings.setting_name = \'titleLocaleKey\' and navigation_menu_item_settings.setting_value = ?)
            AND navigation_menu_items.context_id = ?',
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
 
      return $returner;
   }
 
   function getByType($type, $contextId = null) {
      $params = array($type);
      if ($contextId !== null) {
         $params[] = $contextId;
      }
      $result = $this->retrieve(
         'SELECT  * FROM navigation_menu_items WHERE type = ?' .
         ($contextId !== null ? ' AND context_id = ?' : ''),
         $params
      );
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getLocaleFieldNames() {
      return array('title', 'content', 'remoteUrl');
   }
 
   function getAdditionalFieldNames() {
      return array('titleLocaleKey');
   }
 
   function newDataObject() {
      return new NavigationMenuItem();
   }
 
   function _fromRow($row, $dataObject = false) {
      $navigationMenuItem = $this->newDataObject();
      $navigationMenuItem->setId($row['navigation_menu_item_id']);
      $navigationMenuItem->setContextId($row['context_id']);
      $navigationMenuItem->setType($row['type']);
      $navigationMenuItem->setPath($row['path']);
 
      $this->getDataObjectSettings('navigation_menu_item_settings', 'navigation_menu_item_id', $row['navigation_menu_item_id'], $navigationMenuItem);
 
      return $navigationMenuItem;
   }
 
   function updateLocaleFields($navigationMenuItem) {
      $this->updateDataObjectSettings('navigation_menu_item_settings', $navigationMenuItem, array(
         'navigation_menu_item_id' => $navigationMenuItem->getId()
      ));
   }
 
   function insertObject($navigationMenuItem) {
      $this->update(
            'INSERT INTO navigation_menu_items
            (path, context_id, type)
            VALUES
            (?, ?, ?)',
         array(
            $navigationMenuItem->getPath(),
            (int) $navigationMenuItem->getContextId(),
            $navigationMenuItem->getType(),
         )
      );
      $navigationMenuItem->setId($this->getInsertId());
      $this->updateLocaleFields($navigationMenuItem);
 
      $this->unCacheRelatedNavigationMenus($navigationMenuItem->getId());
 
      return $navigationMenuItem->getId();
   }
 
   function updateObject($navigationMenuItem) {
      $returner = $this->update(
            'UPDATE navigation_menu_items
            SET
               path = ?,
               context_id = ?,
               type = ?
            WHERE navigation_menu_item_id = ?',
         array(
            $navigationMenuItem->getPath(),
            (int) $navigationMenuItem->getContextId(),
            $navigationMenuItem->getType(),
            (int) $navigationMenuItem->getId(),
         )
      );
      $this->updateLocaleFields($navigationMenuItem);
 
      $this->unCacheRelatedNavigationMenus($navigationMenuItem->getId());
 
      return $returner;
   }
 
   function deleteObject($navigationMenuItem) {
      return $this->deleteById($navigationMenuItem->getId());
   }
 
   function deleteById($navigationMenuItemId) {
      $this->unCacheRelatedNavigationMenus($navigationMenuItemId);
 
      $this->update('DELETE FROM navigation_menu_item_settings WHERE navigation_menu_item_id = ?', (int) $navigationMenuItemId);
      $this->update('DELETE FROM navigation_menu_items WHERE navigation_menu_item_id = ?', (int) $navigationMenuItemId);
 
      $navigationMenuItemAssignmentDao = DAORegistry::getDAO('NavigationMenuItemAssignmentDAO'); /* @var $navigationMenuItemAssignmentDao NavigationMenuItemAssignmentDAO */
      $navigationMenuItemAssignmentDao->deleteByMenuItemId($navigationMenuItemId);
   }
 
   function deleteByContextId($contextId) {
      $navigationMenuItems = $this->getByContextId($contextId);
 
      while ($navigationMenuItem = $navigationMenuItems->next()) {
         $this->deleteObject($navigationMenuItem);
      }
   }
 
   function getInsertId() {
      return $this->_getInsertId('navigation_menu_items', 'navigation_menu_item_id');
   }
 
   function installSettings($contextId, $filename) {
      $xmlParser = new XMLParser();
      $tree = $xmlParser->parse($filename);
 
      if ($contextId == CONTEXT_ID_NONE) {
         $siteDao = DAORegistry::getDAO('SiteDAO'); /* @var $siteDao SiteDAO */
         $site = $siteDao->getSite();
      }
 
      if (!$tree) return false;
 
      foreach ($tree->getChildren() as $setting) {
         $site = $setting->getAttribute('site');
 
         if ($contextId == CONTEXT_ID_NONE && !$site) {
            continue;
         }
 
         $this->installNodeSettings($contextId, $setting, null, null, 0, true);
      }
 
      return true;
   }
 
   function installNodeSettings($contextId, $node, $navigationMenuId = null, $navigationMenuItemParentId = null, $seq = 0, $checkChildren = false) {
      $titleKey = $node->getAttribute('title');
      $path = $node->getAttribute('path');
      $type = $node->getAttribute('type');
 
      $navigationMenuItemExisting = $this->getByTypeAndTitleLocaleKey($contextId, $type, $titleKey);
 
      if (!isset($navigationMenuItemExisting)) {
         $navigationMenuItem = $this->newDataObject();
         $navigationMenuItem->setPath($path);
         $navigationMenuItem->setContextId($contextId);
 
         $navigationMenuItem->setType($type);
 
         $navigationMenuItemId = $this->insertObject($navigationMenuItem);
 
         // add the i18n keys to the settings table so that they
         // can be used when a new locale is added/reloaded
         $this->updateSetting($navigationMenuItemId, 'titleLocaleKey', $titleKey);
      } else {
         $navigationMenuItemId = $navigationMenuItemExisting->getId();
 
         $this->updateSetting($navigationMenuItemId, 'titleLocaleKey', $titleKey);
      }
 
      // insert into Assignments
      if ($navigationMenuId) {
         $navigationMenuItemAssignmentDao = DAORegistry::getDAO('NavigationMenuItemAssignmentDAO'); /* @var $navigationMenuItemAssignmentDao NavigationMenuItemAssignmentDAO */
         $assignmentExists = $navigationMenuItemAssignmentDao->getByNMIIdAndMenuIdAndParentId($navigationMenuItemId, $navigationMenuId, $navigationMenuItemParentId);
 
         if (!isset($assignmentExists)) {
            $navigationMenuItemAssignment = $navigationMenuItemAssignmentDao->newDataObject();
 
            $navigationMenuItemAssignment->setMenuItemId($navigationMenuItemId);
            $navigationMenuItemAssignment->setMenuId($navigationMenuId);
 
            if ($navigationMenuItemParentId) {
               $navigationMenuItemAssignment->setParentId($navigationMenuItemParentId);
            }
 
            $navigationMenuItemAssignment->setSequence($seq);
 
            // Insert Assignment
            $navigationMenuItemAssignmentDao->insertObject($navigationMenuItemAssignment);
         }
      }
 
      if ($checkChildren) {
         $seqSec = 0;
 
         foreach ($node->getChildren() as $navigationMenuItemSecondLevelNode) {
            $this->installNodeSettings($contextId, $navigationMenuItemSecondLevelNode, $navigationMenuId, $navigationMenuItemId, $seqSec, false);
            $seqSec++;
         }
      }
 
      return true;
   }
 
   function updateSetting($navigationMenuItemId, $name, $value, $type = null, $isLocalized = false) {
      $keyFields = array('setting_name', 'locale', 'navigation_menu_item_id');
 
      if (!$isLocalized) {
         $value = $this->convertToDB($value, $type);
         $this->replace('navigation_menu_item_settings',
            array(
               'navigation_menu_item_id' => (int) $navigationMenuItemId,
               'setting_name' => $name,
               'setting_value' => trim($value,'##'),
               'setting_type' => $type,
               'locale' => ''
            ),
            $keyFields
         );
      } else {
         if (is_array($value)) foreach ($value as $locale => $localeValue) {
            $this->update('DELETE FROM navigation_menu_item_settings WHERE navigation_menu_item_id = ? AND setting_name = ? AND locale = ?', array((int) $navigationMenuItemId, $name, $locale));
            if (empty($localeValue)) continue;
            $type = null;
            $this->update('INSERT INTO navigation_menu_item_settings
               (navigation_menu_item_id, setting_name, setting_value, setting_type, locale)
               VALUES (?, ?, ?, ?, ?)',
               array(
                  $navigationMenuItemId, $name, trim($this->convertToDB($localeValue, $type),'##'), $type, $locale
               )
            );
         }
      }
   }
 
   function getSetting($navigationMenuItemId, $name, $locale = null) {
      $params = array((int) $navigationMenuItemId, $name);
      if ($locale) $params[] = $locale;
      $result = $this->retrieve(
         'SELECT  setting_name, setting_value, setting_type, locale
         FROM  navigation_menu_item_settings
         WHERE navigation_menu_item_id = ? AND
            setting_name = ?' .
            ($locale?' AND locale = ?':''),
         $params
      );
 
      $recordCount = $result->RecordCount();
      $returner = false;
      if ($recordCount == 1) {
         $row = $result->getRowAssoc(false);
         $returner = $this->convertFromDB($row['setting_value'], $row['setting_type']);
      } elseif ($recordCount > 1) {
         $returner = array();
         while (!$result->EOF) {
            $returner[$row['locale']] = $this->convertFromDB($row['setting_value'], $row['setting_type']);
            $result->MoveNext();
         }
 
         $result->Close();
      }
 
      return $returner;
   }
 
   function deleteSettingsByLocale($locale) {
      return $this->update('DELETE FROM navigation_menu_item_settings WHERE locale = ?', $locale);
   }
 
   function unCacheRelatedNavigationMenus($id) {
      $navigationMenuDao = \DAORegistry::getDAO('NavigationMenuDAO');
      $navigationMenuItemAssignmentDao = \DAORegistry::getDAO('NavigationMenuItemAssignmentDAO');
      $assignments = $navigationMenuItemAssignmentDao->getByMenuItemId($id);
      if ($assignments) {
         $assignmentsArray = $assignments->toArray();
         foreach ($assignmentsArray as $assignment) {
            $cache = $navigationMenuDao->getCache($assignment->getMenuId());
            if ($cache) $cache->flush();
         }
      }
   }
 
   function portStaticPage($staticPage) {
      $path = $staticPage->getPath();
      $contextId = $staticPage->getContextId();
 
      $existingNMIWithPath = $this->getByPath($contextId, $path);
 
      $retNavigationMenuItemId = null;
 
      if (!isset($existingNMIWithPath)) {
         $navigationMenuItem = $this->newDataObject();
 
         $navigationMenuItem->setPath($path);
         $navigationMenuItem->setContextId($contextId);
         $navigationMenuItem->setType(NMI_TYPE_CUSTOM);
 
         $navigationMenuItem->setTitle($staticPage->getTitle(null), null);
         $navigationMenuItem->setContent($staticPage->getContent(null), null);
 
         $retNavigationMenuItemId = $this->insertObject($navigationMenuItem);
      }
 
      return $retNavigationMenuItemId;
   }
}