elements.xsd 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /**
  4. * Copyright © Magento, Inc. All rights reserved.
  5. * See COPYING.txt for license details.
  6. */
  7. -->
  8. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  9. <!-- Redefine section -->
  10. <xs:redefine schemaLocation="urn:magento:framework:Data/etc/argument/types.xsd">
  11. <xs:complexType name="argumentType" abstract="true" mixed="true">
  12. <xs:complexContent>
  13. <xs:extension base="argumentType">
  14. <xs:sequence>
  15. <xs:element name="updater" type="updaterType" minOccurs="0" maxOccurs="1"/>
  16. </xs:sequence>
  17. </xs:extension>
  18. </xs:complexContent>
  19. </xs:complexType>
  20. </xs:redefine>
  21. <!-- Defined the types of elements -->
  22. <!-- Elements -->
  23. <xs:element type="blockType" name="block">
  24. <xs:annotation>
  25. <xs:documentation>
  26. Argument name must be unique in scope of block.
  27. </xs:documentation>
  28. </xs:annotation>
  29. <xs:key name="blockArgumentName">
  30. <xs:selector xpath="./arguments/argument"></xs:selector>
  31. <xs:field xpath="@name"></xs:field>
  32. </xs:key>
  33. </xs:element>
  34. <xs:element type="blockReferenceType" name="referenceBlock">
  35. <xs:annotation>
  36. <xs:documentation>
  37. Argument name must be unique in scope of reference.
  38. </xs:documentation>
  39. </xs:annotation>
  40. <xs:unique name="referenceBlockArgumentName">
  41. <xs:selector xpath="./arguments/argument"></xs:selector>
  42. <xs:field xpath="@name"></xs:field>
  43. </xs:unique>
  44. </xs:element>
  45. <xs:element type="containerReferenceType" name="referenceContainer"/>
  46. <xs:element type="uiComponentType" name="uiComponent">
  47. <xs:annotation>
  48. <xs:documentation>
  49. Argument name must be unique in scope of all Blocks, Containers and other UI Components.
  50. </xs:documentation>
  51. </xs:annotation>
  52. <xs:key name="uiElementArgumentName">
  53. <xs:selector xpath="./argument"/>
  54. <xs:field xpath="@name"/>
  55. </xs:key>
  56. </xs:element>
  57. <xs:element name="arguments" type="argumentsType"/>
  58. <xs:element name="update" type="updateType"/>
  59. <xs:element name="remove" type="removeType"/>
  60. <xs:element name="move" type="moveType"/>
  61. <!-- Simple types -->
  62. <xs:simpleType name="handlePageType">
  63. <xs:restriction base="xs:string">
  64. <xs:enumeration value="page"/>
  65. </xs:restriction>
  66. </xs:simpleType>
  67. <xs:simpleType name="componentNameType">
  68. <xs:restriction base="xs:string">
  69. <xs:pattern value="[a-zA-Z][a-zA-Z\d\-_\.]*"/>
  70. </xs:restriction>
  71. </xs:simpleType>
  72. <xs:simpleType name="elementNameType">
  73. <xs:restriction base="xs:string">
  74. <xs:pattern value="[a-zA-Z0-9][a-zA-Z\d\-_\.]*"/>
  75. </xs:restriction>
  76. </xs:simpleType>
  77. <xs:simpleType name="elementAliasType">
  78. <xs:restriction base="xs:string">
  79. <xs:pattern value="[a-zA-Z][a-zA-Z\d\-_\.]*"/>
  80. </xs:restriction>
  81. </xs:simpleType>
  82. <xs:simpleType name="elementPositionType">
  83. <xs:restriction base="xs:string">
  84. <xs:pattern value="[a-zA-Z][a-zA-Z\d\-_\.]*|-"/>
  85. </xs:restriction>
  86. </xs:simpleType>
  87. <xs:simpleType name="elementOutputType">
  88. <xs:restriction base="xs:string">
  89. <xs:enumeration value="1"/>
  90. </xs:restriction>
  91. </xs:simpleType>
  92. <xs:simpleType name="htmlIdentifierType">
  93. <xs:restriction base="xs:string">
  94. <xs:pattern value="[a-zA-Z][a-zA-Z\d\-_:]*"/>
  95. </xs:restriction>
  96. </xs:simpleType>
  97. <xs:simpleType name="htmlClassType">
  98. <xs:restriction base="xs:string">
  99. <xs:pattern value="[a-zA-Z][a-zA-Z\d\-_]*(\s[a-zA-Z][a-zA-Z\d\-_]*)*"/>
  100. </xs:restriction>
  101. </xs:simpleType>
  102. <xs:simpleType name="htmlTagType">
  103. <xs:restriction base="xs:string">
  104. <xs:enumeration value="aside"/>
  105. <xs:enumeration value="dd"/>
  106. <xs:enumeration value="div"/>
  107. <xs:enumeration value="dl"/>
  108. <xs:enumeration value="fieldset"/>
  109. <xs:enumeration value="main"/>
  110. <xs:enumeration value="nav"/>
  111. <xs:enumeration value="header"/>
  112. <xs:enumeration value="footer"/>
  113. <xs:enumeration value="ol"/>
  114. <xs:enumeration value="p"/>
  115. <xs:enumeration value="section"/>
  116. <xs:enumeration value="table"/>
  117. <xs:enumeration value="tfoot"/>
  118. <xs:enumeration value="ul"/>
  119. </xs:restriction>
  120. </xs:simpleType>
  121. <xs:simpleType name="blockClassType">
  122. <xs:restriction base="xs:string">
  123. <xs:pattern value="[A-Z][_a-zA-Z\d]*(\\[A-Z][_a-zA-Z\d]*)*"/>
  124. </xs:restriction>
  125. </xs:simpleType>
  126. <!-- Complex types -->
  127. <xs:complexType name="containerType">
  128. <xs:annotation>
  129. <xs:documentation>
  130. Container for structuring elements of a page.
  131. </xs:documentation>
  132. </xs:annotation>
  133. <xs:sequence minOccurs="0" maxOccurs="unbounded">
  134. <xs:element ref="block" minOccurs="0" maxOccurs="unbounded"/>
  135. <xs:element name="container" type="containerType" minOccurs="0" maxOccurs="unbounded"/>
  136. <xs:element ref="referenceBlock" minOccurs="0" maxOccurs="unbounded"/>
  137. <xs:element ref="referenceContainer" minOccurs="0" maxOccurs="unbounded"/>
  138. <xs:element ref="uiComponent" minOccurs="0" maxOccurs="unbounded"/>
  139. </xs:sequence>
  140. <xs:attribute type="elementNameType" name="name"/>
  141. <xs:attribute type="xs:string" name="label"/>
  142. <xs:attribute type="elementOutputType" name="output"/>
  143. <xs:attribute type="elementAliasType" name="as"/>
  144. <xs:attribute type="elementPositionType" name="after"/>
  145. <xs:attribute type="elementPositionType" name="before"/>
  146. <xs:attribute type="htmlTagType" name="htmlTag"/>
  147. <xs:attribute type="htmlClassType" name="htmlClass"/>
  148. <xs:attribute type="htmlIdentifierType" name="htmlId"/>
  149. </xs:complexType>
  150. <xs:complexType name="blockType" mixed="true">
  151. <xs:annotation>
  152. <xs:documentation>
  153. Part of view that can generate appropriate content.
  154. </xs:documentation>
  155. </xs:annotation>
  156. <xs:sequence minOccurs="0" maxOccurs="unbounded">
  157. <xs:element name="action" type="actionType" minOccurs="0" maxOccurs="unbounded">
  158. <xs:annotation>
  159. <xs:documentation>
  160. Argument name must be unique in scope of action.
  161. </xs:documentation>
  162. </xs:annotation>
  163. <xs:key name="blockActionArgumentName">
  164. <xs:selector xpath="argument"></xs:selector>
  165. <xs:field xpath="@name"></xs:field>
  166. </xs:key>
  167. </xs:element>
  168. <xs:element ref="arguments" minOccurs="0" maxOccurs="1"/>
  169. <xs:element ref="block" minOccurs="0" maxOccurs="unbounded"/>
  170. <xs:element name="container" type="containerType" minOccurs="0" maxOccurs="unbounded"/>
  171. <xs:element ref="referenceBlock" minOccurs="0" maxOccurs="unbounded"/>
  172. <xs:element ref="uiComponent" minOccurs="0" />
  173. </xs:sequence>
  174. <xs:attribute type="elementNameType" name="name" use="optional"/>
  175. <xs:attribute type="blockClassType" name="class" use="optional"/>
  176. <xs:attribute type="elementAliasType" name="as" use="optional"/>
  177. <xs:attribute type="xs:string" name="template" use="optional"/>
  178. <xs:attribute type="elementPositionType" name="before" use="optional"/>
  179. <xs:attribute type="elementPositionType" name="after" use="optional"/>
  180. <xs:attribute type="elementOutputType" name="output" use="optional"/>
  181. <xs:attribute type="xs:string" name="acl" use="optional"/>
  182. <xs:attribute type="xs:string" name="aclResource" use="optional"/>
  183. <xs:attribute type="xs:string" name="ifconfig" use="optional"/>
  184. <xs:attribute type="xs:string" name="group" use="optional" />
  185. <xs:attribute type="xs:boolean" name="cacheable" default="true" use="optional"/>
  186. <xs:attribute type="xs:int" name="ttl" use="optional"/>
  187. </xs:complexType>
  188. <xs:complexType name="uiComponentType" mixed="true">
  189. <xs:annotation>
  190. <xs:documentation>
  191. Part of view that can generate appropriate content.
  192. </xs:documentation>
  193. </xs:annotation>
  194. <xs:sequence>
  195. <xs:element name="argument" type="argumentType" minOccurs="0" maxOccurs="unbounded"/>
  196. <xs:element name="visibilityCondition" type="visibilityConditionType" minOccurs="0" maxOccurs="unbounded"/>
  197. </xs:sequence>
  198. <xs:attribute type="componentNameType" name="component" use="optional"/>
  199. <xs:attribute type="elementNameType" name="name" use="optional"/>
  200. <xs:attribute type="elementAliasType" name="as" use="optional"/>
  201. <xs:attribute type="elementPositionType" name="before" use="optional"/>
  202. <xs:attribute type="elementPositionType" name="after" use="optional"/>
  203. <xs:attribute type="elementOutputType" name="output" use="optional"/>
  204. <xs:attribute type="xs:string" name="aclResource" use="optional"/>
  205. <xs:attribute type="xs:string" name="ifconfig" use="optional"/>
  206. <xs:attribute type="xs:string" name="group" use="optional" />
  207. <xs:attribute type="xs:boolean" name="cacheable" default="true" use="optional"/>
  208. <xs:attribute type="xs:int" name="ttl" use="optional"/>
  209. </xs:complexType>
  210. <xs:complexType name="actionType">
  211. <xs:annotation>
  212. <xs:documentation>
  213. Call public PHP methods of the block class.
  214. </xs:documentation>
  215. </xs:annotation>
  216. <xs:sequence>
  217. <xs:element name="argument" type="argumentType" minOccurs="0" maxOccurs="unbounded">
  218. <xs:key name="actionArgumentItemName">
  219. <xs:selector xpath="item"></xs:selector>
  220. <xs:field xpath="@name"></xs:field>
  221. </xs:key>
  222. </xs:element>
  223. </xs:sequence>
  224. <xs:attribute type="xs:string" name="method" use="required"/>
  225. <xs:attribute type="xs:string" name="ifconfig" use="optional"/>
  226. </xs:complexType>
  227. <xs:complexType name="visibilityConditionType">
  228. <xs:annotation>
  229. <xs:documentation>
  230. Apply visibility rules.
  231. </xs:documentation>
  232. </xs:annotation>
  233. <xs:choice>
  234. <xs:element ref="arguments" minOccurs="0" maxOccurs="1"/>
  235. </xs:choice>
  236. <xs:attribute type="xs:string" name="name" use="required"/>
  237. <xs:attribute type="xs:string" name="className" use="required"/>
  238. </xs:complexType>
  239. <xs:complexType name="updateType">
  240. <xs:annotation>
  241. <xs:documentation>
  242. Include another Handle's tags.
  243. </xs:documentation>
  244. </xs:annotation>
  245. <xs:attribute type="xs:string" name="handle" use="required"/>
  246. </xs:complexType>
  247. <xs:complexType name="removeType">
  248. <xs:annotation>
  249. <xs:documentation>
  250. Remove Element directive.
  251. </xs:documentation>
  252. </xs:annotation>
  253. <xs:attribute type="elementNameType" name="name" use="required"/>
  254. </xs:complexType>
  255. <xs:complexType name="moveType">
  256. <xs:annotation>
  257. <xs:documentation>
  258. Move Element directive.
  259. </xs:documentation>
  260. </xs:annotation>
  261. <xs:attribute type="elementNameType" name="element" use="required"/>
  262. <xs:attribute type="elementNameType" name="destination" use="required"/>
  263. <xs:attribute type="elementAliasType" name="as" use="optional"/>
  264. <xs:attribute type="elementPositionType" name="after" use="optional"/>
  265. <xs:attribute type="elementPositionType" name="before" use="optional"/>
  266. </xs:complexType>
  267. <xs:complexType name="blockReferenceType" mixed="true">
  268. <xs:choice minOccurs="0" maxOccurs="unbounded">
  269. <xs:element name="action" type="actionType" minOccurs="0" maxOccurs="unbounded">
  270. <xs:annotation>
  271. <xs:documentation>
  272. Argument name must be unique in scope of action.
  273. </xs:documentation>
  274. </xs:annotation>
  275. <xs:key name="blockReferenceActionArgumentName">
  276. <xs:selector xpath="argument"></xs:selector>
  277. <xs:field xpath="@name"></xs:field>
  278. </xs:key>
  279. </xs:element>
  280. <xs:element ref="arguments" minOccurs="0" maxOccurs="1"/>
  281. <xs:element ref="block" minOccurs="0"/>
  282. <xs:element name="container" type="containerType" minOccurs="0"/>
  283. <xs:element ref="referenceBlock" minOccurs="0" />
  284. <xs:element ref="referenceContainer" minOccurs="0"/>
  285. <xs:element ref="uiComponent" minOccurs="0" />
  286. </xs:choice>
  287. <xs:attribute type="elementNameType" name="name" use="required"/>
  288. <xs:attribute type="xs:string" name="template" use="optional"/>
  289. <xs:attribute type="xs:boolean" name="display" default="true" use="optional"/>
  290. <xs:attribute type="xs:boolean" name="remove" use="optional"/>
  291. </xs:complexType>
  292. <xs:complexType name="containerReferenceType" mixed="true">
  293. <xs:choice minOccurs="0" maxOccurs="unbounded">
  294. <xs:element ref="referenceContainer" minOccurs="0" />
  295. <xs:element ref="block" minOccurs="0" />
  296. <xs:element name="container" type="containerType" minOccurs="0" />
  297. <xs:element ref="referenceBlock" minOccurs="0" />
  298. <xs:element ref="uiComponent" minOccurs="0" />
  299. </xs:choice>
  300. <xs:attribute type="elementNameType" name="name" use="required"/>
  301. <xs:attribute type="htmlTagType" name="htmlTag"/>
  302. <xs:attribute type="htmlClassType" name="htmlClass"/>
  303. <xs:attribute type="htmlIdentifierType" name="htmlId"/>
  304. <xs:attribute type="xs:string" name="label"/>
  305. <xs:attribute type="xs:boolean" name="display" default="true" use="optional"/>
  306. <xs:attribute type="xs:boolean" name="remove" use="optional"/>
  307. </xs:complexType>
  308. <xs:complexType name="options">
  309. <xs:complexContent>
  310. <xs:extension base="argumentType">
  311. <xs:attribute name="model" use="required"/>
  312. </xs:extension>
  313. </xs:complexContent>
  314. </xs:complexType>
  315. <xs:complexType name="url" mixed="true">
  316. <xs:complexContent>
  317. <xs:extension base="argumentType">
  318. <xs:sequence minOccurs="0">
  319. <xs:element name="param" minOccurs="0" maxOccurs="unbounded">
  320. <xs:complexType mixed="true">
  321. <xs:attribute name="name" type="xs:string" use="required"/>
  322. </xs:complexType>
  323. </xs:element>
  324. </xs:sequence>
  325. <xs:attribute name="path" use="required"/>
  326. </xs:extension>
  327. </xs:complexContent>
  328. </xs:complexType>
  329. <xs:complexType name="serviceUrl" mixed="true">
  330. <xs:complexContent>
  331. <xs:extension base="argumentType">
  332. <xs:sequence minOccurs="0">
  333. <xs:element name="param" minOccurs="0" maxOccurs="unbounded">
  334. <xs:complexType mixed="true">
  335. <xs:attribute name="name" type="xs:string" use="required"/>
  336. </xs:complexType>
  337. </xs:element>
  338. </xs:sequence>
  339. <xs:attribute name="path" use="required"/>
  340. </xs:extension>
  341. </xs:complexContent>
  342. </xs:complexType>
  343. <xs:complexType name="helper" mixed="true">
  344. <xs:complexContent>
  345. <xs:extension base="argumentType">
  346. <xs:sequence minOccurs="0">
  347. <xs:element name="param" minOccurs="0" maxOccurs="unbounded">
  348. <xs:complexType mixed="true">
  349. <xs:attribute name="name" type="xs:string" use="required"/>
  350. </xs:complexType>
  351. </xs:element>
  352. </xs:sequence>
  353. <xs:attribute name="helper" use="required"/>
  354. </xs:extension>
  355. </xs:complexContent>
  356. </xs:complexType>
  357. <xs:complexType name="updaterType">
  358. <xs:annotation>
  359. <xs:documentation>
  360. Argument updater.
  361. </xs:documentation>
  362. </xs:annotation>
  363. <xs:simpleContent>
  364. <xs:extension base="xs:string">
  365. <xs:attribute type="xs:integer" name="sortOrder" use="optional"/>
  366. <xs:attribute type="xs:string" name="enabled" use="optional"/>
  367. </xs:extension>
  368. </xs:simpleContent>
  369. </xs:complexType>
  370. </xs:schema>