Breadcrumbs Class Reference

Public Member Functions
	__construct ()
	getTrail ()
	Gather the breadcrumb trail. More...
	findPage ()
	Get the server's url and query the SiteMap table for a match. More...
	walkUpTree ($currentSiteMapPage)
	Traverse up the tree through each parent url to find the root. More...
	walkDownTree ($upTreePages)
	No need to show breadcrumbs if there is just one single node in the tree path. More...
	getLink ($identifier=null)

Public Attributes
	$breadcrumbs
	$qs
	$url

Static Public Attributes
static	$overrideCurrentPage = null

Detailed Description

Definition at line 62 of file breadcrumbs_manager.inc.

Constructor & Destructor Documentation

__construct()

Breadcrumbs::__construct

(

)

Definition at line 69 of file breadcrumbs_manager.inc.

     {         
          $qs = getCleanQueryString();
          $this->url = $this->getLink();
          
          trace("Breadcrumb url $this->url", 3);
          $this->qs = preg_replace("/_style=\\w+&*/", "", $qs);
          
          $this->breadcrumbs = $this->getTrail();
     }

Member Function Documentation

findPage()

Breadcrumbs::findPage

(

)

Get the server's url and query the SiteMap table for a match.

Returns

instance of SiteMap or null

Definition at line 111 of file breadcrumbs_manager.inc.

     {
          $url = (Breadcrumbs::$overrideCurrentPage) ? Breadcrumbs::$overrideCurrentPage: $this->url;
          
          $pages = Query::create(SiteMap, "WHERE url =:url")
               ->bind(":url", $url)
               ->execute();
          
          return (count($pages)) ? $pages[0] : null;
     }

getLink()

Breadcrumbs::getLink

(

$identifier = null

)

Definition at line 184 of file breadcrumbs_manager.inc.

     {
          global $section;
          
          if (!$identifier) $identifier = $_REQUEST["identifier"];
          
          if ($section->section == "/")
               $url = "/$identifier";
          else
               $url = "/{$section->section}/$identifier";
     
          return $url;
     }

getTrail()

Breadcrumbs::getTrail

(

)

Gather the breadcrumb trail.

1) Find the page the user is on in the SiteMap table 2) Traverse the site map tree to find the root node 3) Walk down the tree to format the trail from the root to the current page for display.

Definition at line 87 of file breadcrumbs_manager.inc.

     {
          $currentSiteMapPage = $this->findPage();
          trace("Breadcrumbs:: currentSiteMapPage id {$currentSiteMapPage->url}", 3);
          
          if(!$currentSiteMapPage)
          {
               return "";
          }
               
          $upTreePages = $this->walkUpTree($currentSiteMapPage);
          
          $breadcrumbs = $this->walkDownTree($upTreePages);
          
          return $breadcrumbs;
     }

walkDownTree()

Breadcrumbs::walkDownTree

(

$upTreePages

)

No need to show breadcrumbs if there is just one single node in the tree path.

Parameters

array

$upTreePages

array of SiteMap objects

Returns

String breadcrumbs

Definition at line 152 of file breadcrumbs_manager.inc.

     {
          $breadcrumbs = "";
          
          if(count($upTreePages) < 2) return $breadcrumbs;
          
          $downTreePages = array_reverse($upTreePages);
          
          $idx = 0;
          $last = count($downTreePages) - 1;
 
          foreach($downTreePages as $downTreePage)
          {
               // Only need qs if this is not the first page
               // and not the last. Last page is just title, not link
               if($idx < $last)
               {
                    $link = ($idx > 0 AND $this->qs) ? "$downTreePage->url?{$this->qs}" : $downTreePage->url;
                    $title = $downTreePage->page_title;
                    $breadcrumbs .= "<a href=\"{$link}\">{$title}</a> &raquo;\n";
               }
               else
               {
                    $breadcrumbs .= $downTreePage->page_title . "\n";
               }
                    
               $idx++;
          }
 
          return $breadcrumbs;
     }

walkUpTree()

Breadcrumbs::walkUpTree

(

$currentSiteMapPage

)

Traverse up the tree through each parent url to find the root.

Parameters

obj

$currentSiteMapPage

instance of SiteMap

Returns

array of SiteMap objects

Definition at line 129 of file breadcrumbs_manager.inc.

     {
          $upTreePages = array();  
          if(!$currentSiteMapPage) return $upTreePages;
          
          $currPage = clone $currentSiteMapPage;
          // walk up the tree to get all parents of the page
          while(isset($currPage))
          {
               array_push($upTreePages, $currPage);
               $currPage = $currPage->Parent();
          } 
 
          return $upTreePages;
     }

Member Data Documentation

$breadcrumbs

Breadcrumbs::$breadcrumbs

Definition at line 64 of file breadcrumbs_manager.inc.

$overrideCurrentPage

Breadcrumbs::$overrideCurrentPage = null

static

Definition at line 68 of file breadcrumbs_manager.inc.

$qs

Breadcrumbs::$qs

Definition at line 65 of file breadcrumbs_manager.inc.

$url

Breadcrumbs::$url

Definition at line 66 of file breadcrumbs_manager.inc.

---

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

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