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 |
|---|---|---|---|---|
ChameleonControllerInvokeEvent | getController | * @return \ChameleonSystem\CoreBundle\Controller\ChameleonControllerInterface | return $this->controller; | - |
ChameleonControllerInvokeListener | __construct | * @var \Symfony\Component\DependencyInjection\ContainerInterface | $this->container = $container; | - |
ChameleonControllerInvokeListener | onInvoke | * @return void | $this->container->set('chameleon_system_core.chameleon_controller', $event->getController()); | - |
ChameleonControllerResolver | __construct | * Class ChameleonControllerResolver. | $this->container = $container;
$this->defaultControllerResolver = $defaultControllerResolver;
$this->controllerList = $controllerList;
$this->defaultChameleonController = $defaultChameleonController; | - |
ChameleonControllerResolver | getController | @var ContainerInterface $container | $controller = $request->attributes->get('_controller', null);
if (null === $controller) {
return null; | - |
ChameleonFrontendController | __construct(
RequestStack $requestStack,
EventDispatcherInterface $eventDispatcher,
DataAccessCmsMasterPagedefInterface $dataAccessCmsMasterPagedef,
TModuleLoader $moduleLoader,
$viewPathManager,
ContainerInterface $container,
TPkgViewRendererConfigToLessMapper $configToLessMapper
) | * @var ContainerInterface | parent::__construct($requestStack, $eventDispatcher, $dataAccessCmsMasterPagedef, $moduleLoader, $viewPathManager);
$this->container = $container; // for ViewRenderer instantiation
$this->configToLessMapper = $configToLessMapper; | - |
ChameleonFrontendController | getResponse | * @var TPkgViewRendererConfigToLessMapper | $this->accessCheckHook();
$activePage = $this->activePageService->getActivePage();
if (null === $activePage) {
throw new NotFoundHttpException('No active page was found. At this point, this is most likely
caused by a missing request attribute named "pagedef" specifying a valid page ID. If the caller of this
method does not know which pagedef to set, throw a NotFoundHttpException instead.'); | - |
ChameleonFrontendController | GetPagedefObject | * @param \IViewPathManager $viewPathManager | //check if the pagedef exists in the database... if it does, use it. if not, use the file
$oPageDefinitionFile = null;
$inputFilterUtil = $this->getInputFilterUtil();
$requestMasterPageDef = $inputFilterUtil->getFilteredInput('__masterPageDef', false);
if ($requestMasterPageDef && TGlobal::CMSUserDefined()) {
// load master pagedef...
$oPageDefinitionFile = TdbCmsMasterPagedef::GetNewInstance();
$oPageDefinitionFile->Load($inputFilterUtil->getFilteredInput('id')); | - |
ChameleonNoAutoFlushController | __construct | * @var ChameleonController | $this->controller = $controller; | - |
ChameleonNoAutoFlushController | __invoke | * {@inheritdoc} | $original = $this->controller->getBlockAutoFlushToBrowser();
$this->controller->SetBlockAutoFlushToBrowser(true);
$response = $this->controller->__invoke();
$this->controller->SetBlockAutoFlushToBrowser($original);
return $response; | - |
ChameleonNoAutoFlushController | getResponse | * {@inheritdoc} | return $this->controller->getResponse(); | - |
ChameleonNoAutoFlushController | setCache | * {@inheritdoc} | $this->controller->setCache($cache); | - |
ChameleonNoAutoFlushController | AddHTMLHeaderLine | * {@inheritdoc} | $this->controller->AddHTMLHeaderLine($sLine); | - |
ChameleonNoAutoFlushController | AddHTMLFooterLine | * {@inheritdoc} | $this->controller->AddHTMLFooterLine($sLine); | - |
ChameleonNoAutoFlushController | FlushContentToBrowser | * {@inheritdoc} | $this->controller->FlushContentToBrowser($enableAutoFlush); | - |
ExceptionController | setMainController | * {@inheritdoc} | $this->mainController = $mainController; | - |
ExceptionController | showAction: Response | * @var ChameleonControllerInterface | $code = null;
if (method_exists($exception, 'getStatusCode')) {
$code = $exception->getStatusCode(); | - |
ExceptionController | setExtranetConfiguration | * @var PortalDomainServiceInterface | $this->extranetConfiguration = $extranetConfiguration; | - |
ExceptionController | setExtranetUserProvider | * @var ExtranetConfigurationInterface | $this->extranetUserProvider = $extranetUserProvider; | - |
ExceptionController | setPortalDomainService | * @var RequestInfoServiceInterface | $this->portalDomainService = $portalDomainService; | - |
ExceptionController | setRequestInfoService | * @var ExtranetUserProviderInterface | $this->requestInfoService = $requestInfoService; | - |
ExceptionController | setPageService | * @var PageServiceInterface | $this->pageService = $pageService; | - |
ImageNotFoundController | __invoke | * @return BinaryFileResponse|Response | $imagePath = PATH_WEB.CHAMELEON_404_IMAGE_PATH_SMALL;
if (file_exists($imagePath)) {
return new BinaryFileResponse($imagePath); | - |
CronjobEnablingService | __construct | * @var Connection | $this->connection = $connection;
$this->cache = $cache; | - |
CronjobEnablingService | isCronjobExecutionEnabled: bool | * @var CacheInterface | $config = TdbCmsConfig::GetInstance();
return true === $config->fieldCronjobsEnabled; | - |
CronjobEnablingService | enableCronjobExecution: void | * @throws CronjobHandlingException | try {
$this->connection->executeUpdate("UPDATE `cms_config` SET `cronjobs_enabled` = '1'");
$this->cache->callTrigger('cms_config'); | - |
CronjobEnablingService | disableCronjobExecution: void | * @throws CronjobHandlingException | try {
$this->connection->executeUpdate("UPDATE `cms_config` SET `cronjobs_enabled` = '0'");
$this->cache->callTrigger('cms_config'); | - |
CronJobFactory | __construct | * @var ContainerInterface | $this->container = $container; | - |
CronJobFactory | constructCronJob | * {@inheritdoc} | if (true === $this->container->has($identifier)) {
$cronJob = $this->container->get($identifier); | - |
CronJobScheduleDataModel | __construct | * @var \DateTime|null | $this->lastPlannedExecution = $lastPlannedExecution;
$this->executeEveryNMinutes = $executeEveryNMinutes;
$this->unlockAfterNMinutes = $unlockAfterNMinutes;
$this->isLocked = $isLocked; | - |
CronJobScheduleDataModel | getLastPlannedExecution: ?\DateTime | * @var int | return $this->lastPlannedExecution; | - |
CronJobScheduleDataModel | getExecuteEveryNMinutes: int | * @var int | return $this->executeEveryNMinutes; | - |
CronJobScheduleDataModel | getUnlockAfterNMinutes: int | * @var bool | return $this->unlockAfterNMinutes; | - |
CronJobScheduler | __construct | * @var TimeProviderInterface | $this->timeProvider = $timeProvider; | - |
CronJobScheduler | requiresExecution: bool | * {@inheritdoc} | $this->validateSchedule($schedule);
$lastPlannedExecution = $schedule->getLastPlannedExecution();
if (null === $lastPlannedExecution) {
return true; | - |
CronJobScheduler | calculateCurrentPlannedExecutionDate: \DateTime | * {@inheritdoc} | $this->validateSchedule($schedule);
$lastPlannedExecution = $schedule->getLastPlannedExecution();
if (null === $lastPlannedExecution) {
return $this->timeProvider->getDateTime(); | - |
CronjobStateService | __construct | * @var Connection | $this->connection = $connection; | - |
CronjobStateService | isCronjobRunning: bool | * {@inheritdoc} | try {
return $this->connection->fetchColumn("SELECT COUNT(*) FROM `cms_cronjobs` WHERE `lock` = '1'") > 0; | - |
CacheDataAccess | __construct | * @template T extends TCMSRecord
* @implements DataAccessInterface<T> | $this->cache = $cache;
$this->languageService = $languageService;
$this->decorated = $decorated; | - |
CacheDataAccess | loadAll | * @var CacheInterface | if (null === $languageId) {
$languageId = $this->languageService->getActiveLanguageId(); | - |
CacheDataAccess | getCacheTriggers | * @var LanguageServiceInterface | return array(); | - |
CmsPortalDomainsDataAccess | __construct | * @var Connection | $this->connection = $connection; | - |
CmsPortalDomainsDataAccess | getPrimaryDomain | * {@inheritdoc} | $query = "SELECT *
FROM `cms_portal_domains` WHERE `cms_portal_id` = :portalId
AND `is_master_domain` = '1'
AND (`cms_language_id` = :languageId OR `cms_language_id` = '')
ORDER BY `cms_language_id` DESC LIMIT 0,1
";
$rows = $this->connection->fetchAllAssociative($query, [
'portalId' => $portalId,
'languageId' => $languageId,
]);
if (0 === count($rows)) {
return null; | - |
CmsPortalDomainsDataAccess | getAllDomainNames: array | * {@inheritDoc}
*
* Copied partly from PortalDomainServiceInterface::getDomainNameList(). | $portalList = \TdbCmsPortalList::GetList();
$portalDomainNames = [];
while (false !== ($portal = $portalList->Next())) {
$domains = $portal->GetFieldCmsPortalDomainsList();
while ($domain = $domains->Next()) {
$domainName = trim($domain->fieldName);
if ('' !== $domainName) {
$portalDomainNames[$domainName] = true; | - |
CmsPortalDomainsDataAccess | getPortalPrefixListForDomain: array | * {@inheritdoc} | if ('' === $domainName) {
return []; | - |
CmsPortalDomainsDataAccess | getActivePortalCandidate: ?array | * {@inheritdoc} | $query = "SELECT *
FROM `cms_portal`
WHERE `id` IN (?)
AND (`identifier` = ? OR `identifier` = '')
";
if (false === $allowInactivePortals) {
$query .= " AND `cms_portal`.`deactive_portal` != '1' "; | - |
CmsPortalDomainsDataAccess | getDomainDataByName: array | * {@inheritdoc} | if ('' === $domainName) {
return []; | - |
CmsPortalDomainsDataAccessCacheDecorator | __construct | * @var ContainerInterface | $this->container = $container; // Avoid circular dependency on CacheInterface.
$this->subject = $subject; | - |
CmsPortalDomainsDataAccessCacheDecorator | getPrimaryDomain | * @var CmsPortalDomainsDataAccessInterface | $cache = $this->getCache();
$cacheKey = $cache->getKey(array(
get_class(),
'getPrimaryDomain',
get_class($this->subject),
$portalId,
$languageId,
));
$primaryDomain = $cache->get($cacheKey);
if (null !== $primaryDomain) {
return $primaryDomain; | - |
CmsPortalDomainsDataAccessCacheDecorator | getPortalPrefixListForDomain: array | * {@inheritdoc} | $cache = $this->getCache();
$cacheKey = $cache->getKey([
__METHOD__,
\get_class($this->subject),
$domainName,
]);
$value = $cache->get($cacheKey);
if (null !== $value) {
return $value; | - |
CmsPortalDomainsDataAccessCacheDecorator | getActivePortalCandidate: ?array | * {@inheritdoc} | return $this->subject->getActivePortalCandidate($idRestrictionList, $identifierRestriction, $allowInactivePortals); | - |
CmsPortalDomainsDataAccessCacheDecorator | getDomainDataByName: array | * {@inheritdoc} | $cache = $this->getCache();
$cacheKey = $cache->getKey([
__METHOD__,
\get_class($this->subject),
$domainName,
]);
$value = $cache->get($cacheKey);
if (null !== $value) {
return $value; | - |
CmsPortalDomainsDataAccessCacheDecorator | getAllDomainNames: array | * {@inheritdoc} | return $this->subject->getAllDomainNames(); | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | __construct | * @var CmsPortalDomainsDataAccessInterface | $this->subject = $subject; | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | getPrimaryDomain | * @var array<string, TdbCmsPortalDomains|null> | $cacheKey = "$portalId-$languageId";
if (true === isset($this->cache[$cacheKey])) {
return $this->cache[$cacheKey]; | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | getAllDomainNames: array | * @var string[] | if (null === $this->domainNamesCache) {
$this->domainNamesCache = $this->subject->getAllDomainNames(); | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | getPortalPrefixListForDomain: array | * @param CmsPortalDomainsDataAccessInterface $subject | return $this->subject->getPortalPrefixListForDomain($domainName); | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | getActivePortalCandidate: ?array | * {@inheritdoc} | return $this->subject->getActivePortalCandidate($idRestrictionList, $identifierRestriction, $allowInactivePortals); | - |
CmsPortalDomainsDataAccessRequestLevelCacheDecorator | getDomainDataByName: array | * {@inheritdoc} | return $this->subject->getDomainDataByName($domainName); | - |
DataAccessClassFromTableTableFieldProvider | __construct | * @var Connection | $this->databaseConnection = $databaseConnection; | - |
DataAccessClassFromTableTableFieldProvider | getFieldClassNameFromDictionaryValues | * @param Connection $databaseConnection | $query = $this->getFieldClassRowQuery();
try {
$fieldClassName = $this->databaseConnection->fetchColumn($query, array(
'tableName' => $tableName,
'fieldName' => $fieldName,
));
if (false === $fieldClassName) {
return null; | - |
DataAccessCmsLanguage | __construct | * DataAccessCmsLanguage provides an implementation of DataAccessCmsLanguageInterface for the default database backend.
* Some methods load data manually instead of using existing TCMSRecord loading methods, because there are cases where
* this would lead to endless recursion (loading the language is a special case as the language relies on the language
* which implies an intrinsic potential for deadlocks). | $this->databaseConnection = $databaseConnection; | - |
DataAccessCmsLanguage | getLanguage | * @var Connection | $language = TdbCmsLanguage::GetNewInstance();
$languageRaw = $this->getLanguageRaw($id);
if (null === $languageRaw) {
return null; | - |
DataAccessCmsLanguage | getLanguageRaw | * @param Connection $databaseConnection | $language = TdbCmsLanguage::GetNewInstance();
$language->DisablePostLoadHook(true);
if (false === $language->Load($id)) {
return null; | - |
DataAccessCmsLanguage | getLanguageFromIsoCode | * {@inheritdoc} | $query = 'SELECT * FROM `cms_language` WHERE `iso_6391` = :isoCode';
$row = $this->databaseConnection->fetchAssociative($query, array(
'isoCode' => $isoCode,
));
if (false === $row) {
return null; | - |
DataAccessCmsLanguageRequestLevelCacheDecorator | __construct | * @var DataAccessCmsLanguageInterface | $this->subject = $subject; | - |
DataAccessCmsLanguageRequestLevelCacheDecorator | getLanguage | * @var array | $key = 'getLanguage-'.$id;
if (false === isset($this->cache[$key])) {
$languageRaw = $this->getLanguageRaw($id);
if (null === $languageRaw) {
return null; | - |
DataAccessCmsLanguageRequestLevelCacheDecorator | getLanguageRaw | * @param DataAccessCmsLanguageInterface $subject | $key = 'getLanguageRaw-'.$id;
if (false === isset($this->cache[$key])) {
$this->cache[$key] = $this->subject->getLanguageRaw($id); | - |
DataAccessCmsLanguageRequestLevelCacheDecorator | getLanguageFromIsoCode | * {@inheritdoc} | $key = 'getLanguageFromIsoCode-'.$isoCode;
if (false === isset($this->cache[$key])) {
$language = $this->subject->getLanguageFromIsoCode($isoCode, $targetLanguageId);
if (null === $language) {
return null; | - |
DataAccessCmsMasterPagedefCacheDecorator | __construct(
DataAccessCmsMasterPagedefInterface $subject,
InputFilterUtilInterface $inputFilterUtil,
CacheInterface $cache,
RequestInfoServiceInterface $requestInfoService
) | * @var DataAccessCmsMasterPagedefInterface | $this->subject = $subject;
$this->cache = $cache;
$this->inputFilterUtil = $inputFilterUtil;
$this->requestInfoService = $requestInfoService; | - |
DataAccessCmsMasterPagedefCacheDecorator | get: ?CmsMasterPagdef | * @var CacheInterface | $cacheKeyParameter = $this->getCacheKeyParameters($id);
$cacheKey = $this->cache->getKey($cacheKeyParameter);
$pagedefData = $this->cache->get($cacheKey);
if (null !== $pagedefData) {
return $pagedefData; | - |
DataAccessCmsMasterPagedefDatabase | __construct | * @var DataAccessCmsMasterPagedefInterface | $this->fallbackLoader = $fallbackLoader;
$this->inputFilterUtil = $inputFilterUtil; | - |
DataAccessCmsMasterPagedefDatabase | get: ?CmsMasterPagdef | * @var InputFilterUtilInterface | //check if the pagedef exists in the database... if it does, use it. if not, use the file
$oPageDefinitionFile = null;
$requestMasterPageDef = 'true' === $this->inputFilterUtil->getFilteredInput('__masterPageDef');
if (true === $requestMasterPageDef && true === TGlobal::CMSUserDefined()) {
// load master pagedef...
$oPageDefinitionFile = TdbCmsMasterPagedef::GetNewInstance();
$oPageDefinitionFile->Load($this->inputFilterUtil->getFilteredInput('id')); | - |
DataAccessCmsMasterPagedefFile | __construct | * @var InputFilterUtilInterface | $this->inputFilterUtil = $inputFilterUtil;
$this->global = $global; | - |
DataAccessCmsMasterPagedefFile | get: ?CmsMasterPagdef | * @var \TGlobal | $oPageDefinitionFile = new TCMSPageDefinitionFile();
$fullPageDefPath = $this->PageDefinitionFile($id);
$pagePath = substr($fullPageDefPath, 0, -strlen($id.'.pagedef.php'));
if (false === $oPageDefinitionFile->Load($id, $pagePath)) {
return null; | - |
DataAccessCmsPortalSystemPage | __construct | * @implements DataAccessInterface<TdbCmsPortalSystemPage> | $this->databaseConnection = $databaseConnection; | - |
DataAccessCmsPortalSystemPage | loadAll | * @var Connection | $query = 'SELECT `cms_portal_system_page`.*
FROM `cms_portal_system_page`
ORDER BY `cms_portal_system_page`.`cmsident`';
$systemPages = $this->databaseConnection->fetchAllAssociative($query);
$systemPageList = array();
foreach ($systemPages as $systemPage) {
$pageId = $systemPage['id'];
$systemPageList[$pageId] = TdbCmsPortalSystemPage::GetNewInstance($systemPage, $languageId); | - |
DataAccessCmsPortalSystemPage | getCacheTriggers | * @param Connection $databaseConnection | return array(
'cms_portal_system_page',
'cms_tree',
); | - |
DataAccessCmsTplPage | __construct | * @implements DataAccessInterface<TdbCmsTplPage> | $this->databaseConnection = $databaseConnection; | - |
DataAccessCmsTplPage | loadAll | * @var Connection | $query = 'SELECT `cms_tpl_page`.*
FROM `cms_tpl_page`
ORDER BY `cms_tpl_page`.`cmsident`';
$pages = $this->databaseConnection->fetchAllAssociative($query);
$pageList = array();
foreach ($pages as $page) {
$pageId = $page['id'];
$pageList[$pageId] = TdbCmsTplPage::GetNewInstance($page, $languageId); | - |
DataAccessCmsTplPage | getCacheTriggers | * @param Connection $databaseConnection | return array(
'cms_tpl_page',
'cms_tree_node',
); | - |
DataAccessCmsTree | __construct | * @var Connection | $this->databaseConnection = $databaseConnection;
$this->languageService = $languageService; | - |
DataAccessCmsTree | loadAll | * @var LanguageServiceInterface | $query = 'SELECT * FROM `cms_tree` ORDER BY `lft`';
$result = $this->databaseConnection->fetchAllAssociative($query);
$trees = array();
if (null === $languageId) {
$languageId = $this->languageService->getActiveLanguageId(); | - |
DataAccessCmsTree | getAllInvertedNoFollowRulePageIds | * @param Connection $databaseConnection
* @param LanguageServiceInterface $languageService | $rows = $this->databaseConnection->fetchAllAssociative('SELECT `source_id`, `target_id` FROM `cms_tree_cms_tpl_page_mlt`');
if (false === $rows) {
return array(); | - |
DataAccessCmsTree | getInvertedNoFollowRulePageIds | * {@inheritdoc} | $query = 'SELECT `target_id` FROM `cms_tree_cms_tpl_page_mlt` WHERE `source_id` = :treeId';
return $this->databaseConnection->fetchColumn($query, array('treeId' => $cmsTreeId)); | - |
DataAccessCmsTreeNode | __construct | * @implements DataAccessInterface<TdbCmsTreeNode> | $this->databaseConnection = $databaseConnection;
$this->languageService = $languageService; | - |
DataAccessCmsTreeNode | loadAll | * @var Connection | $query = 'SELECT * FROM `cms_tree_node`';
$result = $this->databaseConnection->fetchAllAssociative($query);
$treeNodes = array();
if (null === $languageId) {
$languageId = $this->languageService->getActiveLanguageId(); | - |
DataAccessCmsTreeNode | getCacheTriggers | * @var LanguageServiceInterface | return array(
'cms_tree_node',
); | - |
DataAccessCmsTreeRequestLevelCacheDecorator | __construct | * @var DataAccessCmsTreeInterface | $this->subject = $subject;
$this->languageService = $languageService; | - |
DataAccessCmsTreeRequestLevelCacheDecorator | loadAll | * @var array | if (null === $languageId) {
$languageId = $this->languageService->getActiveLanguageId(); | - |
DataAccessCmsTreeRequestLevelCacheDecorator | getAllInvertedNoFollowRulePageIds | * @var LanguageServiceInterface | $cacheKey = 'allInvertedNoFollowRulePageIds';
if (false === array_key_exists($cacheKey, $this->cache)) {
$this->cache[$cacheKey] = $this->subject->getAllInvertedNoFollowRulePageIds(); | - |
DataAccessCmsTreeRequestLevelCacheDecorator | getInvertedNoFollowRulePageIds | * @param DataAccessCmsTreeInterface $subject
* @param LanguageServiceInterface $languageService | $all = $this->getAllInvertedNoFollowRulePageIds();
if (false === isset($all[$cmsTreeId])) {
return array(); | - |
RequestCacheDataAccess | __construct | * @template T extends TCMSRecord
* @implements DataAccessInterface<T> | $this->languageService = $languageService;
$this->decorated = $decorated; | - |
RequestCacheDataAccess | loadAll | * @var array<string, T[]> $elements | if (null === $languageId) {
$languageId = $this->languageService->getActiveLanguageId(); | - |
RequestCacheDataAccess | getCacheTriggers | * @var LanguageServiceInterface | return array(); | - |
UserMenuItemDataAccess | __construct | * @var Connection | $this->connection = $connection;
$this->logger = $logger; | - |
UserMenuItemDataAccess | getMenuItemIds: array | * @var LoggerInterface | if ('' === $userId) {
return []; | - |
UserMenuItemDataAccess | trackMenuItem: void | * {@inheritDoc} | if ('' === $userId || '' === $menuItemId) {
return; | - |
AbstractDatabaseAccessLayer | setDatabaseConnection | * @var Connection | $this->databaseConnection = $connection; | - |
DatabaseAccessLayerCmsMasterPagedefSpotAccess | getAccessForSpot | * @var bool | $this->loadAll();
return $this->getFromCache($spotId); | - |