README

Wikimate 是一个针对 MediaWiki 动作 API 的 PHP 包装器，旨在非常容易使用。它目前包括三个类

• Wikimate – 作为不同维基对象（例如页面）的加载器和管理者。
• WikiPage – 提供获取/编辑页面或其部分内容的接口。
• WikiFile – 提供下载/上传文件及其属性获取的接口。

Wikimate 的最新发布版本是 v1.1.0，发布于 2023 年 7 月 30 日。它需要 PHP v5.3 或更高版本以及 MediaWiki v1.27 或更高版本。有关详细版本历史，请参阅 CHANGELOG.md。

安装

需求： PHP 和 Composer。

首先，由于 Wikimate 是用 PHP 编写的，一种服务器端语言，您需要安装 PHP 以运行它。使用您首选的软件包管理工具安装它（例如，在 Ubuntu Linux 上，您可以运行： sudo apt-get install php）

安装此库的推荐方法是使用 Composer。Composer 是一个 PHP 的依赖关系管理工具，允许您声明项目需要的依赖关系并将它们安装到项目中。

按照此处的说明安装 Composer。

然后，在项目文件夹中运行以下命令以下载 Wikimate 并初始化它

composer require hamstar/Wikimate

(或 composer.bat require hamstar/Wikimate 如果您使用的是 Windows)。

要在其他项目中使用 Wikimate，您可以通过将以下内容添加到现有的 composer.json 文件中来将其作为 Composer 依赖项添加

{
    "require": {
        "hamstar/Wikimate": "^1.1"
    }
}

您可以在 getcomposer.org 上找到有关如何安装 Composer、配置自动加载以及其他定义依赖关系的最佳实践的更多信息。

用法

在您的脚本文件（例如 index.php）中，包含项目的 autoload.php 文件，并使用目标维基的 API 地址创建一个新的 Wikimate 对象。然后，向 Wikimate 的 login 方法提供用户名和密码，以登录到该维基。

require __DIR__.'/vendor/autoload.php';

$api_url = 'https://example.com/w/api.php';
$username = 'bot';
$password = 'password';

$wiki = new Wikimate($api_url);

// You can also pass the domain name:
// $wiki->login($username, $password, $domainName)
if ($wiki->login($username, $password))
	echo 'Success: user logged in.' ;
else {
	$error = $wiki->getError();
	echo "<b>Wikimate error</b>: ".$error['auth'];
}

此示例使用 echo 语句输出任何潜在的错误。如果认证失败，您应该得到一个有意义的错误消息。假设您已成功登录，现在您已经准备好完全使用 API。

有关执行常见任务的详细示例代码，请参阅 USAGE.md。

贡献

作为一个开源项目，Wikimate 欢迎社区贡献。有关如何贡献的信息，请参阅 CONTRIBUTING.md。

许可

此项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE.md。