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