xml/schema/Core/Menu.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>Menu</class>
   6   <name>civicrm_menu</name>
   7   <comment>Table to store menu items for all civicrm components.</comment>
   8   <add>1.1</add>
   9   <field>
  10     <name>id</name>
  11     <title>Menu ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <html>
  15       <type>Number</type>
  16     </html>
  17     <add>2.1</add>
  18   </field>
  19   <primaryKey>
  20     <name>id</name>
  21     <autoincrement>true</autoincrement>
  22   </primaryKey>
  23   <field>
  24     <name>domain_id</name>
  25     <title>Domain ID</title>
  26     <type>int unsigned</type>
  27     <required>true</required>
  28     <pseudoconstant>
  29       <table>civicrm_domain</table>
  30       <keyColumn>id</keyColumn>
  31       <labelColumn>name</labelColumn>
  32     </pseudoconstant>
  33     <comment>Which Domain is this menu item for</comment>
  34     <html>
  35       <label>Domain</label>
  36     </html>
  37     <add>3.0</add>
  38   </field>
  39   <foreignKey>
  40     <name>domain_id</name>
  41     <table>civicrm_domain</table>
  42     <key>id</key>
  43     <add>3.0</add>
  44   </foreignKey>
  45   <field>
  46     <name>path</name>
  47     <title>Path</title>
  48     <type>varchar</type>
  49     <length>255</length>
  50     <comment>Path Name</comment>
  51     <add>2.1</add>
  52   </field>
  53   <index>
  54     <name>UI_path_domain_id</name>
  55     <fieldName>path</fieldName>
  56     <fieldName>domain_id</fieldName>
  57     <unique>true</unique>
  58     <add>2.1</add>
  59   </index>
  60   <field>
  61     <name>path_arguments</name>
  62     <title>Arguments</title>
  63     <type>text</type>
  64     <comment>Arguments to pass to the url</comment>
  65     <add>2.1</add>
  66   </field>
  67   <field>
  68     <name>title</name>
  69     <title>Menu Title</title>
  70     <type>varchar</type>
  71     <length>255</length>
  72     <add>2.1</add>
  73   </field>
  74   <field>
  75     <name>access_callback</name>
  76     <title>Access Callback</title>
  77     <type>varchar</type>
  78     <length>255</length>
  79     <comment>Function to call to check access permissions</comment>
  80     <add>2.1</add>
  81   </field>
  82   <field>
  83     <name>access_arguments</name>
  84     <title>Access Arguments</title>
  85     <type>text</type>
  86     <comment>Arguments to pass to access callback</comment>
  87     <add>2.1</add>
  88   </field>
  89   <field>
  90     <name>page_callback</name>
  91     <title>Page Callback</title>
  92     <type>varchar</type>
  93     <length>255</length>
  94     <comment>function to call for this url</comment>
  95     <add>2.1</add>
  96   </field>
  97   <field>
  98     <name>page_arguments</name>
  99     <title>Page Arguments</title>
 100     <type>text</type>
 101     <comment>Arguments to pass to page callback</comment>
 102     <add>2.1</add>
 103   </field>
 104   <field>
 105     <name>breadcrumb</name>
 106     <title>Breadcrumb</title>
 107     <type>text</type>
 108     <comment>Breadcrumb for the path.</comment>
 109     <add>2.1</add>
 110   </field>
 111   <field>
 112     <name>return_url</name>
 113     <type>varchar</type>
 114     <length>255</length>
 115     <comment>Url where a page should redirected to, if next url not known.</comment>
 116     <html>
 117       <label>Return URL</label>
 118     </html>
 119     <add>2.1</add>
 120   </field>
 121   <field>
 122     <name>return_url_args</name>
 123     <type>varchar</type>
 124     <length>255</length>
 125     <comment>Arguments to pass to return_url</comment>
 126     <html>
 127       <label>Return URL Arguments</label>
 128     </html>
 129     <add>2.1</add>
 130   </field>
 131   <field>
 132     <name>component_id</name>
 133     <title>Component ID</title>
 134     <type>int unsigned</type>
 135     <comment>Component that this menu item belongs to</comment>
 136     <add>2.1</add>
 137     <pseudoconstant>
 138       <table>civicrm_component</table>
 139       <keyColumn>id</keyColumn>
 140       <labelColumn>name</labelColumn>
 141     </pseudoconstant>
 142     <html>
 143       <type>Select</type>
 144       <label>Component</label>
 145     </html>
 146   </field>
 147   <foreignKey>
 148     <name>component_id</name>
 149     <table>civicrm_component</table>
 150     <key>id</key>
 151     <add>2.1</add>
 152   </foreignKey>
 153   <field>
 154     <name>is_active</name>
 155     <title>Enabled?</title>
 156     <type>boolean</type>
 157     <default>1</default>
 158     <required>true</required>
 159     <comment>Is this menu item active?</comment>
 160     <add>2.1</add>
 161   </field>
 162   <field>
 163     <name>is_public</name>
 164     <title>Public?</title>
 165     <type>boolean</type>
 166     <default>0</default>
 167     <required>true</required>
 168     <comment>Is this menu accessible to the public?</comment>
 169     <add>2.1</add>
 170   </field>
 171   <field>
 172     <name>is_exposed</name>
 173     <title>Exposed?</title>
 174     <type>boolean</type>
 175     <default>1</default>
 176     <required>true</required>
 177     <comment>Is this menu exposed to the navigation system?</comment>
 178     <add>2.1</add>
 179   </field>
 180   <field>
 181     <name>is_ssl</name>
 182     <title>Use SSL?</title>
 183     <type>boolean</type>
 184     <default>1</default>
 185     <required>true</required>
 186     <comment>Should this menu be exposed via SSL if enabled?</comment>
 187     <add>2.1</add>
 188   </field>
 189   <field>
 190     <name>weight</name>
 191     <title>Order</title>
 192     <type>int</type>
 193     <required>true</required>
 194     <default>1</default>
 195     <comment>Ordering of the menu items in various blocks.</comment>
 196     <add>2.1</add>
 197   </field>
 198   <field>
 199     <name>type</name>
 200     <title>Type</title>
 201     <type>int</type>
 202     <required>true</required>
 203     <default>1</default>
 204     <comment>Drupal menu type.</comment>
 205     <add>2.1</add>
 206   </field>
 207   <field>
 208     <name>page_type</name>
 209     <title>Page Type</title>
 210     <type>int</type>
 211     <required>true</required>
 212     <default>1</default>
 213     <comment>CiviCRM menu type.</comment>
 214     <add>2.1</add>
 215   </field>
 216   <field>
 217     <name>skipBreadcrumb</name>
 218     <title>Hide Breadcrumb?</title>
 219     <type>boolean</type>
 220     <default>0</default>
 221     <required>true</required>
 222     <comment>skip this url being exposed to breadcrumb</comment>
 223     <add>2.2</add>
 224   </field>
 225   <field>
 226     <name>module_data</name>
 227     <title>Other menu data</title>
 228     <type>text</type>
 229     <comment>All other menu metadata not stored in other fields</comment>
 230     <add>4.7</add>
 231   </field>
 232 </table>