__construct()
_inFilter()
cApiModule()
deleteProperty()
deletePropertyById()
escape()
export()
exportPackage()
get()
getField()
getMetaObject()
getPackageOverview()
getProperty()
getTranslatedName()
getUsedTemplates()
import()
importPackage()
isLoaded()
isOldModule()
loadBy()
loadByPrimaryKey()
loadByRecordSet()
moduleInUse()
parseModuleForStrings()
set()
setField()
setFilters()
setProperty()
setTranslatedName()
store()
toArray()
toObject()
_getPropertiesCollectionInstance()
_getSecondDBInstance()
_loadByWhereClause()
_makeFileDirectoryStructure()
_onLoad()
_outFilter()
_setMetaObject()
_shouldLoadFromFiles()
_shouldStoreToFile()
_parseImportFile()
_setInputFromPhpFile()
_setOutputFromPhpFile()
$primaryKey
$values
$virgin
$_arrInFilters
$_arrOutFilters
$_className
$_error
$_metaObject
$_oCache
$_packageStructure
$_settings
$cache
$db
$lasterror
$lifetime
$modifiedValues
$oldPrimaryKey
$properties
$secondDb
$table
$aUsedTemplates
Module access class
Base class with common features for database based items and item collections.
| author | Timo A. Hummel <Timo.Hummel@4fb.de> |
|---|---|
| author | Murat Purc |
| version | 0.3 |
| copyright | four for business 2003 |
__construct(mixed $mId)
mixedSpecifies the ID of item to load
\Contenido_ItemException |
If table name or primary key is not set |
|---|
_inFilter(mixed $mData) : mixed
| see | \setFilters |
|---|---|
| inherited_from | \Item::_inFilter() |
mixedData to filter
mixedFiltered datacApiModule($mId)
| deprecated | [2011-03-15] Old constructor function for downwards compatibility |
|---|
deleteProperty(string $sType, string $sName) : bool
| inherited_from | \Item::deleteProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
booldeletePropertyById(int $idprop) : bool
| inherited_from | \Item::deletePropertyById() |
|---|
intId of property
boolescape(string $sString) : string
| inherited_from | \Contenido_ItemBaseAbstract::escape() |
|---|---|
| inherited_from | \Item::escape() |
stringThe string to escape
stringEscaped stringexport(\$filename $filename, \$return $return)
\$filenamestring Filename to return
\$returnboolean if false, the result is immediately sent to the browser
exportPackage(string $sPackageFileName, bool $bReturn)
stringFilename to return
boolif false, the result is immediately sent to the browser
get(string $sField) : mixed
| inherited_from | \Item::get() |
|---|
stringSpecifies the field to retrieve
mixedValue of the fieldgetField($field) : mixed
mixedValue of the fieldgetMetaObject()
| inherited_from | \Item::getMetaObject() |
|---|
getPackageOverview($sFile)
getProperty(string $sType, string $sName) : mixed
| inherited_from | \Item::getProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
mixedValue of the given property or falsegetTranslatedName() : string
stringTranslated module name or originalgetUsedTemplates() : array
arraytemplate dataimport($sFile)
importPackage(string $sFile, array $aOptions) : bool
stringFilename of data file (including path)
arrayOptional. 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"][
boolReturns true, if import has been successfully finishedisLoaded() : bool
| inherited_from | \Item::isLoaded() |
|---|
boolisOldModule() : boolean
booleantrue if this module is an old oneloadBy(string $sField, mixed $mValue, bool $bSafe) : bool
| inherited_from | \Item::loadBy() |
|---|
stringSpecifies the field
mixedSpecifies the value
boolUse inFilter or not
boolTrue if the load was successfulloadByPrimaryKey($id) : bool
boolTrue if the load was successfulloadByRecordSet(array $aRecordSet)
| inherited_from | \Item::loadByRecordSet() |
|---|
arrayThe recordset of the item
moduleInUse($module, $bSetData) : bool
boolSpecifies if the module is in useparseModuleForStrings() : array
arrayFound strings for this moduleset(string $sField, string $mValue, bool $bSafe)
| inherited_from | \Item::set() |
|---|
stringField name
stringValue to set
boolFlag to run defined inFilter on passed value
setField(string $sField, string $mValue, bool $bSafe)
| inherited_from | \Item::setField() |
|---|
stringField name
stringValue to set
boolFlag to run defined inFilter on passed value
setFilters(array $aInFilters, array $aOutFilters) : void
Examples:
$obj->setFilters(array('addslashes'), array('stripslashes'));
$obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));
| inherited_from | \Item::setFilters() |
|---|
arrayArray with function names
arrayArray with function names
setProperty(string $sType, string $sName, mixed $mValue) : bool
| inherited_from | \Item::setProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
mixedSpecifies the value
boolsetTranslatedName(\$name $name) : \none
\$namestring Translated name of the module
\nonestore($bJustStore) : bool
booltoArray() : array | false
| inherited_from | \Item::toArray() |
|---|
arrayfalse
_getPropertiesCollectionInstance() : \PropertyCollection
| inherited_from | \Contenido_ItemBaseAbstract::_getPropertiesCollectionInstance() |
|---|---|
| inherited_from | \Item::_getPropertiesCollectionInstance() |
_getSecondDBInstance() : \DB_Contenido
| inherited_from | \Contenido_ItemBaseAbstract::_getSecondDBInstance() |
|---|---|
| inherited_from | \Item::_getSecondDBInstance() |
_loadByWhereClause(string $sWhere) : bool
This function is expensive, since it executes allways a query to the database to retrieve the primary key, even if the record set is aleady cached. NOTE: Passed value has to be escaped before. This will not be done by this function.
| inherited_from | \Item::_loadByWhereClause() |
|---|
stringThe where clause like 'idart = 123 AND idlang = 1'
boolTrue if the load was successful_makeFileDirectoryStructure()
_onLoad() : void
Inherited classes should override this function if desired.
_outFilter(mixed $mData) : mixed
| see | \setFilters |
|---|---|
| inherited_from | \Item::_outFilter() |
mixedData to filter
mixedFiltered data_setMetaObject($sObjectName)
| inherited_from | \Item::_setMetaObject() |
|---|
_shouldLoadFromFiles()
_shouldStoreToFile()
_parseImportFile(string $sFile, string $sType, $sEncoding) : bool
stringFilename including path of import xml file
stringImport type, "module" or "package"
boolReturns true, if file has been parsed_setInputFromPhpFile()
_setOutputFromPhpFile()
$primaryKey : string
| inherited_from | \Contenido_ItemBaseAbstract::$$primaryKey |
|---|---|
| inherited_from | \Item::$$primaryKey |
$values : array
| inherited_from | \Item::$$values |
|---|
$virgin : bool
| inherited_from | \Contenido_ItemBaseAbstract::$$virgin |
|---|---|
| inherited_from | \Item::$$virgin |
$_arrInFilters : array
| inherited_from | \Item::$$_arrInFilters |
|---|
$_arrOutFilters : array
| inherited_from | \Item::$$_arrOutFilters |
|---|
$_className : string
| inherited_from | \Contenido_ItemBaseAbstract::$$_className |
|---|---|
| inherited_from | \Item::$$_className |
$_error
$_oCache : \Contenido_ItemCache
| inherited_from | \Contenido_ItemBaseAbstract::$$_oCache |
|---|---|
| inherited_from | \Item::$$_oCache |
$_packageStructure : array
$_settings : array
| inherited_from | \Contenido_ItemBaseAbstract::$$_settings |
|---|---|
| inherited_from | \Item::$$_settings |
$cache : array
| inherited_from | \Contenido_ItemBaseAbstract::$$cache |
|---|---|
| inherited_from | \Item::$$cache |
$db : \DB_Contenido
| inherited_from | \Contenido_ItemBaseAbstract::$$db |
|---|---|
| inherited_from | \Item::$$db |
$lasterror : string
| inherited_from | \Contenido_ItemBaseAbstract::$$lasterror |
|---|---|
| inherited_from | \Item::$$lasterror |
$lifetime : int
| inherited_from | \Contenido_ItemBaseAbstract::$$lifetime |
|---|---|
| inherited_from | \Item::$$lifetime |
$modifiedValues : array
| inherited_from | \Item::$$modifiedValues |
|---|
$oldPrimaryKey : string
| inherited_from | \Item::$$oldPrimaryKey |
|---|
$properties : \PropertyCollection
| inherited_from | \Contenido_ItemBaseAbstract::$$properties |
|---|---|
| inherited_from | \Item::$$properties |
$secondDb : \DB_Contenido
| inherited_from | \Contenido_ItemBaseAbstract::$$secondDb |
|---|---|
| inherited_from | \Item::$$secondDb |
$table : string
| inherited_from | \Contenido_ItemBaseAbstract::$$table |
|---|---|
| inherited_from | \Item::$$table |
$aUsedTemplates : array