Yireo_GoogleTagManager2 开源项目教程
Yireo_GoogleTagManager2项目地址:https://gitcode.com/gh_mirrors/yi/Yireo_GoogleTagManager2
Yireo_GoogleTagManager2 是一个专为 Magento 2 平台设计的扩展,用于集成 Google Tag Manager (GTM) 的功能,支持GA4(Google Analytics 4)并移除了对旧版UA/EE的支持。本教程将引导您了解其基本的目录结构、启动文件与配置文件,以便于您更好地理解和运用此插件。
1. 项目目录结构及介绍
Yireo_GoogleTagManager2 的目录结构遵循 Magento 2 扩展的标准布局。以下是一些关键目录及其大致说明:
-
app/code/Yireo/GoogleTagManager2
主要代码存放区域,包括模型、块、控制器等。Block
: 包含用于前端展示或处理数据的块类。Controller
: 控制器,处理HTTP请求与响应的关键部分。Model
: 各种业务逻辑和数据模型。Setup
: 数据安装与升级脚本,负责数据库结构调整。
-
etc
配置文件所在目录,分为adminhtml
、frontend
以及global
等子目录,定义系统配置与权限。config.xml
: 主配置文件,声明模块的依赖、版本等基本信息。di.xml
: 定义依赖注入规则。
-
/view
前端视图资源,包括布局、模板、CSS、JavaScript等。- 分别有
adminhtml
与frontend
对应后台与前台资源。
- 分别有
-
registration.php 和 module.xml
这两个文件位于项目根目录下,是Magento识别和启用该模块的基础。
2. 项目的启动文件介绍
registration.php
位于项目根目录下的registration.php
是模块注册文件,它告诉Magento系统这个模块的存在。示例内容一般如下:
<?php
use Magento\Framework\Component\ComponentRegistrar;
ComponentRegistrar::register(
ComponentRegistrar::MODULE,
'Yireo_GoogleTagManager2',
__DIR__
);
module.xml
同样在根目录,module.xml
提供模块的元数据,如名称、版本和依赖关系:
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Yireo_GoogleTagManager2" setup_version="3.0.0"/>
</config>
3. 项目的配置文件介绍
Yireo_GoogleTagManager2的主要配置通常位于etc
目录下,通过XML文件定义。特别注意的是,在Magento 2中,配置可能分散在多个文件中,包括全局配置、管理员配置以及视图特定配置。
-
system.xml 若存在,此文件位于
etc/adminhtml/system.xml
,它提供了模块在Magento后台的配置界面,允许管理员设置GTM容器ID等参数。 -
** di.xml** 在
etc/di.xml
中定义依赖注入,帮助模块高效地组织和复用组件。 -
config.xml(如果适用) 虽然现代Magento 2扩展更倾向于使用
module.xml
和其它专用配置文件,但一些老旧或特定制模块可能会保留使用config.xml
来配置模块的基本信息。
请注意,具体的文件路径和内容可能随着版本更新而有所变化。安装和详细配置过程涉及Composer安装、Magento后台配置等步骤,不在本文档范围内。务必参考项目的最新官方文档或Release Notes进行操作。
Yireo_GoogleTagManager2项目地址:https://gitcode.com/gh_mirrors/yi/Yireo_GoogleTagManager2