NavigationMenuDAO.inc.php

<?php
 
import('lib.pkp.classes.navigationMenu.NavigationMenu');
 
class NavigationMenuDAO extends DAO {
   function newDataObject() {
      return new NavigationMenu();
   }
 
   function getById($navigationMenuId, $contextId = null) {
      $params = array((int) $navigationMenuId);
      if ($contextId !== null) $params[] = (int) $contextId;
      $result = $this->retrieve(
         'SELECT * FROM navigation_menus WHERE navigation_menu_id = ?' .
         ($contextId !== null?' AND context_id = ?':''),
         $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_menus WHERE context_id = ?',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getByArea($contextId, $areaName) {
      $params = array($areaName);
      $params[] = (int) $contextId;
      $result = $this->retrieve(
         'SELECT * FROM navigation_menus WHERE area_name = ? and context_id = ?',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getByTitle($contextId, $title) {
      $params = array((int) $contextId);
      $params[] = $title;
      $result = $this->retrieve(
         'SELECT * FROM navigation_menus WHERE context_id = ? and title = ?',
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function navigationMenuExistsByTitle($contextId, $title) {
      $result = $this->retrieve(
         'SELECT COUNT(*)
         FROM  navigation_menus
         WHERE title = ? AND
            context_id = ?',
         array(
            $title,
            (int) $contextId
         )
      );
      $returner = isset($result->fields[0]) && $result->fields[0] != 0 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function getLocaleFieldNames() {
      return array();
   }
 
   function _fromRow($row) {
      $navigationMenu = $this->newDataObject();
      $navigationMenu->setId($row['navigation_menu_id']);
      $navigationMenu->setTitle($row['title']);
      $navigationMenu->setAreaName($row['area_name']);
      $navigationMenu->setContextId($row['context_id']);
 
      return $navigationMenu;
   }
 
   function insertObject($navigationMenu) {
      $this->update(
            'INSERT INTO navigation_menus
            (title, area_name, context_id)
            VALUES
            (?, ?, ?)',
         array(
            $navigationMenu->getTitle(),
            $navigationMenu->getAreaName(),
            (int) $navigationMenu->getContextId(),
         )
      );
      $navigationMenu->setId($this->getInsertId());
 
      return $navigationMenu->getId();
   }
 
   function updateObject($navigationMenu) {
      $returner = $this->update(
         'UPDATE  navigation_menus
         SET   title = ?,
            area_name = ?,
            context_id = ?
         WHERE navigation_menu_id = ?',
         array(
            $navigationMenu->getTitle(),
            $navigationMenu->getAreaName(),
            (int) $navigationMenu->getContextId(),
            (int) $navigationMenu->getId(),
         )
      );
 
      $this->unCache($navigationMenu->getId());
 
      return $returner;
   }
 
   function deleteObject($navigationMenu) {
      return $this->deleteById($navigationMenu->getId());
   }
 
   function deleteById($navigationMenuId) {
      $this->unCache($navigationMenuId);
 
      $this->update('DELETE FROM navigation_menus WHERE navigation_menu_id = ?', (int) $navigationMenuId);
 
      $navigationMenuItemAssignmentDao = DAORegistry::getDAO('NavigationMenuItemAssignmentDAO'); /* @var $navigationMenuItemAssignmentDao NavigationMenuItemAssignmentDAO */
      $navigationMenuItemAssignmentDao->deleteByMenuId($navigationMenuId);
   }
 
   function deleteByContextId($contextId) {
      $navigationMenus = $this->getByContextId($contextId);
 
      while ($navigationMenu = $navigationMenus->next()) {
         $this->deleteObject($navigationMenu);
      }
   }
 
   function getInsertId() {
      return $this->_getInsertId('navigation_menus', 'navigation_menu_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 $navigationMenuNode) {
         $site = $navigationMenuNode->getAttribute('site');
         if ($contextId == CONTEXT_ID_NONE && !$site) {
            continue;
         }
 
         if ($navigationMenuNode->name == 'navigationMenu') {
            $title = $navigationMenuNode->getAttribute('title');
            $area = $navigationMenuNode->getAttribute('area');
 
            $navigationMenu = null;
 
            // Check if the given area has a NM attached.
            // If it does the NM is not being processed and a warning is being thrown
            $navigationMenusWithArea = $this->getByArea($contextId, $area)->toArray();
            if (count($navigationMenusWithArea) != 0) {
               error_log("WARNING: The NavigationMenu (ContextId: $contextId, Title: $title, Area: $area) will be skipped because the specified area has already a NavigationMenu attached.");
               continue;
            }
 
            if ($this->navigationMenuExistsByTitle($contextId, $title)) {
               $navigationMenu = $this->getByTitle($contextId, $title);
               $navigationMenu->setAreaName($area);
 
               // update the navigationMenu into the DB
               $navigationMenuId = $this->updateObject($navigationMenu);
            } else {
               $navigationMenu = $this->newDataObject();
               $navigationMenu->setTitle($title);
               $navigationMenu->setContextId($contextId);
               $navigationMenu->setAreaName($area);
 
               // insert the navigationMenu into the DB
               $navigationMenuId = $this->insertObject($navigationMenu);
               $navigationMenu->setId($navigationMenuId);
            }
 
            $seq = 0;
            foreach ($navigationMenuNode->getChildren() as $navigationMenuItemFirstLevelNode) {
               $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
               $navigationMenuItemDao->installNodeSettings($contextId, $navigationMenuItemFirstLevelNode, $navigationMenu->getId(), null, $seq, true);
 
               $seq++;
            }
         } elseif ($navigationMenuNode->name == 'navigationMenuItem') {
            $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /* @var $navigationMenuItemDao NavigationMenuItemDAO */
            $navigationMenuItemDao->installNodeSettings($contextId, $navigationMenuNode, null, null, 0, true);
         }
      }
 
      return true;
   }
 
   function unCache($id){
      $cache = $this->getCache($id);
      if ($cache) $cache->flush();
   }
 
   function getCache($id) {
      static $navigationMenuCache;
      if (!isset($navigationMenuCache)) {
         $navigationMenuCache = array();
      }
      if (!isset($navigationMenuCache[$id])) {
         $cacheManager = \CacheManager::getManager();
         $navigationMenuCache[$id] = $cacheManager->getCache(
            'navigationMenu', $id,
            array($this, '_cacheMiss')
         );
      }
      return $navigationMenuCache[$id];
   }
 
   function _cacheMiss($cache, $id) {
      $navigationMenuDao = \DAORegistry::getDAO('NavigationMenuDAO');
      $navigationMenu = $navigationMenuDao->GetById($cache->getCacheId());
      import('classes.core.Services');
      Services::get('navigationMenu')->getMenuTree($navigationMenu);
 
      return $navigationMenu;
   }
}