Class cApiModuleCollection

Module collection

cGenericDb

cApiModuleCollection

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Hummel
Located at classes/contenido/class.module.php

Methods summary
`public`	# `__construct( )` Constructor Function Constructor Function Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `ItemCollection::__construct()`
`public cApiModule`	# `create( string $name, integer $idclient = NULL, string $alias = '', string $type = '', string $error = 'none', string $description = '', integer $deletable = 0, string $template = '', integer $static = 0, string $package_guid = '', string $package_data = '', string $author = '', string $created = '', string $lastmodified = '' )` Creates a new module item Creates a new module item Parameters `$name` `string` $name `$idclient` `integer` $idclient [optional] `$alias` `string` $alias [optional] `$type` `string` $type [optional] `$error` `string` $error [optional] `$description` `string` $description [optional] `$deletable` `integer` $deletable [optional] `$template` `string` $template [optional] `$static` `integer` $static [optional] `$package_guid` `string` $package_guid [optional] `$package_data` `string` $package_data [optional] `$author` `string` $author [optional] `$created` `string` $created [optional] `$lastmodified` `string` $lastmodified [optional] Returns `cApiModule`
`public array`	# `getAllTypesByIdclient( integer $idclient )` Returns list of all types by client id Returns list of all types by client id Parameters `$idclient` `integer` $idclient Returns `array`
`public array`	# `getAllByIdclient( integer $idclient, string $oderBy = 'name' )` Returns a list of all modules used by the given client. By default the modules are ordered by name but can be ordered by any property. Returns a list of all modules used by the given client. By default the modules are ordered by name but can be ordered by any property. Parameters `$idclient` `integer` $idclient `$oderBy` `string` $oderBy [optional] Returns `array`
`public array`	# `getModulesInUse( )` Checks if any modules are in use and returns the data Checks if any modules are in use and returns the data Returns `array` Returns all templates for all modules

Methods inherited from ItemCollection
_buildGroupWhereStatements(), _buildWhereStatements(), _delete(), _deleteMultiple(), _fetchJoinTables(), _findReverseJoinPartner(), _initializeDriver(), _recursiveStructuredFetch(), _resolveLinks(), _setItemClass(), _setJoinPartner(), addResultField(), copyItem(), count(), createNewItem(), delete(), deleteBy(), deleteByWhereClause(), deleteWhere(), deleteWhereGroup(), exists(), fetchArray(), fetchById(), fetchObject(), fetchTable(), flexSelect(), getAllIds(), getFieldsByWhereClause(), getIdsByWhereClause(), link(), loadItem(), next(), query(), queryAndFetchStructured(), removeResultField(), resetQuery(), select(), setEncoding(), setGroupCondition(), setInnerGroupCondition(), setLimit(), setOrder(), setWhere(), setWhereGroup()

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _resetItem(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties inherited from ItemCollection
`$_JoinPartners, $_aOperators, $_bAllMode, $_collectionCache, $_driver, $_encoding, $_forwardJoinPartners, $_groupConditions, $_innerGroupConditions, $_itemClass, $_itemClassInstance, $_iteratorItem, $_lastSQL, $_limitCount, $_limitStart, $_links, $_order, $_resultFields, $_where, $_whereRestriction, $objects`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class cApiModuleCollection

Throws

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns