xml/schema/Core/Navigation.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>Navigation</class>
   6   <name>civicrm_navigation</name>
   7   <comment>Table to store navigation.</comment>
   8   <add>3.0</add>
   9   <labelField>label</labelField>
  10   <field>
  11     <name>id</name>
  12     <title>Navigation ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <html>
  16       <type>Number</type>
  17     </html>
  18     <add>3.0</add>
  19   </field>
  20   <primaryKey>
  21     <name>id</name>
  22     <autoincrement>true</autoincrement>
  23   </primaryKey>
  24   <field>
  25     <name>domain_id</name>
  26     <title>Domain ID</title>
  27     <type>int unsigned</type>
  28     <required>true</required>
  29     <pseudoconstant>
  30       <table>civicrm_domain</table>
  31       <keyColumn>id</keyColumn>
  32       <labelColumn>name</labelColumn>
  33     </pseudoconstant>
  34     <comment>Which Domain is this navigation item for</comment>
  35     <html>
  36       <label>Domain</label>
  37     </html>
  38     <add>3.0</add>
  39   </field>
  40   <foreignKey>
  41     <name>domain_id</name>
  42     <table>civicrm_domain</table>
  43     <key>id</key>
  44     <add>3.0</add>
  45   </foreignKey>
  46   <field>
  47     <name>label</name>
  48     <title>Navigation Item Label</title>
  49     <type>varchar</type>
  50     <length>255</length>
  51     <comment>Navigation Title</comment>
  52     <add>3.0</add>
  53   </field>
  54   <field>
  55     <name>name</name>
  56     <title>Navigation Item Machine Name</title>
  57     <type>varchar</type>
  58     <length>255</length>
  59     <comment>Internal Name</comment>
  60     <add>3.0</add>
  61   </field>
  62   <field>
  63     <name>url</name>
  64     <title>Url</title>
  65     <type>varchar</type>
  66     <length>255</length>
  67     <comment>url in case of custom navigation link</comment>
  68     <add>3.0</add>
  69   </field>
  70   <field>
  71     <name>icon</name>
  72     <title>Icon</title>
  73     <type>varchar</type>
  74     <length>255</length>
  75     <comment>CSS class name for an icon</comment>
  76     <default>NULL</default>
  77     <required>false</required>
  78     <add>4.7</add>
  79   </field>
  80   <field>
  81     <name>permission</name>
  82     <title>Required Permission</title>
  83     <type>varchar</type>
  84     <length>255</length>
  85     <comment>Permission(s) needed to access menu item</comment>
  86     <serialize>COMMA</serialize>
  87     <add>3.0</add>
  88   </field>
  89   <field>
  90     <name>permission_operator</name>
  91     <title>Permission Operator</title>
  92     <type>varchar</type>
  93     <length>3</length>
  94     <pseudoconstant>
  95       <callback>CRM_Core_SelectValues::andOr</callback>
  96     </pseudoconstant>
  97     <comment>Operator to use if item has more than one permission</comment>
  98     <add>3.0</add>
  99   </field>
 100   <field>
 101     <name>parent_id</name>
 102     <title>parent ID</title>
 103     <type>int unsigned</type>
 104     <comment>Parent navigation item, used for grouping</comment>
 105     <pseudoconstant>
 106       <table>civicrm_navigation</table>
 107       <keyColumn>id</keyColumn>
 108       <nameColumn>name</nameColumn>
 109       <labelColumn>label</labelColumn>
 110     </pseudoconstant>
 111     <html>
 112       <label>parent</label>
 113     </html>
 114     <add>3.0</add>
 115   </field>
 116   <foreignKey>
 117     <name>parent_id</name>
 118     <table>civicrm_navigation</table>
 119     <key>id</key>
 120     <onDelete>CASCADE</onDelete>
 121     <add>3.0</add>
 122   </foreignKey>
 123   <field>
 124     <name>is_active</name>
 125     <title>Is Active</title>
 126     <type>boolean</type>
 127     <comment>Is this navigation item active?</comment>
 128     <default>1</default>
 129     <required>true</required>
 130     <add>3.0</add>
 131   </field>
 132   <field>
 133     <name>has_separator</name>
 134     <title>Separator</title>
 135     <type>tinyint</type>
 136     <comment>Place a separator either before or after this menu item.</comment>
 137     <default>0</default>
 138     <add>3.0</add>
 139     <pseudoconstant>
 140       <callback>CRM_Core_SelectValues::navigationMenuSeparator</callback>
 141     </pseudoconstant>
 142   </field>
 143   <field>
 144     <name>weight</name>
 145     <title>Order</title>
 146     <type>int</type>
 147     <comment>Ordering of the navigation items in various blocks.</comment>
 148     <default>0</default>
 149     <required>true</required>
 150     <add>3.0</add>
 151   </field>
 152 </table>