-
Notifications
You must be signed in to change notification settings - Fork 51
Class ZugferdPdfValidator
Class representing the validator against PDF files using VeraPDF.
This class requires a JAVA running setup
Create a ZugferdPdfValidator-Instance by an existing PDF-File
public static function fromFile(string $pdfFilename): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| pdfFilename | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Create a ZugferdPdfValidator-Instance by a given content string
public static function fromContent(string $pdfContent): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| pdfContent | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Set the PDF content to validate
public function setPdfContent(string $pdfContent): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| pdfContent | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Setup the base directory. In the base directory all files will be downloaded
and created
public function setBaseDirectory(string $newBaseDirectory): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| newBaseDirectory | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Setup the VeraPDF validator application download url
public function setValidatorDownloadUrl(string $newValidatorDownloadUrl): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| newValidatorDownloadUrl | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Set the filename of the ZIP file which contains the validation application
public function setValidatorAppZipFilename(string $newValidatorAppZipFilename): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| newValidatorAppZipFilename | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Set the Ruleset to use for validation.
Allowed values are 0, 1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4f, 4e, ua1, ua2
public function setValidatorRuleset(string $newVlidatorRuleset): \ZugferdPdfValidator
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| newVlidatorRuleset | string | ❌ |
Returns a value of type \ZugferdPdfValidator
Disable cleanup base directory
public function disableCleanup(): \ZugferdPdfValidator
{
}Returns a value of type \ZugferdPdfValidator
Enable cleanup base directory
public function enableCleanup(): \ZugferdPdfValidator
{
}Returns a value of type \ZugferdPdfValidator
Perform validation
public function validate(): \ZugferdPdfValidator
{
}Returns a value of type \ZugferdPdfValidator
Returns an array of all validation errors
public function getValidationErrors(): array
{
}Returns a value of type array
Returns true if no validation errors are present otherwise false
public function hasNoValidationErrors(): bool
{
}Returns a value of type bool
Returns true if validation errors are present otherwise false
public function hasValidationErrors(): bool
{
}Returns a value of type bool
Returns an array of all validation warnings
public function getValidationWarnings(): array
{
}Returns a value of type array
Returns true if no validation warnings are present otherwise false
public function hasNoValidationWarnings(): bool
{
}Returns a value of type bool
Returns true if validation warnings are present otherwise false
public function hasValidationWarnings(): bool
{
}Returns a value of type bool
Returns an array of all validation information
public function getValidationInformation(): array
{
}Returns a value of type array
Returns true if no validation information are present otherwise false
public function hasNoValidationInformation(): bool
{
}Returns a value of type bool
Returns true if validation Information are present otherwise false
public function hasValidationInformation(): bool
{
}Returns a value of type bool
Return an array of all internal errors (such as download error or system exceptions)
public function getProcessErrors(): array
{
}Returns a value of type array
Returns true if there are no system errors (e.g. exceptions before the validation app was called)
public function hasNoProcessErrors(): bool
{
}Returns a value of type bool
Returns true if there are any system errors (e.g. exceptions before the validation app was called)
public function hasProcessErrors(): bool
{
}Returns a value of type bool
Returns an array of all messages from process system (calling external applications)
public function getProcessOutput(): array
{
}Returns a value of type array