events.xsd 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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. <xs:element name="config">
  10. <xs:complexType>
  11. <xs:sequence>
  12. <xs:element name="event" type="eventDeclaration" minOccurs="0" maxOccurs="unbounded">
  13. <xs:unique name="uniqueObserverName">
  14. <xs:annotation>
  15. <xs:documentation>
  16. Observer name must be unique.
  17. </xs:documentation>
  18. </xs:annotation>
  19. <xs:selector xpath="observer"/>
  20. <xs:field xpath="@name"/>
  21. </xs:unique>
  22. </xs:element>
  23. </xs:sequence>
  24. </xs:complexType>
  25. <xs:unique name="uniqueEventName">
  26. <xs:annotation>
  27. <xs:documentation>
  28. Event name must be unique.
  29. </xs:documentation>
  30. </xs:annotation>
  31. <xs:selector xpath="event" />
  32. <xs:field xpath="@name" />
  33. </xs:unique>
  34. </xs:element>
  35. <xs:complexType name="eventDeclaration">
  36. <xs:annotation>
  37. <xs:documentation>
  38. Event declaration.
  39. </xs:documentation>
  40. </xs:annotation>
  41. <xs:sequence>
  42. <xs:element name="observer" type="observerDeclaration" minOccurs="1" maxOccurs="unbounded" />
  43. </xs:sequence>
  44. <xs:attribute name="name" type="eventName" use="required" />
  45. </xs:complexType>
  46. <xs:complexType name="observerDeclaration">
  47. <xs:annotation>
  48. <xs:documentation>
  49. Observer declaration.
  50. </xs:documentation>
  51. </xs:annotation>
  52. <xs:attribute name="name" type="xs:string" use="required" />
  53. <xs:attribute name="instance" type="xs:string" use="optional" />
  54. <xs:attribute name="disabled" type="xs:boolean" use="optional" />
  55. <xs:attribute name="shared" type="xs:boolean" use="optional" />
  56. </xs:complexType>
  57. <xs:simpleType name="eventName">
  58. <xs:annotation>
  59. <xs:documentation>
  60. Event name can contain only [a-zA-Z0-9_].
  61. </xs:documentation>
  62. </xs:annotation>
  63. <xs:restriction base="xs:string">
  64. <xs:pattern value="[a-zA-Z0-9_]+" />
  65. </xs:restriction>
  66. </xs:simpleType>
  67. </xs:schema>