DataPack
extends DataPackType
in package
Class representing DataPack.
Table of Contents
- $application : string|null
- Textový popis, hodnota se zobrazí v poli "Aplikace" v agendě XML Import.
- $dataPackItem : array<string|int, mixed>
- $ico : string|null
- IČ firmy, pro kterou je XML určeno. Hodnota musí souhlasit s IČ zadané firmy. Má vyšší prioritu než atribut "key".
- $id : string|null
- ID dokladu, podle této hodnoty a hodnoty "id" v "dataPackItem" se kontrolují duplicity importovaných dokladů.
- $key : string|null
- Jedinečný identifikátor účetnictví firmy, pro kterou je XML určeno. Pokud není uveden atribut "ico" (nebo je prázdný), hodnota musí souhlasit s "klíčem" zadané firmy.
- $note : string|null
- Textová poznámka, hodnota se zobrazí v záložce "Poznámky" v agendě XML Import.
- $period : string|null
- Hodnota účetního období vybrané účetní jednotky v programu Pohoda. Pokud nebude atribut použit, bude XML import dat proveden do aktuálně nastavené účetního období přihlášeného uživatele. Pokud bude atribut uveden, bude při importu dat proveden kontrola nastaveného účetního období. Jestliže nebude období shodné, XML komunikace bude ukončena.
- $programVersion : string|null
- $transformation : TransformationType|null
- Transformace vstupu a výstupu (od verze "1.1" elementu "dataPack").
- $version : string|null
- addToDataPackItem() : self
- Adds as dataPackItem.
- getApplication() : string
- Gets as application.
- getDataPackItem() : array<string|int, DataPackItemType>
- Gets as dataPackItem.
- getIco() : string
- Gets as ico.
- getId() : string
- Gets as id.
- getKey() : string
- Gets as key.
- getNote() : string
- Gets as note.
- getPeriod() : string
- Gets as period.
- getProgramVersion() : string
- Gets as programVersion.
- getTransformation() : TransformationType
- Gets as transformation.
- getVersion() : string
- Gets as version.
- issetDataPackItem() : bool
- isset dataPackItem.
- setApplication() : self
- Sets a new application.
- setDataPackItem() : self
- Sets a new dataPackItem.
- setIco() : self
- Sets a new ico.
- setId() : self
- Sets a new id.
- setKey() : self
- Sets a new key.
- setNote() : self
- Sets a new note.
- setPeriod() : self
- Sets a new period.
- setProgramVersion() : self
- Sets a new programVersion.
- setTransformation() : self
- Sets a new transformation.
- setVersion() : self
- Sets a new version.
- unsetDataPackItem() : void
- unset dataPackItem.
Properties
$application
Textový popis, hodnota se zobrazí v poli "Aplikace" v agendě XML Import.
private
string|null
$application
= null
$dataPackItem
private
array<string|int, mixed>
$dataPackItem
= []
$ico
IČ firmy, pro kterou je XML určeno. Hodnota musí souhlasit s IČ zadané firmy. Má vyšší prioritu než atribut "key".
private
string|null
$ico
= null
$id
ID dokladu, podle této hodnoty a hodnoty "id" v "dataPackItem" se kontrolují duplicity importovaných dokladů.
private
string|null
$id
= null
$key
Jedinečný identifikátor účetnictví firmy, pro kterou je XML určeno. Pokud není uveden atribut "ico" (nebo je prázdný), hodnota musí souhlasit s "klíčem" zadané firmy.
private
string|null
$key
= null
$note
Textová poznámka, hodnota se zobrazí v záložce "Poznámky" v agendě XML Import.
private
string|null
$note
= null
$period
Hodnota účetního období vybrané účetní jednotky v programu Pohoda. Pokud nebude atribut použit, bude XML import dat proveden do aktuálně nastavené účetního období přihlášeného uživatele. Pokud bude atribut uveden, bude při importu dat proveden kontrola nastaveného účetního období. Jestliže nebude období shodné, XML komunikace bude ukončena.
private
string|null
$period
= null
$programVersion
private
string|null
$programVersion
= null
$transformation
Transformace vstupu a výstupu (od verze "1.1" elementu "dataPack").
private
TransformationType|null
$transformation
= null
Transformaci pro všechny zpracovávané soubory lze nastavit v INI souboru. Nejdříve se provede transformace zadané v INI souboru, poté transformace zadaná v XML.
$version
private
string|null
$version
= null
Methods
addToDataPackItem()
Adds as dataPackItem.
public
addToDataPackItem(DataPackItemType $dataPackItem) : self
Parameters
- $dataPackItem : DataPackItemType
Return values
self —getApplication()
Gets as application.
public
getApplication() : string
Textový popis, hodnota se zobrazí v poli "Aplikace" v agendě XML Import.
Return values
string —getDataPackItem()
Gets as dataPackItem.
public
getDataPackItem() : array<string|int, DataPackItemType>
Return values
array<string|int, DataPackItemType> —getIco()
Gets as ico.
public
getIco() : string
IČ firmy, pro kterou je XML určeno. Hodnota musí souhlasit s IČ zadané firmy. Má vyšší prioritu než atribut "key".
Return values
string —getId()
Gets as id.
public
getId() : string
ID dokladu, podle této hodnoty a hodnoty "id" v "dataPackItem" se kontrolují duplicity importovaných dokladů.
Return values
string —getKey()
Gets as key.
public
getKey() : string
Jedinečný identifikátor účetnictví firmy, pro kterou je XML určeno. Pokud není uveden atribut "ico" (nebo je prázdný), hodnota musí souhlasit s "klíčem" zadané firmy.
Return values
string —getNote()
Gets as note.
public
getNote() : string
Textová poznámka, hodnota se zobrazí v záložce "Poznámky" v agendě XML Import.
Return values
string —getPeriod()
Gets as period.
public
getPeriod() : string
Hodnota účetního období vybrané účetní jednotky v programu Pohoda. Pokud nebude atribut použit, bude XML import dat proveden do aktuálně nastavené účetního období přihlášeného uživatele. Pokud bude atribut uveden, bude při importu dat proveden kontrola nastaveného účetního období. Jestliže nebude období shodné, XML komunikace bude ukončena.
Return values
string —getProgramVersion()
Gets as programVersion.
public
getProgramVersion() : string
Return values
string —getTransformation()
Gets as transformation.
public
getTransformation() : TransformationType
Transformace vstupu a výstupu (od verze "1.1" elementu "dataPack"). Transformaci pro všechny zpracovávané soubory lze nastavit v INI souboru. Nejdříve se provede transformace zadané v INI souboru, poté transformace zadaná v XML.
Return values
TransformationType —getVersion()
Gets as version.
public
getVersion() : string
Return values
string —issetDataPackItem()
isset dataPackItem.
public
issetDataPackItem(int|string $index) : bool
Parameters
- $index : int|string
Return values
bool —setApplication()
Sets a new application.
public
setApplication(string $application) : self
Textový popis, hodnota se zobrazí v poli "Aplikace" v agendě XML Import.
Parameters
- $application : string
Return values
self —setDataPackItem()
Sets a new dataPackItem.
public
setDataPackItem(array<string|int, DataPackItemType> $dataPackItem) : self
Parameters
- $dataPackItem : array<string|int, DataPackItemType>
Return values
self —setIco()
Sets a new ico.
public
setIco(string $ico) : self
IČ firmy, pro kterou je XML určeno. Hodnota musí souhlasit s IČ zadané firmy. Má vyšší prioritu než atribut "key".
Parameters
- $ico : string
Return values
self —setId()
Sets a new id.
public
setId(string $id) : self
ID dokladu, podle této hodnoty a hodnoty "id" v "dataPackItem" se kontrolují duplicity importovaných dokladů.
Parameters
- $id : string
Return values
self —setKey()
Sets a new key.
public
setKey(string $key) : self
Jedinečný identifikátor účetnictví firmy, pro kterou je XML určeno. Pokud není uveden atribut "ico" (nebo je prázdný), hodnota musí souhlasit s "klíčem" zadané firmy.
Parameters
- $key : string
Return values
self —setNote()
Sets a new note.
public
setNote(string $note) : self
Textová poznámka, hodnota se zobrazí v záložce "Poznámky" v agendě XML Import.
Parameters
- $note : string
Return values
self —setPeriod()
Sets a new period.
public
setPeriod(string $period) : self
Hodnota účetního období vybrané účetní jednotky v programu Pohoda. Pokud nebude atribut použit, bude XML import dat proveden do aktuálně nastavené účetního období přihlášeného uživatele. Pokud bude atribut uveden, bude při importu dat proveden kontrola nastaveného účetního období. Jestliže nebude období shodné, XML komunikace bude ukončena.
Parameters
- $period : string
Return values
self —setProgramVersion()
Sets a new programVersion.
public
setProgramVersion(string $programVersion) : self
Parameters
- $programVersion : string
Return values
self —setTransformation()
Sets a new transformation.
public
setTransformation([TransformationType|null $transformation = null ]) : self
Transformace vstupu a výstupu (od verze "1.1" elementu "dataPack"). Transformaci pro všechny zpracovávané soubory lze nastavit v INI souboru. Nejdříve se provede transformace zadané v INI souboru, poté transformace zadaná v XML.
Parameters
- $transformation : TransformationType|null = null
Return values
self —setVersion()
Sets a new version.
public
setVersion(string $version) : self
Parameters
- $version : string
Return values
self —unsetDataPackItem()
unset dataPackItem.
public
unsetDataPackItem(int|string $index) : void
Parameters
- $index : int|string