whikloj/archivematica-php

Archivematica 的 PHP 客户端库

维护者

详细信息

github.com/whikloj/archivematicaPhp

源代码

问题

安装: 0

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 0

公开问题: 0

dev-main 2022-03-16 15:39 UTC

Requires

Requires (Dev)

MIT b8826ee4a061a7eeda777bb24b49b19320959421

  • Jared Whiklo <jared.whiklo.woop@umanitoba.ca>

This package is auto-updated.

Last update: 2024-09-16 20:45:34 UTC

README

Minimum PHP Version Github Actions LICENSE codecov

描述

这是一个用于与 Archivematica 实例交互的 PHP 客户端库。它需要 PHP >= 7.3。

安装

可以使用 Composer 命令安装此库。

composer require whikloj/archivematicaPhp

使用方法

Archivematica 客户端由一个主要的 ArchivematicaPhp 资源和几种其他对象类型组成。以下是对这些类型的描述：

ArchivematicaPhp

要实例化一个 ArchivematicPhp 实例，您需要提供您的 Archivematica URL 和存储服务 URL。您还需要设置您的用户名和 API 密钥，无论是 Archivematica 系统、存储服务还是两者都需要。

$client = ArchivematicaPhp::create(
    "http://my-archivematica.example.org",
    "http://my-archivematica.example.org:62101"
)->setAMCreds(
    "archivematicaUser",
    "archivematicaApiKey"
)->setSSCreds(
    "storageServiceUser",
    "storageServiceApiKey"
);

处理配置

您可以从服务器请求当前的处理配置。它返回一个 XML 文档。

$config = $client->getProcessingConfig();

其他操作

一旦您有一个 ArchivematicaPhp 实例，您可以通过使用它们相关联的 GET 方法请求任何其他对象。例如：

  • 传输 - $client->getTransfer()
  • 摄取 - $client->getIngest()
  • 包 - $client->getPackage()
  • 位置 - $client->getLocation()
  • 空间 - $client->getSpace()
  • 管道 - $client->getPipeline()