Changeset 1065

Timestamp:

04/26/10 17:08:58 (22 months ago)

Author:

tboutell

Message:

New default behavior of navigation components is appropriate for use on large sites with many pages. On small sites it may be slightly slower, in which case you can set app_a_many_pages to false to get the old "fetch the entire page tree and reuse it in each navigation component as needed" behavior back. This worked quite well up to about 1,000 pages but became a serious problem on an 8,000-page site.

aPage::getAncestorsInfo now has an optional 'includeSelf' parameter which defaults to false for backwards compatibility.

aPage::getInfo provides a page info array about the current page. Useful when merging information from the Info methods with information about pages you already have as objects.

aPage::getAccordionInfo now has an optional final parameter, 'root', which specifies the slug of the root page of the accordion tree. The page on which getAccordionInfo is called should be a descendant of that page (or the root page itself).

Location:

plugins/apostrophePlugin/trunk/lib

Files:

• model/doctrine/PluginaPage.class.php (modified) (6 diffs)
• navigation/aNavigation.class.php (modified) (1 diff)
• navigation/aNavigationAccordion.class.php (modified) (2 diffs)
• navigation/aNavigationBreadcrumb.class.php (modified) (1 diff)
• navigation/aNavigationTabs.class.php (modified) (1 diff)

plugins/apostrophePlugin/trunk/lib/model/doctrine/PluginaPage.class.php

@@ -570 +570 @@
   protected $ancestorsInfo;
   
-  public function getAncestorsInfo()
+  public function getAncestorsInfo($includeSelf = false)
   {
     if (!isset($this->ancestorsInfo))
@@ -577 +577 @@
       // Since our presence on an admin page implies we know about it, it's OK to include
       // admin pages in the breadcrumb. It's not OK in other navigation
-      $this->ancestorsInfo = $this->getPagesInfo(false, '( p.lft < ' . $this->lft . ' AND p.rgt > ' . $this->rgt . ' )', true);
+      $less = '<';
+      $greater = '>';
+      if ($includeSelf)
+      {
+        $less = '<=';
+        $greater = '>=';
+      }
+      $this->ancestorsInfo = $this->getPagesInfo(false, "( p.lft $less " . $this->lft . " AND p.rgt $greater " . $this->rgt . ' )', true);
     }
     return $this->ancestorsInfo;
@@ -602 +609 @@
       {
         // It's the home page. Return a stub: the home page is its only peer
-        $this->peerInfo = array(array('id' => $this->id, 'title' => $this->getTitle(), 'slug' => $this->slug, 'view_is_secure' => $this->view_is_secure, 'archived' => $this->archived, 'level' => $this->level, 'lft' => $this->lft, 'rgt' => $this->rgt));
+        $this->peerInfo = array($this->getInfo());
       }
       else
@@ -615 +622 @@
   }
 
+  // Sometimes it is useful to have an info structure describing a page object
+  // (the aNavigation classes exploit this)
+  
+  public function getInfo()
+  {
+    return array('id' => $this->id, 'title' => $this->getTitle(), 'slug' => $this->slug, 'view_is_secure' => $this->view_is_secure, 'archived' => $this->archived, 'level' => $this->level, 'lft' => $this->lft, 'rgt' => $this->rgt);
+  }
+  
   protected $childrenInfo;
   
@@ -709 +724 @@
   //   Two
   
+  // You can now specify the root slug, which defaults to the home page.
+  
   // Note that children of Two, 1a, and 1c are NOT returned. Only the siblings of
   // the current page's ancestors, the current page and its siblings, and the immediate
   // children of the current page are returned. For a full tree use getTreeInfo().
   
-  public function getAccordionInfo($livingOnly = true, $depth = null)
+  public function getAccordionInfo($livingOnly = true, $depth = null, $root = '/')
   {
     // As far as I can tell there is no super-elegant, single-query way to do this
@@ -724 +741 @@
     // an accordion contro. in the first place
     $ancestors = $this->getAncestorsInfo();
+    
+    // Dump ancestors we don't care about
+    for ($i = 0; ($i < count($ancestors)); $i++)
+    {
+      if ($ancestors[$i]['slug'] === $root)
+      {
+        $ancestors = array_slice($ancestors, $i);
+        break;
+      }
+    }
+    if ($i === count($ancestors))
+    {
+      throw new sfException("Root slug $root never found among ancestors in getAccordionInfo");
+    }
     $result = array();
     // Ancestor levels

plugins/apostrophePlugin/trunk/lib/navigation/aNavigation.class.php

@@ -13 +13 @@
   public static function simulateNewRequest()
   {
+    if (sfConfig::get('app_a_many_pages', false))
+    {
+      
+    }
     self::$tree = null;
     self::$hash = null;

plugins/apostrophePlugin/trunk/lib/navigation/aNavigationAccordion.class.php

@@ -4 +4 @@
 {
   protected $cssClass = 'a-nav-item'; 
-  public function buildNavigation()
+  public function initializeTree()
   {
-    $this->rootInfo = parent::$hash[$this->root];
-    $this->activeInfo = parent::$hash[$this->active];
-    if(isset($this->rootInfo['children']))
+    if (sfConfig::get('app_a_many_pages', true))
     {
-      $this->nav = $this->rootInfo['children'];
+      // The use of the static sitewide page tree 
+      // requires too much memory on sites with more
+      // than about 500-1000 pages. On smaller sites
+      // it turns out to be a performance win to get
+      // all of the page information for the site and
+      // cache it for subsequent navigation elements on
+      // the same page, which the base class does for us
     }
     else
     {
-      $this->nav = $this->rootInfo['parent']['children'];
+      parent::initializeTree();
     }
+  }
+  public function buildNavigation()
+  {
+    if (sfConfig::get('app_a_many_pages', true))
+    {
+      $activePage = aPageTable::retrieveBySlug($this->active);
+      $this->activeInfo = $activePage->getInfo();
+      $this->rootInfo = $activePage->getAccordionInfo(false, null, $this->root);
+      // This rootInfo is already an array of kids
+      $this->nav = $this->rootInfo;
+    }
+    else
+    {
+      $this->rootInfo = parent::$hash[$this->root];
+      $this->activeInfo = parent::$hash[$this->active];
+      // This rootInfo is an individual page info
+      $this->nav = $this->rootInfo['children'];
+    }
+    // We no longer try to special case the situation where the root page has no children,
+    // because the active page should always be a descendant of the root page, and it
+    // complicated the implementation
     $this->traverse($this->nav);
   }
@@ -26 +51 @@
       $this->applyCSS($tree, $node);
       
-      if(!self::isAncestor($node, $this->activeInfo) && !($node['id'] == $this->activeInfo['id']))
+      // This is redundant if we used getAccordionInfo, and it won't work because we
+      // never set activeInfo or the 'parent' pointers
+      if (!sfConfig::get('app_a_many_pages', true))
       {
-        unset($node['children']);
+        if(!self::isAncestor($node, $this->activeInfo) && !($node['id'] == $this->activeInfo['id']))
+        {
+          unset($node['children']);
+        }
       }
       

plugins/apostrophePlugin/trunk/lib/navigation/aNavigationBreadcrumb.class.php

@@ -4 +4 @@
 {
   protected $cssClass = 'a-nav-item'; 
+  public function initializeTree()
+  {
+    if (sfConfig::get('app_a_many_pages', true))
+    {
+      // The use of the static sitewide page tree 
+      // requires too much memory on sites with more
+      // than about 500-1000 pages. On smaller sites
+      // it turns out to be a performance win to get
+      // all of the page information for the site and
+      // cache it for subsequent navigation elements on
+      // the same page, which the base class does for us
+    }
+    else
+    {
+      parent::initializeTree();
+    }
+  }
+  
   public function buildNavigation()
   {
+    if (sfConfig::get('app_a_many_pages', true))
+    {
+      $activePage = aPageTable::retrieveBySlug($this->active);
+      // true = include the page itself
+      $this->nav = $activePage->getAncestorsInfo(true);
+      $i = count($this->nav);
+      $info = &$this->nav[$i - 1];
+      if (!isset($info['class']))
+      {
+        $info['class'] = '';
+      }
+      $info['class'] .= ' a-current-page';
+      return;
+    }
     $this->rootInfo = parent::$hash[$this->root];
     $this->activeInfo = parent::$hash[$this->active];

plugins/apostrophePlugin/trunk/lib/navigation/aNavigationTabs.class.php

@@ -4 +4 @@
 {
   protected $cssClass = 'a-nav-item'; 
-  public function buildNavigation()
+  public function initializeTree()
   {
-    $this->rootInfo = parent::$hash[$this->root];
-    $this->activeInfo = parent::$hash[$this->active];
-    $this->depth = $this->options['depth'];
-    
-    if(isset($this->rootInfo['children']))
+    if (sfConfig::get('app_a_many_pages', true))
     {
-      $this->nav = $this->rootInfo['children'];
+      // The use of the static sitewide page tree 
+      // requires too much memory on sites with more
+      // than about 500-1000 pages. On smaller sites
+      // it turns out to be a performance win to get
+      // all of the page information for the site and
+      // cache it for subsequent navigation elements on
+      // the same page, which the base class does for us
     }
     else
     {
-      $this->nav = $this->rootInfo['parent']['children'];
+      parent::initializeTree();
     }
+  }
+  
+  public function buildNavigation()
+  {
+    if (sfConfig::get('app_a_many_pages', true))
+    {
+      $activePage = aPageTable::retrieveBySlug($this->active);
+      $this->activeInfo = $activePage->getInfo();
+      
+      $rootPage = aPageTable::retrieveBySlug($this->root);
+      $this->rootInfo = $rootPage->getTreeInfo(false, $this->options['depth']);
+      // If no kids...
+      if (!count($this->rootInfo))
+      {
+        // Try the parent
+        $rootPage = $rootPage->getParent();
+        if (!$rootPage)
+        {
+          // Parent does not exist - this is the home page and there are no subpages
+          // (unlikely in practice due to admin pages)
+          $this->rootInfo = array();
+        }
+        else
+        {
+          // Parent does exist, use its kids
+          $this->rootInfo = $rootPage->getTreeInfo(false, $this->options['depth']);
+        }
+      }
+      $this->nav = $this->rootInfo;
+    }
+    else
+    {
+      $this->rootInfo = parent::$hash[$this->root];
+      $this->activeInfo = parent::$hash[$this->active];
+      if(isset($this->rootInfo['children']))
+      {
+        $this->nav = $this->rootInfo['children'];
+      }
+      else
+      {
+        if (!isset($this->rootInfo['parent']))
+        {
+          // A site root with no children
+          $this->nav = array();
+        }
+        else
+        {
+          $this->nav = $this->rootInfo['parent']['children'];
+        }
+      }
+    }
+    $this->depth = $this->options['depth'];
+    
     $this->traverse($this->nav);
   }