CSPmsExport
in package
Defines an PIM Export
Tags
Table of Contents
- __call() : mixed
- forwards function calls to the PdmExport object
- __construct() : CSPmsExport
- Creates a new CSPmsExport Object
- delete() : mixed
- deletes the export return void
- getValue() : value
- Returns any parameters value of the export as it can be find in the database
- run() : filepath
- Runs the export and fullfills any side effects as in the GUI
- setValue() : void
- Overwrites any parameter of the export as it can be find in the database
- store() : void
- Permanently stores a changed export back to the database
Methods
__call()
forwards function calls to the PdmExport object
public
__call(mixed $methodName, mixed $methodParams) : mixed
Parameters
- $methodName : mixed
- $methodParams : mixed
Tags
Return values
mixed —__construct()
Creates a new CSPmsExport Object
public
__construct(int $ID) : CSPmsExport
Parameters
- $ID : int
-
ID of the targeted export
Tags
Return values
CSPmsExport —delete()
deletes the export return void
public
delete() : mixed
Tags
Return values
mixed —getValue()
Returns any parameters value of the export as it can be find in the database
public
getValue(string $name) : value
Parameters
- $name : string
-
name of the param
Tags
Return values
value —of the param
run()
Runs the export and fullfills any side effects as in the GUI
public
run() : filepath
Tags
Return values
filepath —of the exported file as defined in the export settings
setValue()
Overwrites any parameter of the export as it can be find in the database
public
setValue(string $name, string $value) : void
Parameters
- $name : string
-
name of the param
- $value : string
-
new value of the param
Tags
Return values
void —store()
Permanently stores a changed export back to the database
public
store() : void