Skip to content

Class XmlConverterUblToCii

HorstOeko edited this page Dec 21, 2024 · 2 revisions

Summary

Class representing the converter from UBL syntax to CII syntax

Methods

fromFile [static]

Summary

Factory: Load from XML file

Signature

public static function fromFile(string $filename): static
{
}

Parameters

Name Type Allows Null Description
filename string

Returns

Returns a value of type static

fromString [static]

Summary

Factory: Load from XML stream

Signature

public static function fromString(string $xmlData): static
{
}

Parameters

Name Type Allows Null Description
xmlData string

Returns

Returns a value of type static

loadFromXmlString

Summary

Load source from XML string

Signature

public function loadFromXmlString(string $source): static
{
}

Parameters

Name Type Allows Null Description
source string

Returns

Returns a value of type static

loadFromXmlFile

Summary

Load from XML file

Signature

public function loadFromXmlFile(string $filename): static
{
}

Parameters

Name Type Allows Null Description
filename string

Returns

Returns a value of type static

saveXmlString

Summary

Save converted XML to a string containing XML data

Signature

public function saveXmlString(): string
{
}

Returns

Returns a value of type string

saveXmlFile

Summary

Save converted XML to a file

Signature

public function saveXmlFile(string $filename): int|false
{
}

Parameters

Name Type Allows Null Description
filename string

Returns

Returns a value of type int|false

convert

Summary

Convert

Signature

public function convert(): static
{
}

Returns

Returns a value of type static

isSupportedProfile

Summary

Returns true if the profiles $profileToCheck is a supported profile

Signature

public function isSupportedProfile(string $profileToCheck): bool
{
}

Parameters

Name Type Allows Null Description
profileToCheck string

Returns

Returns a value of type bool

getForceDestinationProfile

Summary

Returns the profile code to force

Signature

public function getForceDestinationProfile(): string
{
}

Returns

Returns a value of type string

getForceDestinationProfileWithDefault

Summary

Returns the profile code to force. If no profile to force is given the
$default value will be returned

Signature

public function getForceDestinationProfileWithDefault(string $defaultProfile): string
{
}

Parameters

Name Type Allows Null Description
defaultProfile string

Returns

Returns a value of type string

setForceDestinationProfile

Summary

Set the profile to force in the destination (UBL) document

Signature

public function setForceDestinationProfile(string $forceDestinationProfile): static
{
}

Parameters

Name Type Allows Null Description
forceDestinationProfile string

Returns

Returns a value of type static

clearForceDestinationProfile

Summary

Unsert the profile to force in the destination (UBL) document

Signature

public function clearForceDestinationProfile(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileMinimum

Summary

Force the MINIMUM profile

Signature

public function setForceDestinationProfileMinimum(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileBasicWL

Summary

Force the BASICWL profile

Signature

public function setForceDestinationProfileBasicWL(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileBasic

Summary

Force the BASIC profile

Signature

public function setForceDestinationProfileBasic(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileEn16931

Summary

Force the COMFORT (EN16931) profile

Signature

public function setForceDestinationProfileEn16931(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileExtended

Summary

Force the EXTENDED profile

Signature

public function setForceDestinationProfileExtended(): static
{
}

Returns

Returns a value of type static

setForceDestinationProfileXRechnung30

Summary

Force the XRECHNUNG 3.0 profile

Signature

public function setForceDestinationProfileXRechnung30(): static
{
}

Returns

Returns a value of type static