How is the <sequence> tag defined and handled in a module.xml?

dmitry_fedyuk · April 9, 2016, 1:50am

Schema

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Module/etc/module.xsd#L33-L43


<xs:element minOccurs="0" maxOccurs="1" name="sequence" type="moduleSequence">
    <xs:unique name="uniqueSequenceName">
        <xs:annotation>
            <xs:documentation>
                Dependency name must be unique.
            </xs:documentation>
        </xs:annotation>
        <xs:selector xpath=".//*" />
        <xs:field xpath="@name" />
    </xs:unique>
</xs:element>

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Module/etc/module.xsd#L49-L67


<xs:complexType name="moduleSequence">
    <xs:annotation>
        <xs:documentation>
            Module dependency root element.
        </xs:documentation>
    </xs:annotation>
    <xs:sequence maxOccurs="unbounded">
        <xs:element minOccurs="0" maxOccurs="unbounded" name="module">
            <xs:complexType>
                <xs:annotation>
                    <xs:documentation>
                        Module dependency that represents another module.
                    </xs:documentation>
                </xs:annotation>
                <xs:attribute name="name" type="moduleName" use="required" />
            </xs:complexType>
        </xs:element>
    </xs:sequence>
</xs:complexType>

Examples

github.com

magento/magento2/blob/ec436ce/app/code/Magento/AdminNotification/etc/module.xml#L9-L13


<module name="Magento_AdminNotification" setup_version="2.0.0">
    <sequence>
        <module name="Magento_Store"/>
    </sequence>
</module>

github.com

magento/magento2/blob/ec436ce/app/code/Magento/Authorizenet/etc/module.xml#L9-L15


<module name="Magento_Authorizenet" setup_version="2.0.0">
    <sequence>
        <module name="Magento_Sales"/>
        <module name="Magento_Quote"/>
        <module name="Magento_Checkout"/>
    </sequence>
</module>

Handling

How does \Magento\Framework\Module\ModuleList\Loader::sortBySequence() work?

Any modules sequence changes will be applied only on the app/etc/config.php file generation.

dmitry_fedyuk · April 9, 2016, 5:42am