Documentation

Redmine
in package

Helper for updating the ACDH Redmine issues documenting the curation process

Tags
author

zozlak

Table of Contents

Constants

ISSUE_STATUSES  = ['New', 'In Progress', 'Resolved', 'Feedback', 'Closed', 'Rejected', 'Needs review', 'On Hold']
SUBTASKS  = ['Virus scan' => ["Virus scan failed", "Virus scan performed successfully"], 'Run repo-file-checker' => ["repo-file-checker found errors", "repo-file-checker exposed no error"], 'Prepare Ingest Files' => ["Failed to prepare files for an ingestion", "Successfully preparred files for an ingestion"], 'Upload AIP to Curation Instance (Minerva)' => ["Failed to upload data to the curation instance", "Successfully uploaded data to the curation instance"], 'Upload AIP to Productive Instance (Apollo)' => ["Failed to upload data to the production instance", "Successfully uploaded data to the production instance"], 'Create PID' => ["Failed to create PIDs", "Successfully created PIDs"]]

Properties

$apiBase  : string
$redmine  : NativeCurlClient

Methods

__construct()  : mixed
updateIssue()  : int

Constants

ISSUE_STATUSES

public mixed ISSUE_STATUSES = ['New', 'In Progress', 'Resolved', 'Feedback', 'Closed', 'Rejected', 'Needs review', 'On Hold']

SUBTASKS

public mixed SUBTASKS = ['Virus scan' => ["Virus scan failed", "Virus scan performed successfully"], 'Run repo-file-checker' => ["repo-file-checker found errors", "repo-file-checker exposed no error"], 'Prepare Ingest Files' => ["Failed to prepare files for an ingestion", "Successfully preparred files for an ingestion"], 'Upload AIP to Curation Instance (Minerva)' => ["Failed to upload data to the curation instance", "Successfully uploaded data to the curation instance"], 'Upload AIP to Productive Instance (Apollo)' => ["Failed to upload data to the production instance", "Successfully uploaded data to the production instance"], 'Create PID' => ["Failed to create PIDs", "Successfully created PIDs"]]

Properties

$redmine

private NativeCurlClient $redmine

Methods

__construct()

public __construct(string $apiBase, string $userOrToken[, string $pswd = '' ]) : mixed
Parameters
$apiBase : string
$userOrToken : string
$pswd : string = ''

updateIssue()

public updateIssue(int $issueId, string $subtask, bool $status[, string|null $issueStatus = null ][, int|null $done = null ][, string $message = '' ][, bool $append = false ]) : int
Parameters
$issueId : int
$subtask : string
$status : bool
$issueStatus : string|null = null
$done : int|null = null
$message : string = ''
$append : bool = false
Tags
throws
RuntimeException
Return values
int —

id of the actually updated redmine issue


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results