专业维基/id-generator

提供生成唯一递增数字ID的解析函数

资助包维护!
JeroenDeDauw

安装: 348

依赖: 0

建议者: 0

安全: 0

星级: 5

观察者: 4

分支: 1

开放问题: 1

类型:mediawiki-extension

1.0.0 2020-01-27 17:13 UTC

This package is auto-updated.

Last update: 2024-09-06 11:56:36 UTC


README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Download count

ID生成器 扩展提供了一个简约的序列数字ID生成功能。它由 Professional.Wiki 创建。

维基文本 {{#next_number:}} 第一次使用时输出 1,然后是 2,等等。

无需运行“update.php”维护脚本即可安装和使用。作为 IDProvider 扩展的替代品创建,因为它无法通过 Composer 安装,并且还需要额外的数据库表。

用法

获取新的数字ID

{{#next_number:}}

上述函数将在每次重新解析页面时输出新的数字。如果您想要生成一次数字,可以使用以下 MediaWiki 的 subst 函数

{{subst:#next_number:}}

您可以通过提供 ID 类型来拥有多个 ID 序列。此类型可以是任意长至60个字符的字符串。

{{#next_number:project}}

数字增量详情

  • ID是在全局范围内增加的,而不是每页。
  • 增量在每次解析时发生。
  • MediaWiki 可能会在每次保存时多次解析解析函数,因此函数输出可能会从1变为3。
  • 您将保证每次生成时都能得到更高的ID。使用不受跟踪,因此没有复用。

示例

带有 {{#next_number:}} {{#next_number:}} 的页面将输出 1 2,假设扩展刚刚安装。如果ID计数器已经达到100,您将得到 101 102。如果您然后刷新此页面,您将得到 103 104

平台要求

  • PHP 7.1或更高版本
  • MediaWiki 1.31或更高版本(以及可能的老版本)

安装

推荐使用 Composer 和 MediaWiki 内置的 Composer 支持来安装 ID 生成器。

步骤 1

切换到您的 MediaWiki 安装的基础目录。如果您还没有 "composer.local.json" 文件,请创建一个并添加以下内容到其中

{
	"require": {
		"professional-wiki/id-generator": "~1.0"
	}
}

如果您已经有了 "composer.local.json" 文件,请将以下行添加到文件中 "require" 部分的末尾

"professional-wiki/id-generator": "~1.0"

请记住在此部分末尾添加逗号。

步骤 2

在您的 shell 中运行以下命令

php composer.phar update --no-dev

注意:如果您在系统上安装了 Git,请向上述命令添加 --prefer-source 标志。

步骤 3

将以下行添加到您的 "LocalSettings.php" 文件的末尾

wfLoadExtension( 'IdGenerator' );

贡献和支持

如果您想为项目做出贡献,请订阅开发者邮件列表并查看贡献指南。

许可证

BSD 3-Clause "新"或"修订"许可证(BSD-3-Clause).

发行说明

版本 1.0.0

发布于 2020 年 1 月 27 日。

首次发布