SiteMap Class Reference

Inherits DataItem.

Public Member Functions
	Parent ()
	Children ($constraint="")
	isSibling ($url)
	Is the given url a sibling of this SiteMap obj. More...
	allowDelete ()
	isLeaf ()
	SiteMap ()

Static Public Member Functions
static	findSiteMapPage ($url)
static	getSiteMapPageList ()

Public Attributes
	$fields

Detailed Description

Definition at line 50 of file site_map.inc.

Member Function Documentation

allowDelete()

SiteMap::allowDelete

(

)

Definition at line 112 of file site_map.inc.

     {
          $count = Query::create(SiteMap, "WHERE parent_url=:url")
               ->bind(":url", $this->url)
               ->executeValue("COUNT(1)");
          
          return ($count > 0) ? false : true;
     }

Children()

SiteMap::Children

(

$constraint = ""

)

Definition at line 71 of file site_map.inc.

     {
          $query = "WHERE parent_url=:url";
          if($constraint)
          {
               $query .= preg_replace("/^WHERE/i", " AND", $constraint);
          }
          return Query::create(SiteMap, $query)
               ->bind(":url", $this->url)
               ->execute();
     }

findSiteMapPage()

static SiteMap::findSiteMapPage (   $url )

static

Definition at line 101 of file site_map.inc.

     {
          if(!$url) return null;
          $siteMaps = Query::create(SiteMap, "WHERE url=:url")
               ->bind(":url", $url)
               ->execute();
          
          return count($siteMaps) ? $siteMaps[0] : null;
     }

getSiteMapPageList()

static SiteMap::getSiteMapPageList ( )

static

Definition at line 129 of file site_map.inc.

     {
          $siteMapPages = query(SiteMap, "ORDER BY url");
                    
          if(count($siteMapPages) > 0)
          {
               foreach($siteMapPages as $sPage)
               {
                    $pageList[$sPage->url] = $sPage->url . ": " . $sPage->page_title;
               }
          }
          
          $pageList[""] = "";
          return $pageList;
     }

isLeaf()

SiteMap::isLeaf

(

)

Definition at line 121 of file site_map.inc.

     {
          return $this->allowDelete();
     }

isSibling()

SiteMap::isSibling

(

$url

)

Is the given url a sibling of this SiteMap obj.

Parameters

String

$url

Returns

boolean

Definition at line 90 of file site_map.inc.

     {
          $sibling = false;
 
          $siteMap = SiteMap::findSiteMapPage($url);
          
          $sibling = ($siteMap AND ($siteMap->parent_url == $this->parent_url)) ? true : false;
          
          return $sibling;
     }

Parent()

SiteMap::Parent

(

)

Definition at line 62 of file site_map.inc.

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

SiteMap()

SiteMap::SiteMap

(

)

Definition at line 145 of file site_map.inc.

     {
          $this->table = "site_map";
          $this->primary_key = "site_map_id";
 
          $this->DataItem(func_get_args());
     }

Member Data Documentation

$fields

SiteMap::$fields

Initial value:

= array(
                         "site_map_id"            =>   Number,
                         "url"                         =>   String,
                         "page_title"             =>   String,
                         "sort_order"             =>   String,
                         "role"                        =>   String,
                         "parent_url"             =>   String,
                         "published"                   =>   Boolean
     )

Definition at line 52 of file site_map.inc.

---

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

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