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 |
|---|---|---|---|---|
TPkgCmsCaptcha_TextFieldJavascriptHidden | getHTMLSnippet | * generates a code for an identifier only once within one session call.
*
* @param string $sIdentifier
* @param int $iCharacters will be ignored by this type of captcha
*
* @return string | $sIdentifier = $this->GenerateCode($sIdentifier, 10);
$sHTML = '
<script type="text/javascript">
document.addEventListener("DOMContentLoaded", function(event) {
var captchaFields = document.querySelectorAll(\'input[name="'.$sIdentifier.'"]\');
Array.prototype.forEach.call(captchaFields, function(captchaField) {
captchaField.style.display = "none"; | - |
CmsChangeLogDataAccess | __construct | * {@inheritDoc} | $this->connection = $connection; | - |
Configuration | getConfigTreeBuilder | * {@inheritDoc} | $treeBuilder = new TreeBuilder('chameleon_system_cms_changelog');
$root = $treeBuilder->getRootNode();
$root->isRequired();
$root->addDefaultsIfNotSet()
->children()
->integerNode('days')
->info('Number of days to keep change log table entries. 0 disables the deletion. Default is 180.')
->defaultValue(180)
->end()
->end();
return $treeBuilder; | - |
TCMSChangeLogArchiver | archiveAndDelete | * Archives and deletes old changelog sets and changelog items.
*
* @deprecated - replaced by \ChameleonSystem\CmsChangeLogBundle\DataAccess\CmsChangeLogDataAccess::deleteOlderThan()
/* | $bArchiveSuccessful = $this->archive();
if ($bArchiveSuccessful) {
$this->delete(); | - |
TCMSCronJob_ArchiveChangeLog | __construct | * @return void | parent::__construct(null, null);
$this->days = $days;
$this->changeLogDataAccess = $changeLogDataAccess;
$this->logger = $logger; | - |
TCMSListManagerChangeLogItem | AddFields | * add additional fields.
*
* @return void | $jsParas = array('id');
++$this->columnCount;
$this->tableObj->AddHeaderField(array('cms_field_conf' => TGlobal::Translate('chameleon_system_cms_change_log.column.changed_field')), 'left', null, 1, false);
$this->tableObj->AddColumn('cms_field_conf', 'left', array($this, 'CallbackResolveFieldName'), $jsParas, 1);
++$this->columnCount;
$this->tableObj->AddHeaderField(array('value_old' => TGlobal::Translate('chameleon_system_cms_change_log.column.old_value')), 'left', null, 1, false);
$this->tableObj->AddColumn('value_old', 'left', array($this, 'CallbackResolveFieldValue'), $jsParas, 1);
++$this->columnCount;
$this->tableObj->AddHeaderField(array('value_new' => TGlobal::Translate('chameleon_system_cms_change_log.column.new_value')), 'left', null, 1, false);
$this->tableObj->AddColumn('value_new', 'left', array($this, 'CallbackResolveFieldValue'), $jsParas, 1); | - |
TCMSListManagerChangeLogItem | CallbackResolveFieldName | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string | return TCMSChangeLogFormatter::formatFieldName($cellValue); | - |
TCMSListManagerChangeLogItem | CallbackResolveFieldValue | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string | return TCMSChangeLogFormatter::formatFieldValue($row['cms_field_conf'], $cellValue); | - |
TCMSListManagerChangeLogSet | AddFields | * add additional fields.
*
* @return void | $jsParas = array('id');
++$this->columnCount;
$this->tableObj->AddHeaderField(array('cms_tbl_conf' => TGlobal::Translate('chameleon_system_cms_change_log.column.changed_table')), 'left', null, 1, false);
$this->tableObj->AddColumn('cms_tbl_conf', 'left', array($this, 'CallbackResolveTableName'), $jsParas, 1);
++$this->columnCount;
$this->tableObj->AddHeaderField(array('modified_name' => TGlobal::Translate('chameleon_system_cms_change_log.column.changed_record')), 'left', null, 1, false);
$this->tableObj->AddColumn('modified_name', 'left', null, $jsParas, 1);
$this->tableObj->searchFields['`pkg_cms_changelog_set`.`modified_name`'] = 'full'; // allow searching in this field
++$this->columnCount;
$this->tableObj->AddHeaderField(array('modify_date' => TGlobal::Translate('chameleon_system_cms_change_log.column.changed_on')), 'left', null, 1, false);
$this->tableObj->AddColumn('modify_date', 'left', array($this, 'CallbackFormatDate'), $jsParas, 1);
++$this->columnCount;
$this->tableObj->AddHeaderField(array('cms_user' => TGlobal::Translate('chameleon_system_cms_change_log.column.changed_by')), 'left', null, 1, false);
$this->tableObj->AddColumn('cms_user', 'left', array($this, 'CallbackFormatUser'), $jsParas, 1);
$this->tableObj->searchFields['`pkg_cms_changelog_set`.`cms_user`'] = 'full'; // allow searching in this field
++$this->columnCount;
$this->tableObj->AddHeaderField(array('change_type' => TGlobal::Translate('chameleon_system_cms_change_log.column.change_type')), 'left', null, 1, false);
$this->tableObj->AddColumn('change_type', 'left', array($this, 'CallbackFormatChangeType'), $jsParas, 1); | - |
TCMSListManagerChangeLogSet | CallbackResolveTableName | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string | return TCMSChangeLogFormatter::formatTableName($cellValue); | - |
TCMSListManagerChangeLogSet | CallbackFormatDate | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string | return TCMSChangeLogFormatter::formatDateTime($cellValue); | - |
TCMSListManagerChangeLogSet | CallbackFormatUser | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string | return TCMSChangeLogFormatter::formatUser($cellValue); | - |
TCMSListManagerChangeLogSet | CallbackFormatChangeType | * @param string $cellValue
* @param array<string, mixed> $row
* @param string $name
* @return string|null | return TCMSChangeLogFormatter::formatChangeType($cellValue); | - |
TCMSTableEditorChangeLog | Save | * manages saving, inserting, and deleting data from a table.
/* | if ($this->oTableConf->fieldChangelogActive) {
$this->failOnForbiddenTables();
$this->bIsUpdate = isset($postData['id']); | - |
TCMSTableEditorChangeLog | SaveField | * @var bool | if ($this->oTableConf->fieldChangelogActive) {
$this->failOnForbiddenTables();
$this->bIsUpdate = null !== $this->sId; | - |
TCMSFieldEqualsVisitor | __construct | * @var TCMSField | $this->oField1 = $oField1;
$this->oField2 = $oField2; | - |
TCMSFieldEqualsVisitor | check | * @var TCMSField | if (get_class($this->oField1) !== get_class($this->oField2)) {
return false; | - |
TCMSFieldEqualsVisitor | visit | * @param TCMSField $oField1
* @param TCMSField $oField2 | $methods = get_class_methods(get_class($this));
if (in_array('visit'.get_class($oField), $methods)) {
return $this->{'visit'.get_class($oField) | - |
ChameleonSystemCmsClassManagerExtension | load | * {@inheritDoc}
*
* @return void | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config/'));
$loader->load('services.xml'); | - |
TPkgCmsVirtualClassManager | load | * @var null|array<string, mixed> | $this->entryPoint = $entryPointClass;
$config = $this->getConfig();
return false !== $config && null !== $config; | - |
TPkgCmsVirtualClassManager | UpdateVirtualClasses | * @var null|string | $aExtensionList = $this->getExtensionList();
if ('' === $this->getConfigValue('name_of_entry_point') || '' === $this->getConfigValue('exit_class')) {
return; | - |
TPkgCmsVirtualClassManager | __construct | * @var Connection | $this->databaseConnection = $databaseConnection; | - |
TPkgCmsVirtualClassManager | getConfigValue | * @param string $entryPointClass
*
* @return bool | $config = $this->getConfig();
return (isset($config[$name])) ? $config[$name] : null; | - |
TPkgCmsVirtualClassManager | getExtensionList | * @param class-string $sClassName
* @param string $sClassSubType
* @param string $sClassType
* @param bool $bRefresh
* @return false|class-string | $aExtensionList = array();
$query = 'SELECT *
FROM pkg_cms_class_manager_extension
WHERE pkg_cms_class_manager_id = :classManagerId
ORDER BY `pkg_cms_class_manager_extension`.`position` ASC
';
$tRes = $this->databaseConnection->executeQuery($query, array('classManagerId' => $this->getConfigValue('id')));
while ($extension = $tRes->fetch(\PDO::FETCH_ASSOC)) {
$aExtensionList[] = $extension; | - |
TPkgCmsVirtualClassManager | setDatabaseConnection | * @param string|null $targetDir
*
* @return void | $this->databaseConnection = $connection; | - |
TCMSListManagerLogEntries | GetCustomRestriction | * @deprecated since 6.3.0 - use Psr\Log\LoggerInterface in conjunction with Monolog logging instead | $query = parent::GetCustomRestriction();
if (!isset($this->tableObj->_postData['filterLogLevel']) || self::ALL_SELECTION_VALUE === $this->tableObj->_postData['filterLogLevel']) {
return $query; | - |
RequestIdProcessor | __construct | * @var RequestInfoServiceInterface | $this->requestInfoService = $requestInfoService; | - |
RequestIdProcessor | __invoke | * {@inheritdoc} | $requestId = $this->requestInfoService->getRequestId();
if (true === \array_key_exists('extra', $record)) {
$record['extra']['request_id'] = $requestId; | - |
SessionIdProcessor | __construct | * @var RequestStack | $this->requestStack = $requestStack; | - |
SessionIdProcessor | __invoke | * {@inheritdoc} | $request = $this->requestStack->getCurrentRequest();
if (null === $request) {
return $record; | - |
ChameleonSystemCmsCoreLogExtension | load | * {@inheritDoc}
*
* @return void | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config/'));
$loader->load('services.xml'); | - |
TPkgCmsCoreLogMonologHandler_Database | __construct | * @deprecated since 6.3.0 - use Psr\Log\LoggerInterface in conjunction with Monolog logging instead | parent::__construct(Logger::DEBUG, true);
$this->connection = $connection; | - |
TPkgCmsCoreLog | __construct | * @deprecated since 6.3.0 - use Psr\Log\LoggerInterface in conjunction with Monolog logging instead | $this->setLogger($oLogger);
$this->requestUID = md5(uniqid(rand())); | - |
TPkgCmsCoreLog | setLogger | * @var Psr\Log\LoggerInterface | $this->logger = $logger; | - |
TPkgCmsCoreLog | emergency | * @var null|string | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->emergency($message, $context); | - |
TPkgCmsCoreLog | alert | * @var bool | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->alert($message, $context); | - |
TPkgCmsCoreLog | critical | * {@inheritDoc} | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->critical($message, $context); | - |
TPkgCmsCoreLog | error | * System is unusable.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->error($message, $context); | - |
TPkgCmsCoreLog | warning | * Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->warning($message, $context); | - |
TPkgCmsCoreLog | notice | * Critical conditions.
*
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->notice($message, $context); | - |
TPkgCmsCoreLog | info | * Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->info($message, $context); | - |
TPkgCmsCoreLog | debug | * Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->debug($message, $context); | - |
TPkgCmsCoreLog | log | * Normal but significant events.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $context = $this->addMetaData($context, $sFile, $iLine);
$this->logger->log($level, $message, $context); | - |
TPkgCmsCoreLog | setLogMetaData | * Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param string $sFile
* @param int $iLine
* @param array $context
*
* @return void | $this->logMetaData = $logMetaData; | - |
RequestIdProcessorTest | testInvokeAddsTheRequestId: void | * @var RequestInfoServiceInterface|ObjectProphecy | $requestId = 'request-id';
$this->givenARequestId($requestId);
$this->whenICallInvoke(['extra' => []]);
$this->thenTheRequestIdShouldHaveBeenAddedToExtra($requestId); | - |
RequestIdProcessorTest | testInvokeAddsTheExtraBlockIfMissing: void | * @var RequestIdProcessor | $requestId = 'request-id';
$this->givenARequestId($requestId);
$this->whenICallInvoke([]);
$this->thenTheRequestIdShouldHaveBeenAddedToExtra($requestId); | - |
SessionIdProcessorTest | testInvokeAddsTheSessionId: void | * @var MockObject<RequestStack> | $this->mockRequestWithSessionId('session-id');
$result = $this->subject->__invoke(['extra' => []]);
$this->assertSessionIdExistsInExtra($result, 'session-id'); | - |
SessionIdProcessorTest | testInvokeAddsTheExtraBlockIfMissing: void | * @var SessionIdProcessor | $this->mockRequestWithSessionId('session-id');
$result = $this->subject->__invoke([]);
$this->assertSessionIdExistsInExtra($result, 'session-id'); | - |
SessionIdProcessorTest | testInvokeReturnsTheInputWithoutRequest: void | * Pass `null` as session id to mock not having a session. | $input = ['extra' => [], 'dummy' => 'test'];
$result = $this->subject->__invoke($input);
$this->assertEquals($input, $result); | - |
SessionIdProcessorTest | testInvokeReturnsTheInputWithoutSession: void | * Asserts that the given sessionId has been added as extra.session_id correctly. | $this->mockRequestWithSessionId(null);
$input = ['extra' => [], 'dummy' => 'test2'];
$result = $this->subject->__invoke($input);
$this->assertEquals($input, $result); | - |
CmsCounter | __construct | * @var Connection | $this->db = $db; | - |
CmsCounter | getCurrentValue | * return current counter value for named counter with given owner. returns null if no entry found.
*
* @param \TCMSRecord $owner
* @param string $systemName
*
* @return int|null | $query = 'SELECT `value`
FROM `pkg_cms_counter`
WHERE `owner_table_name` = :ownerTable
AND `owner` = :ownerId
AND `system_name` = :systemName
LIMIT 1';
$stm = $this->db->prepare($query);
$stm->execute(array('ownerTable' => $owner->table, 'ownerId' => $owner->id, 'systemName' => $systemName));
if (0 === $stm->rowCount()) {
return null; | - |
CmsCounter | set | * create or update counter.
*
* @param \TCMSRecord $owner
* @param string $systemName
* @param int $value
*
* @return void | $query = 'INSERT INTO `pkg_cms_counter`
SET `id` = :id,
`owner_table_name` = :ownerTable,
`owner` = :ownerId,
`system_name` = :systemName,
`name` = :systemName,
`value` = :value
ON DUPLICATE KEY UPDATE `value` = :value
';
$statement = $this->db->prepare($query);
$statement->execute(array(':id' => \TTools::GetUUID(), 'ownerTable' => $owner->table, 'ownerId' => $owner->id, 'systemName' => $systemName, 'value' => intval($value)));
$statement->closeCursor(); | - |
CmsCounter | get | * returns next free counter number and blocks it from being used by another call.
*
* @param \TCMSRecord $owner
* @param string $systemName
*
* @return int | $counterValue = 0;
$this->db->beginTransaction();
$query = 'SELECT `id`, `value`
FROM `pkg_cms_counter`
WHERE `owner_table_name` = :ownerTable
AND `owner` = :ownerId
AND `system_name` = :systemName
LIMIT 1
FOR UPDATE
';
$statement = $this->db->prepare($query);
$statement->execute(array('ownerTable' => $owner->table, 'ownerId' => $owner->id, 'systemName' => $systemName));
if (0 === $statement->rowCount()) {
$statement->closeCursor();
$query = 'INSERT INTO `pkg_cms_counter`
SET `id` = :id,
`owner_table_name` = :ownerTable,
`owner` = :ownerId,
`system_name` = :systemName,
`name` = :systemName,
`value` = :value
';
$statement = $this->db->prepare($query);
$statement->execute(array(':id' => \TTools::GetUUID(), 'ownerTable' => $owner->table, 'ownerId' => $owner->id, 'systemName' => $systemName, 'value' => 2));
$counterValue = 1; | - |
TPkgCmsEvent | GetSubject | * @var null|string | return $this->oSubject; | - |
TPkgCmsEvent | SetSubject | * @var null|string | $this->oSubject = $oSubject;
return $this; | - |
TPkgCmsEvent | GetContext | * @var array<string, mixed> | return $this->sContext; | - |
TPkgCmsEvent | GetName | * @var null|object | return $this->sName; | - |
TPkgCmsEvent | GetData | * @return null|object | return $this->aData; | - |
TPkgCmsEvent | SetContext | * @param object $oSubject -the object that created the event
*
* @return $this | $this->sContext = $sContext;
return $this; | - |
TPkgCmsEvent | SetName | * @return null|string | $this->sName = $sName;
return $this; | - |
TPkgCmsEvent | SetData | * @return null|string | $this->aData = $aData;
return $this; | - |
TPkgCmsEventManager | RegisterObserver | * use the event manager to trigger new events, or register observers for events - implements an observer pattern.
/* | $sFullEventName = $this->GetFullEventName($sEventContext, $sEventName);
if (!isset($this->aObserver[$sFullEventName])) {
$this->aObserver[$sFullEventName] = array(); | - |
TPkgCmsEventManager | NotifyObservers | * @var array<string, IPkgCmsEventObserver[]> | $sEventClassName = $this->GetFullEventNameFromEvent($oEvent);
if (isset($this->aObserver[$sEventClassName])) {
reset($this->aObserver[$sEventClassName]);
foreach (array_keys($this->aObserver[$sEventClassName]) as $sObserverIndex) {
$oEvent = $this->aObserver[$sEventClassName][$sObserverIndex]->PkgCmsEventNotify($oEvent); | - |
ChameleonSystemCmsFileManagerExtension | load | * {@inheritDoc}
*
* @return void | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config/'));
$loader->load('services.xml'); | - |
TPkgCmsFileManager_FileSystem | put | * {@inheritdoc} | // only do something when we are local
if (!$remoteOnly) {
$ret = rename($sSource, $sTarget);
if (null !== $chmod) {
$this->chmod($sTarget, $chmod); | - |
TPkgCmsFileManager_FileSystem | move | * {@inheritdoc} | return $this->put($source, $target); | - |
TPkgCmsFileManager_FileSystem | copy | * {@inheritdoc} | if (is_link($source)) {
return symlink(readlink($source), $target); | - |
TPkgCmsFileManager_FileSystem | get | * {@inheritdoc} | // TODO: Implement get() method. | - |
TPkgCmsFileManager_FileSystem | delete | * {@inheritdoc} | return $this->unlink($file); | - |
TPkgCmsFileManager_FileSystem | unlink | * {@inheritdoc} | return unlink($file); | - |
TPkgCmsFileManager_FileSystem | symlink | * {@inheritdoc} | return symlink($target, $link); | - |
TPkgCmsFileManager_FileSystem | chmod | * {@inheritdoc} | return chmod($file, $mode); | - |
TPkgCmsFileManager_FileSystem | mkdir | * {@inheritdoc} | if (0777 !== $mode) {
trigger_error('File permissions are handled by the administrator. Do not try to set the mode by hand.', E_USER_DEPRECATED); | - |
TPkgCmsFileManager_FileSystem | rmdir | * {@inheritdoc} | return rmdir($path); | - |
TPkgCmsFileManager_FileSystem | deldir | * {@inheritdoc} | $path = realpath($path);
if (false === $path || false === is_dir($path)) {
return; | - |
TPkgCmsFileManager_FileSystem | fopen | * {@inheritdoc} | if (null === $use_include_path) {
return fopen($filename, $mode); // don't ask | - |
TPkgCmsFileManager_FileSystem | fwrite | * {@inheritdoc} | if (null === $length) {
return fwrite($handle, $string); // I said don't ask! | - |
TPkgCmsFileManager_FileSystem | fclose | * {@inheritdoc} | return fclose($handle); | - |
TPkgCmsFileManager_FileSystem | file_put_contents | * {@inheritdoc} | return file_put_contents($filename, $data); | - |
TPkgCmsFileManager_Utilities | getStepSizeFromBlockSize | * @param int $input_size - raw input file size in bytes
*
* @return int - base64 encoded output file size in bytes | $code_size = (($input_size * 4) / 3);
$padding_size = ($input_size % 3) ? (3 - ($input_size % 3)) : 0;
/** @var int $total_size */
$total_size = ceil($code_size + $padding_size);
return $total_size; | - |
TPkgCmsFileManager_Utilities | debianSaveGlob | @var int $total_size | $pattern = $path.DIRECTORY_SEPARATOR.$patternInPath;
$result = glob($pattern, $flags);
if (false === $result && is_dir($path) && is_readable($path) && is_writable($path)) {
$result = array(); //fix for debian systems, which don't return an empty array, but false, when they find an empty folder. | - |
TCMSInterfaceManagerBase | __construct | * extend any interfaces (import and export) you build for the cms from this class.
* to get an instance of the right interface, use the static factory GetInterfaceManagerObject in the database object of the table
* Example: $oInterface = TdbCmsInterfaceManager::GetInterfaceManagerObject(1);
* this would return the interface object defined by record id 1 in the table. | parent::__construct('cms_interface_manager', $id, $iLanguage); | - |
TCMSInterfaceManagerBase | GetEventInfos | * Contains the parameters of the interface as key=>value pair.
*
* @var array<string, mixed> | return $this->aMessages; | - |
TCMSInterfaceManagerBase | Init | * set to true if the interface encountered an error.
*
* @var bool | null | - |
TCMSInterfaceManagerBase | RunImport | * write any messages into this array so that the calling class can display the info to the user.
*
* @var array | $bImportOk = false;
if ($this->PrepareImport()) {
$bImportOk = $this->PerformImport(); | - |
TPkgCmsNavigation_LanguageSelection | GetRequirements | * {@inheritdoc} | $oRequirements->NeedsSourceObject('aTree', 'array', array()); | - |
TPkgCmsNavigation_LanguageSelection | Accept | * {@inheritdoc} | $aLanguageList = $this->getLanguageList();
if (count($aLanguageList) < 2) {
return; | - |
TPkgCmsNavigation_LoginMapper | GetRequirements | * mapper adds a login/register link or a my account link to a navi.
/* | $oRequirements->NeedsSourceObject('aTree', 'array', array()); | - |
TPkgCmsNavigation_LoginMapper | Accept | * {@inheritdoc} | $aTree = $oVisitor->GetSourceObject('aTree');
$user = $this->getExtranetUserProvider()->getActiveUser();
$oExtranet = TdbDataExtranet::GetInstance();
if ($oExtranet && $bCachingEnabled) {
$oCacheTriggerManager->addTrigger($oExtranet->table, $oExtranet->id); | - |
AbstractPkgCmsNavigationNode | load;
/**
* @param T $oNode
*
* @return bool
*/
abstract public function loadFromNode;
/**
* returns the url to an icon for the node - if set.
*
* @return string|null
*/
abstract public function getNodeIconURL;
/**
* @return array|null
*/
abstract public function getAChildren;
/**
* @return bool
*/
abstract public function getBIsActive;
/**
* @return bool
*/
abstract public function getBIsExpanded;
/**
* @param bool $bDisableSubmenu
*
* @return void
*/
public function setDisableSubmenu | * @template T | $this->bDisableSubmenu = $bDisableSubmenu; | - |
AbstractPkgCmsNavigationNode | setChildren | * @var string | $this->aChildren = $aChildren; | - |
AbstractPkgCmsNavigationNode | setIsActive | * @var string | $this->bIsActive = $bIsActive; | - |
TPkgCmsNavigationNode | getAChildren | * @extends AbstractPkgCmsNavigationNode<TdbCmsTree> | if (true === $this->bDisableSubmenu) {
return null; | - |
TPkgCmsNavigationNode | load | * {@inheritdoc} | $node = $this->getTreeService()->getById($sId);
if (null === $node) {
return false; | - |
TPkgCmsNavigationNode | loadFromNode | @var $oNaviNode AbstractPkgCmsNavigationNode | if (false === $oNode->IsActive() || false === $oNode->AllowAccessByCurrentUser()) {
return false; | - |
TPkgCmsNavigationNode | getBIsActive | * {@inheritdoc} | if (null === $this->bIsActive) {
$this->bIsActive = false;
if (null !== $this->getNodeCopy()) {
$this->bIsActive = $this->getNodeCopy()->IsActiveNode(); | - |
TPkgCmsNavigationNode | getBIsExpanded | * {@inheritdoc} | if (null === $this->bIsExpanded) {
$this->bIsExpanded = $this->getBIsActive();
if (null !== $this->getNodeCopy()) {
$this->bIsExpanded = ($this->bIsExpanded || $this->getNodeCopy()->IsInBreadcrumb()); | - |
TPkgCmsNavigationNode | getNodeIconURL | * @param TdbCmsTree $oNode
*
* @return void | $sURL = null;
$oNode = $this->getNodeCopy();
$oImage = $oNode->GetImage(0, 'navi_icon_cms_media_id', $this->dummyImagesAllowed());
if ($oImage) {
$sURL = $oImage->GetRelativeURL();
$this->sNavigationIconId = $oImage->id; | - |
MTPkgCmsNavigationEndPoint | Accept | * {@inheritDoc} | $aModuleConfig = $oVisitor->GetSourceObject('aModuleConfig');
$sNaviName = (is_array($aModuleConfig) && isset($aModuleConfig['sNaviName'])) ? ($aModuleConfig['sNaviName']) : (false);
if (false === $sNaviName) {
return; | - |