CSItemExporterData
in package
Use this class to provide data to CSItemExporter
Tags
Table of Contents
- generateUniqueId() : string
- Generates and stores an unique ID to the object.
- getAdditionalMetaValue() : mixed|bool
- Returns the value for the given identifier from the additional meta values.
- getAdditionalMetaValues() : array<string|int, mixed>
- Returns the complete additional values.
- getAdditionalValue() : mixed|bool
- Returns the value for the given identifier from the additional values.
- getAdditionalValues() : array<string|int, mixed>
- Returns the complete additional values.
- getExportOptions() : array<string|int, mixed>
- Gets the export options
- getExportPath() : string
- Gets the export path
- getId() : int
- Gets the ID of the type
- getItemExportFlag() : bool
- Gets the flag if this object may be exported
- getLanguageId() : int
- Gets the language ID.
- getMetaExportFlag() : bool
- Get the flag if this object may be export meta information
- getType() : string
- Gets the type of the object.
- getUniqueId() : string
- Gets the unique ID of the object.
- isLanguageDependent() : bool
- Checks if this object is language dependent.
- setAdditionalMetaValue() : void
- Sets an additional meta value to add a new column with the given value.
- setAdditionalValue() : void
- Sets an additional value to the current object.
- setExportOptions() : mixed
- Sets the export options
- setExportPath() : mixed
- Set the desired export path
- setId() : mixed
- Set the ID of the Type
- setItemExportFlag() : mixed
- Sets the flag if this object may be exported
- setLanguageId() : void
- Set the language ID.
- setMetaExportFlag() : mixed
- Sets the flag if this object may export meta information (e.g. CSV/XML)
- setType() : mixed
- Set the given record/item type
- setUniqueId() : void
- Set the unique ID of the object.
Methods
generateUniqueId()
Generates and stores an unique ID to the object.
public
generateUniqueId() : string
Tags
Return values
string —getAdditionalMetaValue()
Returns the value for the given identifier from the additional meta values.
public
getAdditionalMetaValue(string $sKey) : mixed|bool
Parameters
- $sKey : string
-
The identifier of the value to get.
Tags
Return values
mixed|bool —Returns FALSE if key is not set
getAdditionalMetaValues()
Returns the complete additional values.
public
getAdditionalMetaValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getAdditionalValue()
Returns the value for the given identifier from the additional values.
public
getAdditionalValue(string $sKey) : mixed|bool
Parameters
- $sKey : string
-
The identifier of the value to get.
Tags
Return values
mixed|bool —Returns FALSE if key is not set
getAdditionalValues()
Returns the complete additional values.
public
getAdditionalValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getExportOptions()
Gets the export options
public
getExportOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getExportPath()
Gets the export path
public
getExportPath() : string
Tags
Return values
string —getId()
Gets the ID of the type
public
getId() : int
Tags
Return values
int —getItemExportFlag()
Gets the flag if this object may be exported
public
getItemExportFlag() : bool
Tags
Return values
bool —getLanguageId()
Gets the language ID.
public
getLanguageId() : int
Tags
Return values
int —getMetaExportFlag()
Get the flag if this object may be export meta information
public
getMetaExportFlag() : bool
Tags
Return values
bool —getType()
Gets the type of the object.
public
getType() : string
Tags
Return values
string —Returns the type with the first character capitalized.
getUniqueId()
Gets the unique ID of the object.
public
getUniqueId() : string
Tags
Return values
string —isLanguageDependent()
Checks if this object is language dependent.
public
isLanguageDependent() : bool
Tags
Return values
bool —setAdditionalMetaValue()
Sets an additional meta value to add a new column with the given value.
public
setAdditionalMetaValue(string $sKey, string $sValue) : void
Parameters
- $sKey : string
-
The identifier of the value to set - will be the column name
- $sValue : string
-
The value to set
Tags
Return values
void —setAdditionalValue()
Sets an additional value to the current object.
public
setAdditionalValue(string $sKey, mixed $mValue) : void
Parameters
- $sKey : string
-
The identifier of the value to set.
- $mValue : mixed
-
The value to set.
Tags
Return values
void —setExportOptions()
Sets the export options
public
setExportOptions(mixed $aOptions) : mixed
Parameters
- $aOptions : mixed
Tags
Return values
mixed —setExportPath()
Set the desired export path
public
setExportPath(mixed $sPath) : mixed
Parameters
- $sPath : mixed
Tags
Return values
mixed —setId()
Set the ID of the Type
public
setId(mixed $iId) : mixed
Parameters
- $iId : mixed
Tags
Return values
mixed —setItemExportFlag()
Sets the flag if this object may be exported
public
setItemExportFlag(mixed $bItemExport) : mixed
Parameters
- $bItemExport : mixed
Tags
Return values
mixed —setLanguageId()
Set the language ID.
public
setLanguageId(int $iLanguageId) : void
Parameters
- $iLanguageId : int
Tags
Return values
void —setMetaExportFlag()
Sets the flag if this object may export meta information (e.g. CSV/XML)
public
setMetaExportFlag(bool $bMetaExport) : mixed
Parameters
- $bMetaExport : bool
Tags
Return values
mixed —setType()
Set the given record/item type
public
setType(mixed $sType) : mixed
Parameters
- $sType : mixed
Tags
Return values
mixed —setUniqueId()
Set the unique ID of the object.
public
setUniqueId(mixed $iId) : void
To generate a automatic ID use the generateUniqueId() method.
Parameters
- $iId : mixed