classname
stringlengths 2
79
⌀ | method_name
stringlengths 3
5.05k
| description
stringlengths 6
3.95k
| method_code
stringlengths 7
8.51k
⌀ | explanation
stringclasses 1
value |
|---|---|---|---|---|
DatabaseAccessLayerCmsMasterPagedefSpotParameter | getParameterForSpot | * @var bool | $this->loadAllParameters();
return $this->getFromCache($spotId); | - |
DatabaseAccessLayerCmsMedia | loadMediaFromId | * @var bool | $this->loadAllParameters();
$media = $this->getFromCache($mediaId);
if (null !== $media) {
return $media; | - |
DatabaseAccessLayerCmsTPlModule | loadFromClassOrServiceId | * @var bool | $this->loadAllModules();
$keyMappingData = array('classname' => $classOrId);
$mappedKey = $this->getMapLookupKey($keyMappingData);
$data = $this->getFromCacheViaMappedKey($mappedKey);
if (null !== $data) {
return $data; | - |
DatabaseAccessLayerCmsTPlModule | loadFromId | * @param string $classOrId
*
* @return \TdbCmsTplModule|null | $this->loadAllModules();
return $this->getFromCache($id); | - |
DatabaseAccessLayerCmsTPlModule | loadFromField | * @param string $id
*
* @return \TdbCmsTplModule|null | $this->loadAllModules();
$matches = $this->findDbObjectFromFieldInCache($field, $value);
if (0 === count($matches)) {
return null; | - |
DatabaseAccessLayerCmsTplPage | __construct | * @deprecated since 6.1.0 use methods in chameleon_system_core.page_service instead | $this->portalDomainService = $portalDomainService; | - |
DatabaseAccessLayerCmsTplPage | loadFromId | * @var bool | $this->loadAllPages();
return $this->getFromCache($id); | - |
DatabaseAccessLayerCmsTplPage | loadForTreeId | * @var PortalDomainServiceInterface | $this->loadAllPages();
$cacheKeyData = array('cms_tree.id' => $treeId);
$mappedKey = $this->getMapLookupKey($cacheKeyData);
if (null !== $mappedKey) {
$page = $this->getFromCacheViaMappedKey($mappedKey);
if (null !== $page) {
return $page; | - |
DatabaseAccessLayerCmsTree | __construct | * @deprecated since 6.1.0 use methods in chameleon_system_core.tree_service instead | $this->portalDomainService = $portalDomainService;
$this->languageService = $languageService; | - |
DatabaseAccessLayerCmsTree | loadFromId | * @var bool | $this->loadAllTreeNodes();
return $this->getFromObjectCache($id, $languageId); | - |
DatabaseAccessLayerCmsTree | getChildren | * @var PortalDomainServiceInterface | $this->loadAllTreeNodes();
/** @var \TdbCmsTree[] $matches */
$matches = $this->findDbObjectFromFieldInCache('parent_id', $id, $languageId);
/**
* @psalm-suppress InvalidArgument
* @FIXME returning `null` from a sorting method is not allowed, should probably return `0`.
*/
usort($matches, function (\TdbCmsTree $a, \TdbCmsTree $b) {
if ($a->fieldEntrySort === $b->fieldEntrySort) {
return null; | - |
DatabaseAccessLayerFieldConfig | getFieldConfig | * @var TCMSField[][] | $fieldObject = null;
if (!isset($this->cache[$tableName])) {
$this->cache[$tableName] = array(); | - |
DatabaseAccessLayerFieldConfig | GetFieldDefinition | * @param string $tableName
* @param string $fieldName
* @param TCMSRecord $dataRow
* @param bool $loadDefaults
*
* @return TCMSField | $query = 'SELECT `cms_field_conf`.*
FROM `cms_field_conf`
INNER JOIN `cms_tbl_conf` ON `cms_field_conf`.`cms_tbl_conf_id` = `cms_tbl_conf`.`id`
WHERE `cms_field_conf`.`name`= :fieldName
AND `cms_tbl_conf`.`name` = :tableName';
$oFieldDefinition = null;
$row = $this->getDatabaseConnection()->fetchAssociative($query, array('fieldName' => $fieldName, 'tableName' => $tableName));
if (false !== $row) {
$oFieldDefinition = TdbCmsFieldConf::GetNewInstance($row); | - |
DatabaseAccessLayerFieldTypes | getFieldType | * @var bool | $this->loadAll();
return $this->getFromCache($id); | - |
DatabaseAccessLayerFileTypes | getFileType | * @var \TdbCmsFiletype[] | if (isset($this->cache[$id])) {
return $this->cache[$id]; | - |
BackendTreeNodeDataModel | __construct | * @var string | $this->id = $id;
$this->name = $name;
$this->cmsIdent = $cmsIdent;
$this->listAttributes = ['cmsIdent' => $cmsIdent];
$this->connectedPageId = $connectedPageId; | - |
BackendTreeNodeDataModel | getId: string | * @var string | return $this->id; | - |
BackendTreeNodeDataModel | getName: string | * @var string | return $this->name; | - |
BackendTreeNodeDataModel | setName: void | * @var int | $this->name = $name; | - |
BackendTreeNodeDataModel | getFurtherIconsHTML: string | * @var BackendTreeNodeDataModel[] | return $this->furtherIconsHTML; | - |
BackendTreeNodeDataModel | setFurtherIconsHTML: void | * @var bool | $this->furtherIconsHTML = $furtherIconsHTML; | - |
BackendTreeNodeDataModel | addFurtherIconHTML: void | * @var string | $this->furtherIconsHTML .= $furtherIconHTML; | - |
BackendTreeNodeDataModel | getCmsIdent: int | * @var bool | return $this->cmsIdent; | - |
BackendTreeNodeDataModel | getChildren: array | * @var bool | return $this->children; | - |
BackendTreeNodeDataModel | addChildren: void | * @var bool | $this->children[] = $treeNodeDataModel; | - |
BackendTreeNodeDataModel | isChildrenAjaxLoad: bool | * Key = HTML attribute name.
*
* @var array | return $this->childrenAjaxLoad; | - |
BackendTreeNodeDataModel | setChildrenAjaxLoad: void | * Key = HTML attribute name.
*
* @var array | $this->childrenAjaxLoad = $childrenAjaxLoad; | - |
BackendTreeNodeDataModel | getType: string | * @var array | return $this->type; | - |
BackendTreeNodeDataModel | setType: void | * @var array | $this->type = $type; | - |
BackendTreeNodeDataModel | isSelected: bool | * @var string | return $this->selected; | - |
BackendTreeNodeDataModel | setSelected: void | * @return BackendTreeNodeDataModel[] | $this->selected = $selected; | - |
BackendTreeNodeDataModel | isDisabled: bool | * @param BackendTreeNodeDataModel $children | return $this->disabled; | - |
BackendTreeNodeDataModel | setDisabled: void | * {@inheritDoc} | $this->disabled = $disabled; | - |
CmsMasterPagdef | __construct | * @var string | $this->id = $id;
$this->moduleList = $moduleList;
$this->layoutFile = $layoutFile; | - |
CmsMasterPagdef | getId: string | * @var array | return $this->id; | - |
CmsMasterPagdef | getModuleList: array | * @var string | return $this->moduleList; | - |
DownloadLinkDataModel | __construct(
string $id,
string $downloadUrl,
string $fileName) | * @var string|null | $this->id = $id;
$this->downloadUrl = $downloadUrl;
$this->fileName = $fileName; | - |
DownloadLinkDataModel | getId: ?string | * @var string | return $this->id; | - |
DownloadLinkDataModel | getHumanReadableFileSize: string | * Add internal attribute for wysiwyg editor integration and disable download url.
*
* @var bool | return $this->humanReadableFileSize; | - |
DownloadLinkDataModel | setHumanReadableFileSize: void | * @var string | $this->humanReadableFileSize = $humanReadableFileSize; | - |
DownloadLinkDataModel | isBackendLink: bool | * @var bool | return $this->isBackendLink; | - |
DownloadLinkDataModel | setIsBackendLink: void | * @var string | $this->isBackendLink = $isBackendLink; | - |
DownloadLinkDataModel | getFileName: string | * @var string | return $this->fileName; | - |
DownloadLinkDataModel | setFileName: void | * @var string | $this->fileName = $fileName; | - |
DownloadLinkDataModel | showSize: bool | * @var bool | return $this->showSize; | - |
PagePath | __construct | * @var string | $this->pageId = $pageId;
$this->primaryPath = $primaryPath;
$this->pathList[] = $primaryPath; | - |
PagePath | addPath | * @var string | $this->pathList[] = $path; | - |
PagePath | getPageId | * @var string[] | return $this->pageId; | - |
PagePath | getPrimaryPath | * @param string $pageId
* @param string $primaryPath | return $this->primaryPath; | - |
PagePath | getPathList | * @param string $path
*
* @return void | return $this->pathList; | - |
ChameleonSystemCoreExtension | load | * {@inheritDoc}
*
* @return void | $config = $this->processConfiguration(new Configuration(), $config);
// get standard configs
$aConfigDirs = array(
PATH_CORE_CONFIG,
_CMS_CUSTOM_CORE.'/config/',
_CMS_CUSTOMER_CORE.'/../config/',
);
foreach ($aConfigDirs as $sConfigDir) {
$this->loadConfigFile($container, $sConfigDir, 'services.xml');
$this->loadConfigFile($container, $sConfigDir, 'mail.xml');
$this->loadConfigFile($container, $sConfigDir, 'data_access.xml');
$this->loadConfigFile($container, $sConfigDir, 'urlnormalization.xml');
$this->loadConfigFile($container, $sConfigDir, 'universal_uploader.xml');
$this->loadConfigFile($container, $sConfigDir, 'database_migration.xml');
$this->loadConfigFile($container, $sConfigDir, 'cronjobs.xml');
$this->loadConfigFile($container, $sConfigDir, 'mappers.xml');
$this->loadConfigFile($container, $sConfigDir, 'factory.xml'); | - |
ChameleonSystemCoreExtension | prepend | * @param array $googleApiConfig
* @param ContainerBuilder $container
*
* @return void | // Fix for BC break in PDO. See https://www.php.net/manual/en/migration81.incompatible.php#migration81.incompatible.pdo.mysql
// Proposed solution: https://github.com/doctrine/dbal/issues/5228
$container->prependExtensionConfig('doctrine', [
'dbal' => [
'options' => [
\PDO::ATTR_STRINGIFY_FETCHES => true,
]
]
]); | - |
Configuration | getConfigTreeBuilder | * Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder | $treeBuilder = new TreeBuilder('chameleon_system_core');
$root = $treeBuilder->getRootNode();
$root->isRequired();
$root
->children()
->scalarNode('vendor_dir')->end()
->scalarNode('redirectstrategy')
->defaultValue('registershutdown')
->end()
->scalarNode('query_modifier_order_by_class')->end()
->arrayNode('pdo')
->children()
->scalarNode('mysql_attr_init_command')->end()
->end()
->end()
->append($this->getCronjobConfig())
->append($this->getMailTargetTransformationServiceConfig())
->append($this->getMailerConfig())
->append($this->getGoogleMapsApiConfig())
->append($this->getBackendConfig())
->append($this->getModuleExecutionConfig())
->append($this->getResourceCollectionConfig())
;
return $treeBuilder; | - |
AddBackendMainMenuItemProvidersPass | process | * {@inheritDoc}
*
* @return void | $sidebarMenuItemFactoryDefinition = $container->getDefinition('chameleon_system_core.bridge.chameleon.module.sidebar.menu_item_factory');
$menuItemProviderServiceIds = $container->findTaggedServiceIds('chameleon_system.backend_menu_item_provider');
foreach ($menuItemProviderServiceIds as $menuItemProviderServiceId => $tags) {
$databaseClass = null;
foreach ($tags as $tag) {
if (true === \array_key_exists('databaseclass', $tag)) {
$databaseClass = $tag['databaseclass']; | - |
AddCronJobsPass | process | * {@inheritDoc}
*
* @return void | $cronJobFactoryDefinition = $container->getDefinition('chameleon_system_core.cronjob.cronjob_factory');
$cronJobServiceIds = array_keys($container->findTaggedServiceIds('chameleon_system.cronjob'));
$services = [];
foreach ($cronJobServiceIds as $cronJobServiceId) {
$cronJobDefinition = $container->getDefinition($cronJobServiceId);
if ($cronJobDefinition->isShared()) {
throw new \LogicException('Chameleon cron jobs must not be shared service instances. This cron job is shared: '.$cronJobServiceId); | - |
AddMappersPass | process | * {@inheritdoc}
*
* @return void | $mapperServiceIds = $container->findTaggedServiceIds('chameleon_system.mapper');
$services = [];
foreach (\array_keys($mapperServiceIds) as $mapperId) {
$mapperDefinition = $container->getDefinition($mapperId);
if (false === \is_subclass_of($mapperDefinition->getClass(), IViewMapper::class)) {
throw new \LogicException('Chameleon mappers must implement IViewMapper. This one doesn\'t: '.$mapperId); | - |
AddUrlNormalizersPass | process | * {@inheritDoc}
*
* @return void | $utilServiceDefinition = $container->getDefinition('chameleon_system_core.util.url_normalization');
$urlNormalizerServices = $container->findTaggedServiceIds('chameleon_system.url_normalizer');
$urlNormalizerList = array();
foreach ($urlNormalizerServices as $urlNormalizerServiceId => $tags) {
$urlNormalizerDefinition = $container->getDefinition($urlNormalizerServiceId);
foreach ($tags as $tag) {
$priority = isset($tag['priority']) ? $tag['priority'] : 0;
if (!isset($urlNormalizerList[$priority])) {
$urlNormalizerList[$priority] = array(); | - |
ChameleonModulePass | process | * You can modify the container here before it is dumped to PHP code.
*
* @param ContainerBuilder $container
*
* @api
*
* @return void | $moduleServiceDefinition = $container->getDefinition('chameleon_system_core.module_resolver');
$moduleServiceIds = array_keys($container->findTaggedServiceIds('chameleon_system.module'));
$services = [];
foreach ($moduleServiceIds as $moduleServiceId) {
$moduleDefinition = $container->getDefinition($moduleServiceId);
if (true === $moduleDefinition->isShared()) {
throw new \LogicException('Chameleon modules must not be shared service instances. This module is shared: '.$moduleServiceId); | - |
CollectRequestStateElementProvidersPass | process | * {@inheritDoc}
*
* @return void | $hashProvider = $container->getDefinition('chameleon_system_core.request_state_hash_provider');
$elementProvider = array_keys(
$container->findTaggedServiceIds('chameleon_system_core.request_state_element_provider')
);
$clearStateEvents = [];
$elementProviderServiceDefinitions = [];
foreach ($elementProvider as $serviceId) {
$providerDefinition = $container->getDefinition($serviceId);
$providerClass = $providerDefinition->getClass();
$clearStateEvents = array_merge(
$clearStateEvents,
\call_user_func(array($providerClass, 'getResetStateEvents'))
);
$elementProviderServiceDefinitions[] = $providerDefinition; | - |
ControllerResolverPass | process | * @return void | $definition = $container->getDefinition('controller_resolver');
$container->setDefinition('default.controller_resolver', $definition);
$container->setAlias('controller_resolver', 'chameleon_system_core.controller_resolver');
if ($container->getParameter('kernel.debug')) {
$definition = $container->findDefinition('debug.controller_resolver');
$arguments = $definition->getArguments();
$arguments[0] = new Reference('chameleon_system_core.controller_resolver');
$definition->setArguments($arguments); | - |
EmptyRequest | getLanguage | * @return null | return null; | - |
EmptyRequest | getActivePage | * @return null | return null; | - |
MakeLoggerPublicPass | process | * {@inheritdoc}
*
* @return void | $container->getAlias('logger')->setPublic(true); | - |
SetChameleonHttpKernelPass | process | * {@inheritDoc}
*
* @return void | $container->setAlias('http_kernel', 'chameleon_system_core.http_kernel');
$container->getAlias('http_kernel')->setPublic(true); | - |
SetCsrfTokenManagerFactoryPass | process | * {@inheritDoc}
*
* @return void | $tokenManagerDefinition = $container->getDefinition('security.csrf.token_manager');
$factoryDefinition = $container->getDefinition('chameleon_system_core.security.authenticity_token.csrf_token_manager_factory');
$tokenManagerDefinition->setFactory([$factoryDefinition, 'createCsrfTokenManager']); | - |
SetCsrfTokenStoragePass | process | * Replace the token storage service of Symfony as that one uses "session" directly - which does not work with our own session handling. | $tokenStorageDefinitionSymfony = $container->getDefinition('security.csrf.token_storage');
$tokenStorageDefinitionChameleon = $container->getDefinition('chameleon_system_core.security.authenticity_token.authenticity_token_storage');
$tokenStorageDefinitionSymfony->setClass($tokenStorageDefinitionChameleon->getClass());
$tokenStorageDefinitionSymfony->setArguments($tokenStorageDefinitionChameleon->getArguments()); | - |
BackendLoginEvent | __construct | * @deprecated 7.2 no longer used - use the standard symfony login event | $this->user = $user; | - |
BackendLoginEvent | getUser | * @var TCMSUser | return $this->user; | - |
BackendLogoutEvent | __construct | * @deprecated 7.2 no longer used - use the standard symfony logout event | $this->user = $user; | - |
BackendLogoutEvent | getUser | * @var TCMSUser|null | return $this->user; | - |
ChangeActiveDomainEvent | getNewActiveDomain | * @var TCMSPortalDomain|null | return $this->newActiveDomain; | - |
ChangeActiveDomainEvent | getOldActiveDomain | * @var TCMSPortalDomain|null | return $this->oldActiveDomain; | - |
ChangeActiveDomainEvent | __construct | * @return TCMSPortalDomain|null | $this->oldActiveDomain = $oldActiveDomain;
$this->newActiveDomain = $newActiveDomain; | - |
ChangeActiveLanguagesForPortalEvent | __construct | * @var TCMSPortal | $this->portal = $portal;
$this->oldLanguages = $oldLanguages;
$this->newLanguages = $newLanguages; | - |
ChangeActiveLanguagesForPortalEvent | getPortal | * @var string[] | return $this->portal; | - |
ChangeActiveLanguagesForPortalEvent | getOldLanguages | * @var string[] | return $this->oldLanguages; | - |
ChangeActiveLanguagesForPortalEvent | getNewLanguages | * @param TCMSPortal $portal
* @param string[] $oldLanguages list of language IDs for languages that were active before the change
* @param string[] $newLanguages list of language IDs for languages that are active before the change | return $this->newLanguages; | - |
ChangeActivePageEvent | getNewActivePage | * @var TCMSActivePage | return $this->newActivePage; | - |
ChangeActivePageEvent | getOldActivePage | * @var TCMSActivePage|null | return $this->oldActivePage; | - |
ChangeActivePageEvent | __construct | * @return TCMSActivePage | $this->newActivePage = $newActivePage;
$this->oldActivePage = $oldActivePage; | - |
ChangeActivePortalEvent | getNewActivePortal | * @var TCMSPortal|null | return $this->newActivePortal; | - |
ChangeActivePortalEvent | getOldActivePortal | * @var TCMSPortal|null | return $this->oldActivePortal; | - |
ChangeActivePortalEvent | __construct | * @return TCMSPortal|null | $this->oldActivePortal = $oldActivePortal;
$this->newActivePortal = $newActivePortal; | - |
ChangeDomainEvent | __construct | * @var TdbCmsPortalDomains[] | $this->changedDomains = $changedDomains; | - |
ChangeDomainEvent | getChangedDomains | * @param TdbCmsPortalDomains[] $changedDomains | return $this->changedDomains; | - |
ChangeNavigationTreeConnectionEvent | __construct | * @var TdbCmsTreeNode | $this->changedTreeConnection = $changedTreeConnection; | - |
ChangeNavigationTreeConnectionEvent | getChangedTreeConnection | * @param TdbCmsTreeNode $changedTreeConnection | return $this->changedTreeConnection; | - |
ChangeNavigationTreeNodeEvent | __construct | * @var \TdbCmsTree[] | $this->changedTreeNodes = $changedTreeNodes; | - |
ChangeNavigationTreeNodeEvent | getChangedTreeNodes | * @param \TdbCmsTree[] $changedTreeNodes | return $this->changedTreeNodes; | - |
ChangeShopOrderStepEvent | __construct | * @var TdbShopOrderStep[] | $this->changedShopOrderSteps = $changedShopOrderSteps; | - |
ChangeShopOrderStepEvent | getChangedShopOrderSteps | * @param TdbShopOrderStep[] $changedShopOrderSteps | return $this->changedShopOrderSteps; | - |
ChangeUseSlashInSeoUrlsForPortalEvent | __construct | * @var TCMSPortal | $this->portal = $portal;
$this->oldValue = $oldValue;
$this->newValue = $newValue; | - |
ChangeUseSlashInSeoUrlsForPortalEvent | getPortal | * @var bool | return $this->portal; | - |
ChangeUseSlashInSeoUrlsForPortalEvent | isOldValue | * @var bool | return $this->oldValue; | - |
ChangeUseSlashInSeoUrlsForPortalEvent | isNewValue | * @param TCMSPortal $portal
* @param bool $oldValue
* @param bool $newValue | return $this->newValue; | - |
DeleteMediaEvent | __construct | * @var string | $this->deletedMediaId = $deletedMediaId; | - |
DeleteMediaEvent | getDeletedMediaId | * @param string $deletedMediaId | return $this->deletedMediaId; | - |
DisplayListmanagerCellEvent | __construct | * Holds information on a single backend table cell. This information can be changed to alter display of the cell. | $this->tableCell = $tableCell;
$this->rowData = $rowData;
$this->isHeader = $isHeader; | - |
DisplayListmanagerCellEvent | getTableCell | * @var \TGroupTableField | return $this->tableCell; | - |
DisplayListmanagerCellEvent | getRowData | * @var array | return $this->rowData; | - |