[civicrm-core.git] / xml / schema / Core / Menu.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Core</base>
  <class>Menu</class>
  <name>civicrm_menu</name>
  <comment>Table to store menu items for all civicrm components.</comment>
  <add>1.1</add>
  <field>
    <name>id</name>
    <title>Menu ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <html>
      <type>Number</type>
    </html>
    <add>2.1</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>domain_id</name>
    <title>Domain ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <pseudoconstant>
      <table>civicrm_domain</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <comment>Which Domain is this menu item for</comment>
    <html>
      <label>Domain</label>
    </html>
    <add>3.0</add>
  </field>
  <foreignKey>
    <name>domain_id</name>
    <table>civicrm_domain</table>
    <key>id</key>
    <add>3.0</add>
  </foreignKey>
  <field>
    <name>path</name>
    <title>Path</title>
    <type>varchar</type>
    <length>255</length>
    <comment>Path Name</comment>
    <add>2.1</add>
  </field>
  <index>
    <name>UI_path_domain_id</name>
    <fieldName>path</fieldName>
    <fieldName>domain_id</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <field>
    <name>path_arguments</name>
    <title>Arguments</title>
    <type>text</type>
    <comment>Arguments to pass to the url</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>title</name>
    <title>Menu Title</title>
    <type>varchar</type>
    <length>255</length>
    <add>2.1</add>
  </field>
  <field>
    <name>access_callback</name>
    <title>Access Callback</title>
    <type>varchar</type>
    <length>255</length>
    <comment>Function to call to check access permissions</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>access_arguments</name>
    <title>Access Arguments</title>
    <type>text</type>
    <comment>Arguments to pass to access callback</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>page_callback</name>
    <title>Page Callback</title>
    <type>varchar</type>
    <length>255</length>
    <comment>function to call for this url</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>page_arguments</name>
    <title>Page Arguments</title>
    <type>text</type>
    <comment>Arguments to pass to page callback</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>breadcrumb</name>
    <title>Breadcrumb</title>
    <type>text</type>
    <comment>Breadcrumb for the path.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>return_url</name>
    <type>varchar</type>
    <length>255</length>
    <comment>Url where a page should redirected to, if next url not known.</comment>
    <html>
      <label>Return URL</label>
    </html>
    <add>2.1</add>
  </field>
  <field>
    <name>return_url_args</name>
    <type>varchar</type>
    <length>255</length>
    <comment>Arguments to pass to return_url</comment>
    <html>
      <label>Return URL Arguments</label>
    </html>
    <add>2.1</add>
  </field>
  <field>
    <name>component_id</name>
    <title>Component ID</title>
    <type>int unsigned</type>
    <comment>Component that this menu item belongs to</comment>
    <add>2.1</add>
    <pseudoconstant>
      <table>civicrm_component</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
      <label>Component</label>
    </html>
  </field>
  <foreignKey>
    <name>component_id</name>
    <table>civicrm_component</table>
    <key>id</key>
    <add>2.1</add>
  </foreignKey>
  <field>
    <name>is_active</name>
    <title>Enabled?</title>
    <type>boolean</type>
    <default>1</default>
    <required>true</required>
    <comment>Is this menu item active?</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>is_public</name>
    <title>Public?</title>
    <type>boolean</type>
    <default>0</default>
    <required>true</required>
    <comment>Is this menu accessible to the public?</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>is_exposed</name>
    <title>Exposed?</title>
    <type>boolean</type>
    <default>1</default>
    <required>true</required>
    <comment>Is this menu exposed to the navigation system?</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>is_ssl</name>
    <title>Use SSL?</title>
    <type>boolean</type>
    <default>1</default>
    <required>true</required>
    <comment>Should this menu be exposed via SSL if enabled?</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>weight</name>
    <title>Order</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>Ordering of the menu items in various blocks.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>type</name>
    <title>Type</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>Drupal menu type.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>page_type</name>
    <title>Page Type</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>CiviCRM menu type.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>skipBreadcrumb</name>
    <title>Hide Breadcrumb?</title>
    <type>boolean</type>
    <default>0</default>
    <required>true</required>
    <comment>skip this url being exposed to breadcrumb</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>module_data</name>
    <title>Other menu data</title>
    <type>text</type>
    <comment>All other menu metadata not stored in other fields</comment>
    <add>4.7</add>
  </field>
</table>
Commit	Line	Data
6a488035 TO	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>
8f069c03	10	<name>id</name>
f3ea5182	11	<title>Menu ID</title>
8f069c03 EM	12	<type>int unsigned</type>
8f069c03 EM	13	<required>true</required>
0481e12c A	14	<html>
	15	<type>Number</type>
	16	</html>
8f069c03	17	<add>2.1</add>
6a488035 TO	18	</field>
6a488035 TO	19	<primaryKey>
8f069c03 EM	20	<name>id</name>
8f069c03 EM	21	<autoincrement>true</autoincrement>
6a488035 TO	22	</primaryKey>
6a488035 TO	23	<field>
8f069c03	24	<name>domain_id</name>
57e94608	25	<title>Domain ID</title>
8f069c03 EM	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>
57e94608 A	34	<html>
	35	<label>Domain</label>
	36	</html>
8f069c03	37	<add>3.0</add>
6a488035 TO	38	</field>
6a488035 TO	39	<foreignKey>
8f069c03 EM	40	<name>domain_id</name>
	41	<table>civicrm_domain</table>
	42	<key>id</key>
	43	<add>3.0</add>
6a488035 TO	44	</foreignKey>
6a488035 TO	45	<field>
8f069c03	46	<name>path</name>
f3ea5182	47	<title>Path</title>
8f069c03 EM	48	<type>varchar</type>
	49	<length>255</length>
	50	<comment>Path Name</comment>
	51	<add>2.1</add>
6a488035 TO	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>
f3ea5182	62	<title>Arguments</title>
6a488035 TO	63	<type>text</type>
	64	<comment>Arguments to pass to the url</comment>
	65	<add>2.1</add>
	66	</field>
	67	<field>
8f069c03	68	<name>title</name>
f3ea5182	69	<title>Menu Title</title>
8f069c03 EM	70	<type>varchar</type>
8f069c03 EM	71	<length>255</length>
8f069c03	72	<add>2.1</add>
6a488035 TO	73	</field>
	74	<field>
	75	<name>access_callback</name>
f3ea5182	76	<title>Access Callback</title>
6a488035 TO	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>
f3ea5182	84	<title>Access Arguments</title>
6a488035 TO	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>
f3ea5182	91	<title>Page Callback</title>
6a488035 TO	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>
f3ea5182	99	<title>Page Arguments</title>
6a488035 TO	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>
f3ea5182	106	<title>Breadcrumb</title>
6a488035 TO	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>
1662d426 A	116	<html>
	117	<label>Return URL</label>
	118	</html>
6a488035 TO	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>
1662d426 A	126	<html>
	127	<label>Return URL Arguments</label>
	128	</html>
6a488035 TO	129	<add>2.1</add>
	130	</field>
	131	<field>
8f785c9e	132	<name>component_id</name>
57e94608	133	<title>Component ID</title>
8f785c9e AS	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>
614d72ec	142	<html>
e0991796	143	<type>Select</type>
57e94608	144	<label>Component</label>
614d72ec	145	</html>
6a488035 TO	146	</field>
6a488035 TO	147	<foreignKey>
8f069c03 EM	148	<name>component_id</name>
	149	<table>civicrm_component</table>
	150	<key>id</key>
	151	<add>2.1</add>
6a488035 TO	152	</foreignKey>
6a488035 TO	153	<field>
8f069c03	154	<name>is_active</name>
f3ea5182	155	<title>Enabled?</title>
8f069c03	156	<type>boolean</type>
c1e814c7 MD	157	<default>1</default>
c1e814c7 MD	158	<required>true</required>
8f069c03 EM	159	<comment>Is this menu item active?</comment>
8f069c03 EM	160	<add>2.1</add>
6a488035 TO	161	</field>
6a488035 TO	162	<field>
8f069c03	163	<name>is_public</name>
f3ea5182	164	<title>Public?</title>
8f069c03	165	<type>boolean</type>
d5d0525a	166	<default>0</default>
c1e814c7	167	<required>true</required>
8f069c03 EM	168	<comment>Is this menu accessible to the public?</comment>
8f069c03 EM	169	<add>2.1</add>
6a488035 TO	170	</field>
6a488035 TO	171	<field>
8f069c03	172	<name>is_exposed</name>
f3ea5182	173	<title>Exposed?</title>
8f069c03	174	<type>boolean</type>
c1e814c7 MD	175	<default>1</default>
c1e814c7 MD	176	<required>true</required>
8f069c03 EM	177	<comment>Is this menu exposed to the navigation system?</comment>
8f069c03 EM	178	<add>2.1</add>
6a488035 TO	179	</field>
6a488035 TO	180	<field>
8f069c03	181	<name>is_ssl</name>
f3ea5182	182	<title>Use SSL?</title>
8f069c03	183	<type>boolean</type>
c1e814c7 MD	184	<default>1</default>
c1e814c7 MD	185	<required>true</required>
8f069c03 EM	186	<comment>Should this menu be exposed via SSL if enabled?</comment>
8f069c03 EM	187	<add>2.1</add>
6a488035 TO	188	</field>
6a488035 TO	189	<field>
8f069c03	190	<name>weight</name>
7ecddde4	191	<title>Order</title>
8f069c03 EM	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>
6a488035 TO	197	</field>
6a488035 TO	198	<field>
8f069c03	199	<name>type</name>
f3ea5182	200	<title>Type</title>
8f069c03 EM	201	<type>int</type>
	202	<required>true</required>
	203	<default>1</default>
	204	<comment>Drupal menu type.</comment>
	205	<add>2.1</add>
6a488035 TO	206	</field>
6a488035 TO	207	<field>
8f069c03	208	<name>page_type</name>
f3ea5182	209	<title>Page Type</title>
8f069c03 EM	210	<type>int</type>
	211	<required>true</required>
	212	<default>1</default>
	213	<comment>CiviCRM menu type.</comment>
	214	<add>2.1</add>
6a488035 TO	215	</field>
6a488035 TO	216	<field>
8f069c03	217	<name>skipBreadcrumb</name>
f3ea5182	218	<title>Hide Breadcrumb?</title>
8f069c03	219	<type>boolean</type>
c1e814c7 MD	220	<default>0</default>
c1e814c7 MD	221	<required>true</required>
8f069c03 EM	222	<comment>skip this url being exposed to breadcrumb</comment>
8f069c03 EM	223	<add>2.2</add>
6a488035	224	</field>
b44dc91e TO	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>
6a488035	232	</table>