Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • cApiAction
  • cApiActionCollection
  • cApiActionlog
  • cApiActionlogCollection
  • cApiArea
  • cApiAreaCollection
  • cApiArticle
  • cApiArticleCollection
  • cApiArticleLanguage
  • cApiArticleLanguageCollection
  • cApiArticleSpecification
  • cApiArticleSpecificationCollection
  • cApiCategory
  • cApiCategoryArticle
  • cApiCategoryArticleCollection
  • cApiCategoryCollection
  • cApiCategoryLanguage
  • cApiCategoryLanguageCollection
  • cApiCategoryTree
  • cApiCategoryTreeCollection
  • cApiClient
  • cApiClientCollection
  • cApiClientLanguage
  • cApiClientLanguageCollection
  • cApiCommunication
  • cApiCommunicationCollection
  • cApiContainer
  • cApiContainerCollection
  • cApiContainerConfiguration
  • cApiContainerConfigurationCollection
  • cApiContent
  • cApiContentCollection
  • cApiDbfs
  • cApiDbfsCollection
  • cApiFile
  • cApiFileCollection
  • cApiFileInformation
  • cApiFileInformationCollection
  • cApiFrameFile
  • cApiFrameFileCollection
  • cApiFrontendGroup
  • cApiFrontendGroupCollection
  • cApiFrontendGroupMember
  • cApiFrontendGroupMemberCollection
  • cApiFrontendPermission
  • cApiFrontendPermissionCollection
  • cApiFrontendUser
  • cApiFrontendUserCollection
  • cApiGroup
  • cApiGroupCollection
  • cApiGroupMember
  • cApiGroupMemberCollection
  • cApiGroupProperty
  • cApiGroupPropertyCollection
  • cApiInUse
  • cApiInUseCollection
  • cApiIso3166
  • cApiIso3166Collection
  • cApiIso6392
  • cApiIso6392Collection
  • cApiKeyword
  • cApiKeywordCollection
  • cApiLanguage
  • cApiLanguageCollection
  • cApiLayout
  • cApiLayoutCollection
  • cApiMailLog
  • cApiMailLogCollection
  • cApiMailLogSuccess
  • cApiMailLogSuccessCollection
  • cApiMetaTag
  • cApiMetaTagCollection
  • cApiMetaType
  • cApiMetaTypeCollection
  • cApiModule
  • cApiModuleCollection
  • cApiNavMain
  • cApiNavMainCollection
  • cApiNavSub
  • cApiNavSubCollection
  • cApiOnlineUser
  • cApiOnlineUserCollection
  • cApiPathresolveCache
  • cApiPathresolveCacheCollection
  • cApiProperty
  • cApiPropertyCollection
  • cApiRight
  • cApiRightCollection
  • cApiSearchTracking
  • cApiSearchTrackingCollection
  • cApiStat
  • cApiStatCollection
  • cApiSystemProperty
  • cApiSystemPropertyCollection
  • cApiTemplate
  • cApiTemplateCollection
  • cApiTemplateConfiguration
  • cApiTemplateConfigurationCollection
  • cApiType
  • cApiTypeCollection
  • cApiUpload
  • cApiUploadCollection
  • cApiUploadMeta
  • cApiUploadMetaCollection
  • cApiUser
  • cApiUserCollection
  • cApiUserPasswordRequest
  • cApiUserPasswordRequestCollection
  • cApiUserProperty
  • cApiUserPropertyCollection
  • NoteCollection
  • NoteItem
  • TODOCollection
  • TODOItem
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class cApiModule

Module item

cGenericDb
Extended by cItemBaseAbstract
Extended by Item
Extended by 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 Function

Constructor Function

Parameters

$mId
Specifies the ID of item to load

Throws

cInvalidArgumentException
If table name or primary key is not set

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
public
# setTranslatedName( string $name )

Sets the translated name of the module

Sets the translated name of the module

Parameters

$name
Translated name of the module
public boolean
# 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
$client
$lang

Returns

boolean
multitype:
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
public boolean
# moduleInUse( integer $module, boolean $bSetData = false )

Checks if the module is in use

Checks if the module is in use

Parameters

$module
$bSetData

Returns

boolean
true if the module is in use
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 )

Parameters

$field
$sField Specifies the field to retrieve
$bSafe
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 )

Parameters

$bJustStore

Returns

boolean

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
Filename including path of import xml file

Returns

array
Array with module data from XML file
private array
# _getModuleProperties( string $sFile )

Save the modul properties (description,type...)

Save the modul properties (description,type...)

Parameters

$sFile
Where is the modul info.xml file

Returns

array
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
Filename of data file (full path)
$tempName
of archive
$show_notification

standard: true, mode to turn notifications off

Returns

boolean
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
Filename of data file (full path)

Returns

boolean
private
# _addFolderToZip( string $dir, string $zipArchive, string $zipdir = '' )

Add recursive folder to zip archive

Add recursive folder to zip archive

Parameters

$dir
directory name
$zipArchive
name of the archive
$zipdir
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
$value
$bSafe
Flag to run defined inFilter on passed value

Returns

boolean

Todo

should return return value of overloaded method

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
The container number to process
$containerCfg
Container configuration string containing key/values pairs for all containers
$moduleInputCode

Returns

string
public static
# processContainerForOutput( $containerNr, $containerCfg, $moduleInputCode )
Methods inherited from Item
_inFilter(), _loadByWhereClause(), _onLoad(), _resetItem(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getMetaObject(), getProperty(), isLoaded(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), outFilter(), set(), setFilters(), setProperty(), toArray(), toObject()
Methods inherited from cItemBaseAbstract
_getPropertiesCollectionInstance(), _getSecondDBInstance(), escape()
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

for finding module translations in source code of module

for finding module translations in source code of module

# '/mi18n([\s]*)\("((\\\\"|[^"])*)"(([\s]*),([\s]*)[^\),]+)*\)/'
private string $_translationPatternBase

for finding basic module translations in source code of module

for finding basic module translations in source code of module

# '/mi18n([\s]*)\(([\s]*)"/'
private string $_translationReplacement

for replacing base module translations in source code of module

for replacing base module translations in source code of module

# 'mi18n("'
protected unknown_type $_error
#
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, $_oCache, $_settings, $db, $lasterror, $primaryKey, $properties, $secondDb, $table, $virgin
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen