Module access class
author | Timo A. Hummel <Timo.Hummel@4fb.de> |
---|---|
version | 0.1 |
copyright | four for business 2003 |
Item(string $table, string $primaryKey, $lifetime)
inherited_from | \Item::Item() |
---|
string
The table to use as information source
string
The primary key to use
_inFilter(mixed $data) : mixed
see | \setFilters |
---|---|
access | private |
inherited_from | \Item::_inFilter() |
mixed
Data to filter
mixed
Filtered data_makeFileDirectoryStructure()
_onLoad() : \none
Function which is called whenever an item is loaded. Inherited classes should override this function if desired.
inherited_from | \Item::_onLoad() |
---|
\none
_outFilter(mixed $data) : mixed
see | \setFilters |
---|---|
access | private |
inherited_from | \Item::_outFilter() |
mixed
Data to filter
mixed
Filtered data_parseImportFile(string $sFile, $sType, $sEncoding)
@access private
string
Filename including path of import xml file @param string $sType Import type, "module" or "package" @return bool Returns true, if file has been parsed
_setMetaObject($objectname)
inherited_from | \Item::_setMetaObject() |
---|
_shouldLoadFromFiles()
_shouldStoreToFile()
cApiModule($loaditem)
Item to load
deleteProperty(string $type, string $name)
inherited_from | \Item::deleteProperty() |
---|
string
Specifies the type
string
Specifies the name
export($filename, $return)
string Filename to return
boolean if false, the result is immediately sent to the browser
exportPackage(string $sPackageFileName, bool $bReturn)
string
Filename to return
bool
if false, the result is immediately sent to the browser
get(string $field) : mixed
inherited_from | \Item::get() |
---|
string
Specifies the field to retrieve
mixed
Value of the fieldgetField(string $field) : mixed
string
Specifies the field to retrieve
mixed
Value of the fieldgetMetaObject()
inherited_from | \Item::getMetaObject() |
---|
getPackageOverview($sFile)
getProperty(string $type, string $name) : boolean
inherited_from | \Item::getProperty() |
---|
string
Specifies the type
string
Specifies the name
boolean
Value of the given propertygetTranslatedName() : string
string
Translated module name or originalgetUsedTemplates() : array
array
template dataimport($sFile)
importPackage(string $sFile, array $aOptions) : bool
string
Filename of data file (including path)
array
Optional. An array of arrays specifying, how the items
of the xml file will be imported. If specified, has to
contain an array of this structure:
$aOptions["items"][
bool
Returns true, if import has been successfully finishedisOldModule() : boolean
boolean
true if this module is an old oneloadBy(string $field, string $value, bool $bSafe) : bool
inherited_from | \Item::loadBy() |
---|
string
Specifies the field
string
Specifies the value
bool
use inFilter or not
bool
True if the load was successfulloadByPrimaryKey($id) : bool
bool
True if the load was successfulmoduleInUse($module, $bSetData) : bool
bool
Specifies if the module is in useparseModuleForStrings() : array
array
Found strings for this moduleset(string $field, string $value, $safe)
inherited_from | \Item::set() |
---|
string
Specifies the field to set
string
Specifies the value to set
setField(string $field, string $value, boolean $safe)
inherited_from | \Item::setField() |
---|
string
Specifies the field to set
string
Specifies the value to set
boolean
Speficies if we should translate characters
setFilters(array $arrInFilters, array $arrOutFilters) : void
Examples:
$obj->setFilters(array('addslashes'), array('stripslashes')); $obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));
inherited_from | \Item::setFilters() |
---|
array
inFilters array with function names
array
outFilters array with function names
setProperty(string $type, string $name, string $value)
inherited_from | \Item::setProperty() |
---|
string
Specifies the type
string
Specifies the name
string
Specifies the value
setTranslatedName($name) : \none
string Translated name of the module
\none
store($bJustStore)
$_arrInFilters : array
access | private |
---|---|
inherited_from | \Item::$$_arrInFilters |
$_arrOutFilters : array
access | private |
---|---|
inherited_from | \Item::$$_arrOutFilters |
$_error
$_packageStructure
$cache : array
access | private |
---|---|
inherited_from | \Item::$$cache |
$db : object
access | private |
---|---|
inherited_from | \Item::$$db |
$lasterror : string
access | private |
---|---|
inherited_from | \Item::$$lasterror |
$lifetime : int
access | private |
---|---|
inherited_from | \Item::$$lifetime |
$modifiedValues : array
access | private |
---|---|
inherited_from | \Item::$$modifiedValues |
$oldPrimaryKey : string
access | private |
---|---|
inherited_from | \Item::$$oldPrimaryKey |
$primaryKey : object
access | private |
---|---|
inherited_from | \Item::$$primaryKey |
$properties : object
access | private |
---|---|
inherited_from | \Item::$$properties |
$table : string
access | private |
---|---|
inherited_from | \Item::$$table |
$values : array
access | private |
---|---|
inherited_from | \Item::$$values |
$virgin : boolean
If true, the object is virgin and no operations on it except load-Functions are allowed.
access | private |
---|---|
inherited_from | \Item::$$virgin |
$aUsedTemplates : array