Heratio Framework API Reference

PiiRedactionProviderInterface
in

Interface for PII redaction providers.

Plugins that provide PDF/document redaction capabilities should implement this. Register via: AtomFramework\Providers::register('pii_redaction', $implementation)

Table of Contents

Methods

getRedactedPdf()  : array<string|int, mixed>
Get a redacted version of a PDF file.
hasRedaction()  : bool
Check if redaction is available for an object.

Methods

getRedactedPdf()

Get a redacted version of a PDF file.

public getRedactedPdf(int $objectId, string $originalPath) : array<string|int, mixed>
Parameters
$objectId : int

The information object ID

$originalPath : string

Path to the original PDF

Return values
array<string|int, mixed>

['success' => bool, 'path' => string, 'error' => ?string]

hasRedaction()

Check if redaction is available for an object.

public hasRedaction(int $objectId) : bool
Parameters
$objectId : int
Return values
bool

        
On this page

Search results