routes.xsd 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /**
  4. * This schema should be applied for validation of separate router.xml files
  5. *
  6. * Copyright © Magento, Inc. All rights reserved.
  7. * See COPYING.txt for license details.
  8. */
  9. -->
  10. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  11. <xs:element name="config">
  12. <xs:complexType>
  13. <xs:sequence>
  14. <xs:element name="router" minOccurs="1" maxOccurs="unbounded">
  15. <xs:annotation>
  16. <xs:documentation>
  17. Router collects routes, parses request and performs matching of request to route.
  18. </xs:documentation>
  19. </xs:annotation>
  20. <xs:complexType>
  21. <xs:sequence>
  22. <xs:choice>
  23. <xs:element name="route" minOccurs="1" maxOccurs="unbounded" type="routeType">
  24. <xs:unique name="uniqueModuleName">
  25. <xs:annotation>
  26. <xs:documentation>Module name should be unique for route</xs:documentation>
  27. </xs:annotation>
  28. <xs:selector xpath="module" />
  29. <xs:field xpath="@name" />
  30. </xs:unique>
  31. </xs:element>
  32. </xs:choice>
  33. </xs:sequence>
  34. <xs:attribute name="id" use="required" type="routerIdType" />
  35. </xs:complexType>
  36. <xs:unique name="uniqueRouteId">
  37. <xs:annotation>
  38. <xs:documentation>Route id should be unique</xs:documentation>
  39. </xs:annotation>
  40. <xs:selector xpath="route" />
  41. <xs:field xpath="@id" />
  42. </xs:unique>
  43. <xs:unique name="uniqueRouteFrontName">
  44. <xs:annotation>
  45. <xs:documentation>Route front name should be unique</xs:documentation>
  46. </xs:annotation>
  47. <xs:selector xpath="route" />
  48. <xs:field xpath="@frontName" />
  49. </xs:unique>
  50. </xs:element>
  51. </xs:sequence>
  52. </xs:complexType>
  53. <xs:unique name="uniqueRouterId">
  54. <xs:annotation>
  55. <xs:documentation>Router id should be unique in file</xs:documentation>
  56. </xs:annotation>
  57. <xs:selector xpath="router" />
  58. <xs:field xpath="@id" />
  59. </xs:unique>
  60. </xs:element>
  61. <xs:simpleType name="routerIdType">
  62. <xs:annotation>
  63. <xs:documentation>
  64. Unique router identifier.
  65. </xs:documentation>
  66. </xs:annotation>
  67. <xs:restriction base="xs:string">
  68. <xs:pattern value="[A-Za-z0-9\-_]{3,}" />
  69. </xs:restriction>
  70. </xs:simpleType>
  71. <xs:complexType name="routeType">
  72. <xs:annotation>
  73. <xs:documentation>
  74. Route declares requests to process with desired priority and points a module to perform it.
  75. </xs:documentation>
  76. </xs:annotation>
  77. <xs:sequence>
  78. <xs:choice>
  79. <xs:element name="module" minOccurs="1" maxOccurs="unbounded" type="moduleType" />
  80. </xs:choice>
  81. </xs:sequence>
  82. <xs:attribute name="id" use="required" type="routeIdType" />
  83. <xs:attribute name="frontName" use="optional" type="routeFrontNameType" />
  84. </xs:complexType>
  85. <xs:simpleType name="routeIdType">
  86. <xs:annotation>
  87. <xs:documentation>
  88. Unique route identifier.
  89. </xs:documentation>
  90. </xs:annotation>
  91. <xs:restriction base="xs:string">
  92. <xs:pattern value="[A-Za-z0-9_]{3,}" />
  93. </xs:restriction>
  94. </xs:simpleType>
  95. <xs:complexType name="moduleType">
  96. <xs:annotation>
  97. <xs:documentation>
  98. Module is subscribed to process request with corresponding route front name.
  99. </xs:documentation>
  100. </xs:annotation>
  101. <xs:attribute name="name" use="required" type="moduleNameType" />
  102. <xs:attribute name="before" use="optional" type="beforeAfterType" />
  103. <xs:attribute name="after" use="optional" type="beforeAfterType" />
  104. </xs:complexType>
  105. <xs:simpleType name="moduleNameType">
  106. <xs:annotation>
  107. <xs:documentation>
  108. Module name. For example, Magento_User.
  109. </xs:documentation>
  110. </xs:annotation>
  111. <xs:restriction base="xs:string">
  112. <xs:pattern value="[A-Za-z0-9_]{3,}" />
  113. </xs:restriction>
  114. </xs:simpleType>
  115. <xs:simpleType name="beforeAfterType">
  116. <xs:annotation>
  117. <xs:documentation>
  118. Attributes "before" and "after" help you to specify a priority of routes matching.
  119. </xs:documentation>
  120. </xs:annotation>
  121. <xs:restriction base="xs:string">
  122. <xs:pattern value="[A-Za-z0-9_]{3,}" />
  123. </xs:restriction>
  124. </xs:simpleType>
  125. <xs:simpleType name="routeFrontNameType">
  126. <xs:annotation>
  127. <xs:documentation>
  128. URL part associated with route.
  129. </xs:documentation>
  130. </xs:annotation>
  131. <xs:restriction base="xs:string">
  132. <xs:pattern value="[A-Za-z0-9_\-]{1,}" />
  133. </xs:restriction>
  134. </xs:simpleType>
  135. </xs:schema>