SiteMapManager Class Reference

Scans the application home directory and PHP include path and builds the component and administration page map that describe the configuration of the application. More...

Public Member Functions
	__construct ()
	Creates a new ComponentManager object. More...
	update ()
	deleteSiteMapPage ($siteMapPage)
	setHierarchyFromMenuItems ()
	Default the hierarchy of pages to the global menu's hierarchy. More...
	removeOldContentFromSiteMap ()
	Check if the SiteMap contains records of content that has been removed from the site. More...
	getTitle ($content, $type, $item)
	Given an instance of a CMS content item, get the title. More...
	saveNewContentToSiteMap ()
	Gather all CMS content and if an item is not already in the site map, add it. More...
	categorizeItemTypes ($itemsByType)
	getLink ($section, $identifier)

Static Public Member Functions
static	updateSiteMap ()
static	upgradeComponent ($version)
static	registerSerializationHandler ()

Public Attributes
	$pages = array()
	$map = array()
	$currentContent = array()

Static Public Attributes
static	$titleFields

Detailed Description

Scans the application home directory and PHP include path and builds the component and administration page map that describe the configuration of the application.

Definition at line 67 of file site_map_manager.inc.

Constructor & Destructor Documentation

__construct()

SiteMapManager::__construct

(

)

Creates a new ComponentManager object.

Definition at line 88 of file site_map_manager.inc.

     {
          $this->map = IndexedQuery::create(SiteMap, "", "url")->execute();
          
          if(!is_array($this->map))
          {
               $this->map = array();              
          }
     }

Member Function Documentation

categorizeItemTypes()

SiteMapManager::categorizeItemTypes

(

$itemsByType

)

Definition at line 276 of file site_map_manager.inc.

     {
          $types = array();
     
          foreach($itemsByType as $type => $items)
          {
               foreach($items as $item)
               {
                    $types[$item->identifier] = $type;
               }
          }
     
          return $types;
     }

deleteSiteMapPage()

SiteMapManager::deleteSiteMapPage

(

$siteMapPage

)

Definition at line 125 of file site_map_manager.inc.

     {
          $parent = $siteMapPage->Parent();
 
          $children = $siteMapPage->Children();
          if(count($children) > 0)
          {
               foreach($children as $child)
               {
                    $child->parent_url = ($parent AND $parent->url) ? 
                         $parent->url : "";
                    $child->save();
               }
          }         
          $siteMapPage->delete();
     }

getLink()

SiteMapManager::getLink	(		$section,
			$identifier
	)

Definition at line 291 of file site_map_manager.inc.

     {
          if ($section->section == "/")
               $url = "/$identifier";
          else
               $url = "/{$section->section}/$identifier";
     
          return $url;
     }

getTitle()

SiteMapManager::getTitle	(		$content,
			$type,
			$item
	)

Given an instance of a CMS content item, get the title.

Definition at line 202 of file site_map_manager.inc.

     {    
          if ($content->override_page_title) 
          {
               $title = $content->override_page_title;
          }
          else if(array_key_exists($type, SiteMapManager::$titleFields))
          {
               $field = SiteMapManager::$titleFields[$type];
               $title = $item->$field;
          }
          else
          {
               $title = prettify($item->identifier);
          }
 
          return $title;
     }

registerSerializationHandler()

static SiteMapManager::registerSerializationHandler ( )

static

Definition at line 308 of file site_map_manager.inc.

     {
          SerializationManager::registerHandler("site_map", "Site Map", new SiteMapSerializationHandler());
          return true;
     }    

removeOldContentFromSiteMap()

SiteMapManager::removeOldContentFromSiteMap

(

)

Check if the SiteMap contains records of content that has been removed from the site.

Definition at line 186 of file site_map_manager.inc.

     {
          foreach($this->map as $url => $siteMapPage)
          {
               if(array_search($url, $this->currentContent) === FALSE)
               {
                    $this->deleteSiteMapPage($siteMapPage);
               }
          }
     }

saveNewContentToSiteMap()

SiteMapManager::saveNewContentToSiteMap

(

)

Gather all CMS content and if an item is not already in the site map, add it.

Definition at line 225 of file site_map_manager.inc.

     {
          $itemsByType = array();
          $itemsByType = ComponentManager::fireEvent("EnumerateItems", $itemsByType);
     
          $sections = Query::create(Section, "ORDER BY section")->execute();
          
          foreach($sections as $section)
          {
               $content = $section->Content("ORDER BY identifier");
               $contentByIdentifier = reindexList($content, "identifier");
                    
               // e.g., type is Component Pages and items are all component pages 
               foreach($itemsByType as $type => $items)
               {
                    foreach($items as $item)
                    {
                         if (!$item->identifier || !array_key_exists($item->identifier, $contentByIdentifier)) continue;
                              
                         trace(get_class($item). " - ".$item->identifier, 3);
                         
                         $content = $contentByIdentifier[$item->identifier];
                         $url = $this->getLink($section, $item->identifier);
                         $page_title = $this->getTitle($content, $type, $item);
                         
                         $siteMapPage = new SiteMap();           
                         if(array_key_exists($url, $this->map))
                         {
                              $siteMapPage = $this->map[$url];
                              if($page_title != $siteMapPage->page_title)
                              {
                                   $siteMapPage->page_title = $page_title;
                                   $siteMapPage->filter = new InclusionFilter("page_title");
                                   $siteMapPage->save();
                              }    
                         }
                         else
                         {
                              $siteMapPage->url = $url;
                              $siteMapPage->published = true;
                              $siteMapPage->page_title = $page_title;
                              $siteMapPage->save();
                              $this->map[$siteMapPage->url] = $siteMapPage;
                         }
          
                         $this->currentContent[] = $siteMapPage->url;
                    }
               }                        
          }
     }

setHierarchyFromMenuItems()

SiteMapManager::setHierarchyFromMenuItems

(

)

Default the hierarchy of pages to the global menu's hierarchy.

Definition at line 146 of file site_map_manager.inc.

     {
          $indexedMap = $this->map;
          
          $menuItems = GroupedQuery::create(MenuItem, "WHERE menu_id IN (SELECT menu_id FROM menu WHERE identifier='global')", "url")
               ->execute();
          
          if(!count($menuItems)) return;
          
          foreach($menuItems as $url => $urlItems)
          {
               if(array_key_exists($url, $indexedMap))
               {
                    $siteMapPage = $indexedMap[$url];
                    
                    if(!is_array($urlItems)) $urlItems = array($urlItems);
                    
                    foreach($urlItems as $menuItem)
                    {
                         $parent = $menuItem->Parent();
                         if(!$parent || $parent->url == $siteMapPage->url) continue;
                         
                         if($parent AND $parent->url != $siteMapPage->parent_url)
                         {
                              $siteMapPage->parent_url = $parent->url;
                              $siteMapPage->published = true;
                              $siteMapPage->sort_order = $menuItem->sort_order;
                              $siteMapPage->filter = new InclusionFilter("parent_url", "published");
                              $siteMapPage->save();
                              break;
                         }         
                    }
               }
          }
     }         

update()

SiteMapManager::update

(

)

Definition at line 106 of file site_map_manager.inc.

     {
          $this->saveNewContentToSiteMap();
          $this->removeOldContentFromSiteMap();
          $this->setHierarchyFromMenuItems();
     }

updateSiteMap()

static SiteMapManager::updateSiteMap ( )

static

Definition at line 98 of file site_map_manager.inc.

     {
          trace("SiteMapManager processing method updateSiteMap", 3);
          
          $mgr = new SiteMapManager();
          $mgr->update();
     }

upgradeComponent()

static SiteMapManager::upgradeComponent (   $version )

static

Definition at line 302 of file site_map_manager.inc.

     {
          $mgr = new SiteMapUpgradeManager();
          $mgr->upgrade($version);
     }    

Member Data Documentation

$currentContent

SiteMapManager::$currentContent = array()

Definition at line 71 of file site_map_manager.inc.

$map

SiteMapManager::$map = array()

Definition at line 70 of file site_map_manager.inc.

$pages

SiteMapManager::$pages = array()

Definition at line 69 of file site_map_manager.inc.

$titleFields

SiteMapManager::$titleFields

static

Initial value:

= array(
          "Blogs"                       =>   "title",
          "Calendars"                   =>   "name",
          "Document Libraries"     =>   "name",
          "Component Pages"        =>   "page_title",  
          "Forums"                 =>   "title",
          "Image Galleries"        =>   "gallery_name",
          "Link Libraries"         =>   "name",
          "Pages"                       =>   "page_title",
          "Video Galleries"        =>   "gallery_name",
               )

Definition at line 73 of file site_map_manager.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/site_map/site_map_manager.inc