Class cApiModule

Module item

cGenericDb

Item

cApiModule

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( mixed $mId = false )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$mId` `mixed` $mId [optional] Specifies the ID of item to load Throws `cDbException` `cException` Overrides `Item::__construct()`
`public string`	# `getTranslatedName( )` Returns the translated name of the module if a translation exists. Returns the translated name of the module if a translation exists. Returns `string` Translated module name or original Throws `cDbException` `cException`
`public`	# `setTranslatedName( string $name )` Sets the translated name of the module Sets the translated name of the module Parameters `$name` `string` $name Translated name of the module Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean\|array`	# `parseModuleForStringsLoadFromFile( array $cfg, integer $client, integer $lang )` This method get the input and output for translating from files and not from db-table. This method get the input and output for translating from files and not from db-table. Parameters `$cfg` `array` $cfg `$client` `integer` $client `$lang` `integer` $lang Returns `boolean\|array` Throws `cException`
`public array`	# `parseModuleForStrings( )` Parses the module for mi18n strings and returns them in an array Parses the module for mi18n strings and returns them in an array Returns `array` Found strings for this module Throws `cInvalidArgumentException`
`public boolean`	# `moduleInUse( integer $module, boolean $bSetData = false )` Checks if the module is in use Checks if the module is in use Parameters `$module` `integer` $module `$bSetData` `boolean` $bSetData [optional] Returns `boolean` true if the module is in use Throws `cDbException`
`public array`	# `getUsedTemplates( )` Get the informations of used templates Get the informations of used templates Returns `array` template data
`public boolean`	# `isOldModule( )` Checks if the module is a pre-4.3 module Checks if the module is a pre-4.3 module Returns `boolean` true if this module is an old one
`public mixed`	# `getField( string $field, boolean $bSafe = true )` Gets the value of a specific field. Gets the value of a specific field. Parameters `$field` `string` $field Specifies the field to retrieve `$bSafe` `boolean` $bSafe [optional] Flag to run defined outFilter on passed value Returns `mixed` Value of the field See `Item::getField()` Overrides `Item::getField()`
`public boolean`	# `store( boolean $bJustStore = false )` Stores the loaded and modified item to the database. Also generates the code for all articles using this module (if not suppressed by giving a true value for $bJustStore). Stores the loaded and modified item to the database. Also generates the code for all articles using this module (if not suppressed by giving a true value for $bJustStore). Parameters `$bJustStore` `boolean` $bJustStore [optional] don't generate code for all articles using this module (default false) Returns `boolean` Throws `cDbException` `cInvalidArgumentException` See `Item::store()` Overrides `Item::store()`
`private array`	# `_parseImportFile( string $sFile )` Parse import xml file and returns its values. Parse import xml file and returns its values. Parameters `$sFile` `string` $sFile Filename including path of import xml file Returns `array` Array with module data from XML file Throws `cException`
`private array`	# `_getModuleProperties( string $sFile )` Save the modul properties (description,type...) Save the modul properties (description,type...) Parameters `$sFile` `string` $sFile Where is the modul info.xml file Returns `array` Throws `cException`
`public boolean`	# `import( string $sFile, string $tempName, boolean $show_notification = true )` Imports the a module from a zip file, uses xmlparser and callbacks Imports the a module from a zip file, uses xmlparser and callbacks Parameters `$sFile` `string` $sFile Filename of data file (full path) `$tempName` `string` $tempName of archive `$show_notification` `boolean` $show_notification [optional] standard: true, mode to turn notifications off Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `importModuleFromXML( string $sFile )` Imports the a module from a XML file, uses xmlparser and callbacks Imports the a module from a XML file, uses xmlparser and callbacks Parameters `$sFile` `string` $sFile Filename of data file (full path) Returns `boolean` Throws `cException` `cInvalidArgumentException`
`private`	# `_addFolderToZip( string $dir, string $zipArchive, string $zipdir = '' )` Add recursive folder to zip archive Add recursive folder to zip archive Parameters `$dir` `string` $dir directory name `$zipArchive` `string` $zipArchive name of the archive `$zipdir` `string` $zipdir [optional]
`public`	# `export( )` Exports the specified module to a zip file Exports the specified module to a zip file
`public boolean`	# `setField( string $name, mixed $value, boolean $bSafe = true )` Userdefined setter for module fields. Userdefined setter for module fields. Parameters `$name` `string` $name `$value` `mixed` $value `$bSafe` `boolean` $bSafe [optional] Flag to run defined inFilter on passed value Returns `boolean` Overrides `Item::setField()`
`public static string`	# `processContainerInputCode( integer $containerNr, string $containerCfg, string $moduleInputCode )` Processes container placeholder (e.g. CMS_VAR[123], CMS_VALUE[123]) in given module input code. Tries to find the proper container tag and replaces its value against container configuration. Processes container placeholder (e.g. CMS_VAR[123], CMS_VALUE[123]) in given module input code. Tries to find the proper container tag and replaces its value against container configuration. Parameters `$containerNr` `integer` $containerNr The container number to process `$containerCfg` `string` $containerCfg Container configuration string containing key/values pairs for all containers `$moduleInputCode` `string` $moduleInputCode Returns `string`

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _resetItem(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getMetaObject(), getProperty(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), outFilter(), set(), setFilters(), setProperty(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _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 summary
`private string`	`$_translationPatternText`	`'/mi18n([\s])$"((\\\\"\|[^"]))"(([\s]),([\s])[^$,]+)*\)/'`	# for finding module translations in source code of module for finding module translations in source code of module
`private string`	`$_translationPatternBase`	`'/mi18n([\s])\(([\s])"/'`	# for finding basic module translations in source code of module for finding basic module translations in source code of module
`private string`	`$_translationReplacement`	`'mi18n("'`	# for replacing base module translations in source code of module for replacing base module translations in source code of module
`private string`	`$_translationPatternTemplate`	`'/\{\s"([^"]+)"\s\\|\smi18n\s\}/'`	# for finding module translations in source code of templates for finding module translations in source code of templates
`protected string`	`$_error`		# Todo check if this property is still required
`protected array`	`$_packageStructure`		# Assoziative package structure array Assoziative package structure array
`private array`	`$aUsedTemplates`	`array()`	#

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

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

`private string`	`$_translationPatternText`	`'/mi18n([\s])\("((\\\\"\|[^"]))"(([\s]),([\s])[^\),]+)*\)/'`	# for finding module translations in source code of module for finding module translations in source code of module
`private string`	`$_translationPatternBase`	`'/mi18n([\s])\(([\s])"/'`	# for finding basic module translations in source code of module for finding basic module translations in source code of module
`private string`	`$_translationReplacement`	`'mi18n("'`	# for replacing base module translations in source code of module for replacing base module translations in source code of module
`private string`	`$_translationPatternTemplate`	`'/\{\s"([^"]+)"\s\\|\smi18n\s\}/'`	# for finding module translations in source code of templates for finding module translations in source code of templates
`protected string`	`$_error`		# Todo check if this property is still required
`protected array`	`$_packageStructure`		# Assoziative package structure array Assoziative package structure array
`private array`	`$aUsedTemplates`	`array()`	#

Packages

Classes

Class cApiModule

Parameters

Throws

Overrides

Returns

Throws

Parameters

Throws

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

See

Overrides

Parameters

Returns

Throws

See

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Todo