Skip to content

Class ZugferdSettings

HorstOeko edited this page Nov 23, 2024 · 6 revisions

Summary

Class representing the general settings

Methods

getAmountDecimals [static]

Summary

Get the number of decimals to use for amount values

Signature

public static function getAmountDecimals(): int;

Returns

Returns a value of type int

setAmountDecimals [static]

Summary

Set the number of decimals to use for amount values

Signature

public static function setAmountDecimals(int $amountDecimals): void;

Parameters

Name Type Allows Null Description
amountDecimals int

getQuantityDecimals [static]

Summary

Get the number of decimals to use for amount values

Signature

public static function getQuantityDecimals(): int;

Returns

Returns a value of type int

setQuantityDecimals [static]

Summary

Set the number of decimals to use for quantity values

Signature

public static function setQuantityDecimals(int $quantityDecimals): void;

Parameters

Name Type Allows Null Description
quantityDecimals int

getPercentDecimals [static]

Summary

Get the number of decimals to use for percent values

Signature

public static function getPercentDecimals(): int;

Returns

Returns a value of type int

setPercentDecimals [static]

Summary

Set the number of decimals to use for percent values

Signature

public static function setPercentDecimals(int $percentDecimals): void;

Parameters

Name Type Allows Null Description
percentDecimals int

getMeasureDecimals [static]

Summary

Get the number of decimals to use for measure values

Signature

public static function getMeasureDecimals(): int;

Returns

Returns a value of type int

setMeasureDecimals [static]

Summary

Set the number of decimals to use for measure values

Signature

public static function setMeasureDecimals(int $measureDecimals): void;

Parameters

Name Type Allows Null Description
measureDecimals int

getDecimalSeparator [static]

Summary

Get the decimal separator

Signature

public static function getDecimalSeparator(): string;

Returns

Returns a value of type string

setDecimalSeparator [static]

Summary

Set the decimal separator

Signature

public static function setDecimalSeparator(string $decimalSeparator): void;

Parameters

Name Type Allows Null Description
decimalSeparator string

getThousandsSeparator [static]

Summary

Get the thousands separator

Signature

public static function getThousandsSeparator(): string;

Returns

Returns a value of type string

setThousandsSeparator [static]

Summary

Set the thousands separator

Signature

public static function setThousandsSeparator(string $thousandsSeparator): void;

Parameters

Name Type Allows Null Description
thousandsSeparator string

getIccProfileFilename [static]

Summary

Get the filename of the ICC Profile

Signature

public static function getIccProfileFilename(): string;

Returns

Returns a value of type string

setIccProfileFilename [static]

Summary

Set the filename of the ICC Profile

Signature

public static function setIccProfileFilename(string $iccProfileFilename): void;

Parameters

Name Type Allows Null Description
iccProfileFilename string

getXmpMetaDataFilename [static]

Summary

Get the filename for the XMP meta data

Signature

public static function getXmpMetaDataFilename(): string;

Returns

Returns a value of type string

setXmpMetaDataFilename [static]

Summary

Set the filename for the XMP meta data

Signature

public static function setXmpMetaDataFilename(string $xmpMetaDataFilename): void;

Parameters

Name Type Allows Null Description
xmpMetaDataFilename string

getSpecialDecimalPlacesMaps [static]

Summary

Returns a list of node paths which have a special number of decimal places

Signature

public static function getSpecialDecimalPlacesMaps(): array;

Returns

Returns a value of type array

getSpecialDecimalPlacesMap [static]

Summary

Get a specific map for node paths with a special number of decimal places. If not map
is found then the default value is returns

Signature

public static function getSpecialDecimalPlacesMap(string $nodePath, int $defaultDecimalPlaces): int;

Parameters

Name Type Allows Null Description
nodePath string
defaultDecimalPlaces int

Returns

Returns a value of type int

setSpecialDecimalPlacesMaps [static]

Summary

Update the map of node paths which have a special number of decimal places

Signature

public static function setSpecialDecimalPlacesMaps(array $specialDecimalPlacesMaps): void;

Parameters

Name Type Allows Null Description
specialDecimalPlacesMaps array

addSpecialDecimalPlacesMap [static]

Summary

Add a new map for a node path with a special number of decimal places

Signature

public static function addSpecialDecimalPlacesMap(string $nodePath, int $defaultDecimalPlaces): void;

Parameters

Name Type Allows Null Description
nodePath string
defaultDecimalPlaces int

setUnitAmountDecimals [static]

Summary

Set the number of decimals to use for unit single amount (unit prices) values

Signature

public static function setUnitAmountDecimals(int $amountDecimals): void;

Parameters

Name Type Allows Null Description
amountDecimals int

getRootDirectory [static]

Summary

Get root directory

Signature

public static function getRootDirectory(): string;

Returns

Returns a value of type string

getSourceDirectory [static]

Summary

Get the directory where all the sources are stored

Signature

public static function getSourceDirectory(): string;

Returns

Returns a value of type string

getAssetDirectory [static]

Summary

Get the directory where all the assets are stored

Signature

public static function getAssetDirectory(): string;

Returns

Returns a value of type string

getYamlDirectory [static]

Summary

Get the directory where all the assets are stored

Signature

public static function getYamlDirectory(): string;

Returns

Returns a value of type string

getValidationDirectory [static]

Summary

Get the directory where all the validation files are located

Signature

public static function getValidationDirectory(): string;

Returns

Returns a value of type string

getSchemaDirectory [static]

Summary

Get the directory where all the schema (XSD) files are located

Signature

public static function getSchemaDirectory(): string;

Returns

Returns a value of type string

getFullIccProfileFilename [static]

Summary

Get the full filename of the ICC profile to use

Signature

public static function getFullIccProfileFilename(): string;

Returns

Returns a value of type string

getFullXmpMetaDataFilename [static]

Summary

Get the full filename containg the XNP information to user

Signature

public static function getFullXmpMetaDataFilename(): string;

Returns

Returns a value of type string

Clone this wiki locally