CMS  Version 3.9
MenuItem Class Reference

Inherits DataItem.

Public Member Functions

 Page ()
 
 Menu ()
 
 Parent ()
 
 Children ($constraint="ORDER BY sort_order, title")
 

Public Attributes

 $primary_key = "menu_item_id"
 
 $table = "menu_item"
 
 $default_format = "{title}"
 
 $pretty_class_name = "Menu Item"
 
 $fields
 
 $fieldAliases = array("css_class" => "CSS Class")
 
 $relations
 

Detailed Description

Definition at line 112 of file menus.inc.

Member Function Documentation

◆ Children()

MenuItem::Children (   $constraint = "ORDER BY sort_ordertitle")

Definition at line 179 of file menus.inc.

180  {
181  return query(MenuItem, "WHERE parent_id={$this->menu_item_id} $constraint");
182  }

◆ Menu()

MenuItem::Menu ( )

Definition at line 167 of file menus.inc.

168  {
169  return $this->getRelated(Menu);
170  }
Definition: menus.inc:41

◆ Page()

MenuItem::Page ( )

Definition at line 146 of file menus.inc.

147  {
148  $pages = Query::create(Page, "WHERE identifier=:i")
149  ->bind(":i", $this->identifier)
150  ->execute();
151  if (count($pages) > 0)
152  {
153  return $pages[0];
154  }
155 
156  $pages = Query::create(ComponentPage, "WHERE identifier=:i")
157  ->bind(":i", $this->identifier)
158  ->execute();
159  if (count($pages) > 0)
160  {
161  return $pages[0];
162  }
163 
164  return null;
165  }
Definition: page.inc:43
$pages
Definition: export.inc:38

◆ Parent()

MenuItem::Parent ( )

Definition at line 172 of file menus.inc.

173  {
174  if (!$this->parent_id) return null;
175 
176  return $this->getRelated(MenuItem, "parent_id");
177  }

Member Data Documentation

◆ $default_format

MenuItem::$default_format = "{title}"

Definition at line 117 of file menus.inc.

◆ $fieldAliases

MenuItem::$fieldAliases = array("css_class" => "CSS Class")

Definition at line 137 of file menus.inc.

◆ $fields

MenuItem::$fields
Initial value:
= array("menu_item_id" => Number,
"title" => String,
"custom_format" => String,
"menu_id" => Number,
"parent_id" => Number,
"identifier" => String,
"page_id" => Number,
"url" => String,
"css_class" => String,
"sort_order" => Number,
"role" => String,
"permissions" => String,
"published" => Boolean,
"required_parameters" => String,
"display_flags" => String)

Definition at line 121 of file menus.inc.

◆ $pretty_class_name

MenuItem::$pretty_class_name = "Menu Item"

Definition at line 118 of file menus.inc.

◆ $primary_key

MenuItem::$primary_key = "menu_item_id"

Definition at line 114 of file menus.inc.

◆ $relations

MenuItem::$relations
Initial value:
= array( "Page" => Page,
"Menu" => Menu,
"Parent" => MenuItem,
"Children" => MenuItem)

Definition at line 141 of file menus.inc.

◆ $table

MenuItem::$table = "menu_item"

Definition at line 115 of file menus.inc.


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