README

本项目旨在提供一个易于使用的 php 接口，用于

• 提供符合 Schema 标准的 DataCite 元数据（Schema 4.4）
• 通过 DataCite API 注册/更新 DOI 元数据。

注意

• 这并非完整的 API 实现；它仅覆盖 Dagstuhl Publishing 所需的使用场景。
• 这是内部 git 的 master 分支的镜像。

安装：composer require dagstuhl/datacite

代码示例

1) 创建元数据记录

• 一般信息

$dataCiteRecord = new DataCiteRecord();
$dataCiteRecord->setDoi('10.publisher.example-doi');
$dataCiteRecord->addTitle(Title::main('This is an example title', 'en'));

• 添加有归属关系的作者

$creator = Creator::personal('Concatenated Names', 'Given Name', 'Family Name');
$creator->addAffiliation(new Affiliation('This is a sample affiliation'));

$dataCiteRecord->addCreator($creator);

• 根据 ror 标识符添加有归属关系的编辑

$name = Name::organizational('Schloss Dagstuhl - Leibniz-Zentrum für Informatik');
$name->addAffiliation(Affiliation::ror('00k4h2615'));
$contributor = Contributor::editor($name);

$dataCiteRecord->addContributor($contributor);

• 添加与其他资源/替代标识符的关系

$related = [];
$related[] = RelatedIdentifier::isPartOf('arXiv:....', RelatedIdentifier::TYPE_ARXIV);
$related[] = RelatedIdentifier::cites('10....', RelatedIdentifier::TYPE_DOI);

$alternate = [];
$alternate[] = AlternateIdentifier::urn('this is a demo urn');
$alternate[] = AlternateIdentifier::isbn('this is a demo urn');

$dataCiteRecord->setRelatedIdentifiers($related);
$dataCiteRecord->setAlternateIdentifiers($alternate);

• 对文档类型进行分类

$type = new Type(
    TYPE::RESOURCE_TYPE_GENERAL_TEXT,
    TYPE::RESOURCE_TYPE_BOOK,
    TYPE::BIBTEX_TYPE_BOOK
);

// or choose a pre-defined type, e.g.,

$type = Type::conferenceProceedingsPaper();
$type = Type::conferenceJournalPaper();
$type = Type::bookChapter();
...

$dataCiteRecord->setType($type);

• 添加日期字段

$dates = [];
$dates[] = Date::created('2020-10-06');
$dates[] = Date::issued('2020-10-06');
$dates[] = Date::copyrighted('2020-10-06');

$dataCiteRecord->setDates($dates);

• 查看生成的 JSON

var_dump($dataCiteRecord->toApiJson());

2) 注册/更新 DOI 元数据

• 更新现有记录

$dataCiteClient = new DataCiteClient('username', 'password', 'api-url');

$dataCiteRecord = $dataCiteClient->updateDataCiteRecord($dataCiteRecord);

if ($dataCiteRecord === NULL) {
   // error handling goes here
}

• 如果 DOI 之前未注册，相同的代码行将产生一个草稿记录。要使这些草稿数据公开并提供最终注册 DOI，只需调用

$dataCiteRecord = $dataCiteClient->setDoiState($dataCiteRecord->getDoi(), DataCiteClient::STATE_FINDABLE);

• 对于错误处理/调试，请使用以下方法显示最后一次 HTTP 请求的状态详细信息

$dataCiteClient->getException() / ...->getErrorMessage() / ->getResponse() / ->getStatus() 

3) 通过实现 DataCiteDataProvider 连接到您自己的模型

• DataCiteDataProvider 接口提供了一个干净的接口，用于您的自定义模型
• 只需在您的模型上实现此接口，并通过

class MyModelDataProvider implements \Dagstuhl\DataCite\DataCiteDataProvider {
   // ... see the interface for details ... 
}

$dataProvider = new MyModelDataProvider($myModel);     
$dataCiteRecord = DataCiteRecord::fromDataProvider($dataProvider);