< 返回 4.3 组件的XML清单文件 - E计划

上一节我们成功的安装了一个最简单的组件,并且初步的探讨了一下组件成功安装的意义。在这一节就来看看这个最简单的组件是如何制作的。重点了解joomla组件的名称和XML清单文件

1,本节目标


了解Joomla组件的XML清单文件。

2,组件XML清单文件


将组件的v1.0.0版本解压后,可以发现里面只有一个zmaxbook.xml文件。com_zmaxbookv1.0.0_2020-10-23_for_j3x.zip

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.0.0" method="upgrade">
	<name>zmaxbook</name>
	<version>1.0.0</version>
	<administration>
		<!-- 后台管理菜单名称-->
		<menu>ZMAX图书管理系统</menu>				
	</administration>
</extension>

这里的zmaxbook.xml文件就是本节需要学习的组件XML清单文件。所谓的清单文件,顾名思义,就是要描述我们这个组件需要的所有资源的一个清单,或者一个说明。这个文件是有固定的格式的。大家在开发自己组件的时候只需要更改XML节点中的内容即可。

3,主要节点的说明


extension节点


extension节点是组件清单文件的根节点。这个节点有3个属性:

  • type:扩展的类型,因为我们开发的是组件,所以这里固定为componet
  • version:扩展要求的最低Joomla版本。在上面我们指定这个扩展只能在3.0.0以后的Joomla上运行
  • method:扩展的安装方式。一般我们将其设置为upgrade.以更新的方式来安装,这样可以保留我们旧版本上的所有数据

name节点


在上面的Extension 的子节点中,最重要的是name节点。这个节点表明我们组件的名称。

在joomla中,每一个组件的名称都必须是唯一的,为了避免和其他开发者开发的组件重名,一般我们会在组件名称上加上自己或者公司特有的标识,比如 zmaxbook中的zmax就是我们ZMAX程序人公司的特有标识。

请特别注意:这个name节点不能写中文,只能是字母数字下划线。

version节点


这个节点用来记录我们组件当前的版本号,系统会依据这个版本号,来处理组件更新的相关事件。

menu节点


menu节点标识了我们组件在后台的名称。其实这个字段并不是必须得,只不过为了表明组件安装成功,我特意加上去的。这里的内容是可以使用中文的。

组件的清单XML文件除了上面的节点为,还有很多其他的节点。比如说标识文件的 file节点,标识文件夹的folder节点。在后面的学习中我们将慢慢了解。

4,约定优于设计原则


在Joomla中,有一个原则就是约定优于设计。简单的来说,当你的组件的名称确定后,系统会自动的依据你的组件的名称来加载相应的辅助文件。举例说明,当我们的组件名称定为zmaxbook的时候,那么系统就会去寻找zmaxbook.xml文件来做为组件的清单文件。如果找不到zmaxbook.xml文件,就会提示安装失败。

不仅仅是这个清单文件有名称依赖,在后面学到视图,模型的时候这个依赖关系将更加的明显。所以请大家一定要熟记:约定优于设计。

  • 内容提要
  • 留言讨论 (0)
  • 视频教程

上一节我们成功的安装了一个最简单的组件,并且初步的探讨了一下组件成功安装的意义。在这一节就来看看这个最简单的组件是如何制作的。重点了解joomla组件的名称和XML清单文件

评论 (0)

  • 最新在前
  • 最佳在前

内容待完善

该课程提供视频版,可以观看完整的视频教程