Documentation

Parameter extends ParameterType
in package

Class representing Parameter.

Table of Contents

$formParameter  : array<string|int, mixed>|null
$id  : int|null
ID uživatelské agendy (jen pro export).
$idsAgenda  : string|null
Agenda, ve které bude možné volitelné parametry používat a dále s nimi pracovat.
$idsUserAgenda  : string|null
Krátký název uživatelské agendy.
$itemParameter  : array<string|int, mixed>|null
$userAgendaDef  : UserAgendaDefType|null
$userCode  : string|null
$userCodePart  : UserCodePartType|null
$userForm  : array<string|int, mixed>
$version  : string|null
Verze, které jsou dostupné k tomuto dokladu. Podrobnosti k jednotlivým verzím najdete na www.stormware.cz/xml.
addToFormParameter()  : self
Adds as parameterDef.
addToItemParameter()  : self
Adds as parameterDef.
addToUserForm()  : self
Adds as userForm.
getFormParameter()  : array<string|int, ParameterDefType>
Gets as formParameter.
getId()  : int
Gets as id.
getIdsAgenda()  : string
Gets as idsAgenda.
getIdsUserAgenda()  : string
Gets as idsUserAgenda.
getItemParameter()  : array<string|int, ParameterDefType>
Gets as itemParameter.
getUserAgendaDef()  : UserAgendaDefType
Gets as userAgendaDef.
getUserCode()  : string
Gets as userCode.
getUserCodePart()  : UserCodePartType
Gets as userCodePart.
getUserForm()  : array<string|int, FormItemListType>
Gets as userForm.
getVersion()  : string
Gets as version.
issetFormParameter()  : bool
isset formParameter.
issetItemParameter()  : bool
isset itemParameter.
issetUserForm()  : bool
isset userForm.
setFormParameter()  : self
Sets a new formParameter.
setId()  : self
Sets a new id.
setIdsAgenda()  : self
Sets a new idsAgenda.
setIdsUserAgenda()  : self
Sets a new idsUserAgenda.
setItemParameter()  : self
Sets a new itemParameter.
setUserAgendaDef()  : self
Sets a new userAgendaDef.
setUserCode()  : self
Sets a new userCode.
setUserCodePart()  : self
Sets a new userCodePart.
setUserForm()  : self
Sets a new userForm.
setVersion()  : self
Sets a new version.
unsetFormParameter()  : void
unset formParameter.
unsetItemParameter()  : void
unset itemParameter.
unsetUserForm()  : void
unset userForm.

Properties

$formParameter

private array<string|int, mixed>|null $formParameter = null

$id

ID uživatelské agendy (jen pro export).

private int|null $id = null

$idsAgenda

Agenda, ve které bude možné volitelné parametry používat a dále s nimi pracovat.

private string|null $idsAgenda = null

$idsUserAgenda

Krátký název uživatelské agendy.

private string|null $idsUserAgenda = null

$itemParameter

private array<string|int, mixed>|null $itemParameter = null

$version

Verze, které jsou dostupné k tomuto dokladu. Podrobnosti k jednotlivým verzím najdete na www.stormware.cz/xml.

private string|null $version = null

Methods

getId()

Gets as id.

public getId() : int

ID uživatelské agendy (jen pro export).

Return values
int

getIdsAgenda()

Gets as idsAgenda.

public getIdsAgenda() : string

Agenda, ve které bude možné volitelné parametry používat a dále s nimi pracovat.

Return values
string

getIdsUserAgenda()

Gets as idsUserAgenda.

public getIdsUserAgenda() : string

Krátký název uživatelské agendy.

Return values
string

getUserCode()

Gets as userCode.

public getUserCode() : string
Return values
string

getVersion()

Gets as version.

public getVersion() : string

Verze, které jsou dostupné k tomuto dokladu. Podrobnosti k jednotlivým verzím najdete na www.stormware.cz/xml

Return values
string

issetFormParameter()

isset formParameter.

public issetFormParameter(int|string $index) : bool
Parameters
$index : int|string
Return values
bool

issetItemParameter()

isset itemParameter.

public issetItemParameter(int|string $index) : bool
Parameters
$index : int|string
Return values
bool

issetUserForm()

isset userForm.

public issetUserForm(int|string $index) : bool
Parameters
$index : int|string
Return values
bool

setFormParameter()

Sets a new formParameter.

public setFormParameter([array<string|int, ParameterDefType$formParameter = null ]) : self
Parameters
$formParameter : array<string|int, ParameterDefType> = null
Return values
self

setId()

Sets a new id.

public setId(int $id) : self

ID uživatelské agendy (jen pro export).

Parameters
$id : int
Return values
self

setIdsAgenda()

Sets a new idsAgenda.

public setIdsAgenda(string $idsAgenda) : self

Agenda, ve které bude možné volitelné parametry používat a dále s nimi pracovat.

Parameters
$idsAgenda : string
Return values
self

setIdsUserAgenda()

Sets a new idsUserAgenda.

public setIdsUserAgenda(string $idsUserAgenda) : self

Krátký název uživatelské agendy.

Parameters
$idsUserAgenda : string
Return values
self

setItemParameter()

Sets a new itemParameter.

public setItemParameter([array<string|int, ParameterDefType$itemParameter = null ]) : self
Parameters
$itemParameter : array<string|int, ParameterDefType> = null
Return values
self

setUserCode()

Sets a new userCode.

public setUserCode(string $userCode) : self
Parameters
$userCode : string
Return values
self

setVersion()

Sets a new version.

public setVersion(string $version) : self

Verze, které jsou dostupné k tomuto dokladu. Podrobnosti k jednotlivým verzím najdete na www.stormware.cz/xml

Parameters
$version : string
Return values
self

unsetFormParameter()

unset formParameter.

public unsetFormParameter(int|string $index) : void
Parameters
$index : int|string
Return values
void

unsetItemParameter()

unset itemParameter.

public unsetItemParameter(int|string $index) : void
Parameters
$index : int|string
Return values
void

unsetUserForm()

unset userForm.

public unsetUserForm(int|string $index) : void
Parameters
$index : int|string
Return values
void

Search results