-
Notifications
You must be signed in to change notification settings - Fork 29
Class ZugferdSettings
Class representing the general settings
Get the number of decimals to use for amount values
public static function getAmountDecimals(): int;
Returns a value of type int
Set the number of decimals to use for amount values
public static function setAmountDecimals(int $amountDecimals): void;
Name | Type | Allows Null | Description |
---|---|---|---|
amountDecimals | int | ❌ |
Get the number of decimals to use for amount values
public static function getQuantityDecimals(): int;
Returns a value of type int
Set the number of decimals to use for quantity values
public static function setQuantityDecimals(int $quantityDecimals): void;
Name | Type | Allows Null | Description |
---|---|---|---|
quantityDecimals | int | ❌ |
Get the number of decimals to use for percent values
public static function getPercentDecimals(): int;
Returns a value of type int
Set the number of decimals to use for percent values
public static function setPercentDecimals(int $percentDecimals): void;
Name | Type | Allows Null | Description |
---|---|---|---|
percentDecimals | int | ❌ |
Get the number of decimals to use for measure values
public static function getMeasureDecimals(): int;
Returns a value of type int
Set the number of decimals to use for measure values
public static function setMeasureDecimals(int $measureDecimals): void;
Name | Type | Allows Null | Description |
---|---|---|---|
measureDecimals | int | ❌ |
Get the decimal separator
public static function getDecimalSeparator(): string;
Returns a value of type string
Set the decimal separator
public static function setDecimalSeparator(string $decimalSeparator): void;
Name | Type | Allows Null | Description |
---|---|---|---|
decimalSeparator | string | ❌ |
Get the thousands separator
public static function getThousandsSeparator(): string;
Returns a value of type string
Set the thousands separator
public static function setThousandsSeparator(string $thousandsSeparator): void;
Name | Type | Allows Null | Description |
---|---|---|---|
thousandsSeparator | string | ❌ |
Get the filename of the ICC Profile
public static function getIccProfileFilename(): string;
Returns a value of type string
Set the filename of the ICC Profile
public static function setIccProfileFilename(string $iccProfileFilename): void;
Name | Type | Allows Null | Description |
---|---|---|---|
iccProfileFilename | string | ❌ |
Get the filename for the XMP meta data
public static function getXmpMetaDataFilename(): string;
Returns a value of type string
Set the filename for the XMP meta data
public static function setXmpMetaDataFilename(string $xmpMetaDataFilename): void;
Name | Type | Allows Null | Description |
---|---|---|---|
xmpMetaDataFilename | string | ❌ |
Returns a list of node paths which have a special number of decimal places
public static function getSpecialDecimalPlacesMaps(): array;
Returns a value of type array
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
public static function getSpecialDecimalPlacesMap(string $nodePath, int $defaultDecimalPlaces): int;
Name | Type | Allows Null | Description |
---|---|---|---|
nodePath | string | ❌ | |
defaultDecimalPlaces | int | ❌ |
Returns a value of type int
Update the map of node paths which have a special number of decimal places
public static function setSpecialDecimalPlacesMaps(array $specialDecimalPlacesMaps): void;
Name | Type | Allows Null | Description |
---|---|---|---|
specialDecimalPlacesMaps | array | ❌ |
Add a new map for a node path with a special number of decimal places
public static function addSpecialDecimalPlacesMap(string $nodePath, int $defaultDecimalPlaces): void;
Name | Type | Allows Null | Description |
---|---|---|---|
nodePath | string | ❌ | |
defaultDecimalPlaces | int | ❌ |
Set the number of decimals to use for unit single amount (unit prices) values
public static function setUnitAmountDecimals(int $amountDecimals): void;
Name | Type | Allows Null | Description |
---|---|---|---|
amountDecimals | int | ❌ |
Get root directory
public static function getRootDirectory(): string;
Returns a value of type string
Get the directory where all the sources are stored
public static function getSourceDirectory(): string;
Returns a value of type string
Get the directory where all the assets are stored
public static function getAssetDirectory(): string;
Returns a value of type string
Get the directory where all the assets are stored
public static function getYamlDirectory(): string;
Returns a value of type string
Get the directory where all the validation files are located
public static function getValidationDirectory(): string;
Returns a value of type string
Get the directory where all the schema (XSD) files are located
public static function getSchemaDirectory(): string;
Returns a value of type string
Get the full filename of the ICC profile to use
public static function getFullIccProfileFilename(): string;
Returns a value of type string
Get the full filename containg the XNP information to user
public static function getFullXmpMetaDataFilename(): string;
Returns a value of type string