PortletActionlogShowPortlet
class PortletActionlogShowPortlet extends ModulePortlet implements PropertyGroupExtensionInterface
Properties
| SystemActionlogController | $mod | ||
| array | $_hook_info | Information is populated when called via get_hook (default) |
from ModulePortlet |
| mixed | $portlet_config | from ModulePortlet | |
| protected string | $portlet_title | from ModulePortlet | |
| protected string|null | $portlet_title_link | from ModulePortlet | |
| protected mixed | $download_handler | from ModulePortlet | |
| protected mixed | $storage_path | from ModulePortlet | |
| bool | $skip_auto_init | from ModulePortlet | |
| array | $multi_group_context | from ModulePortlet | |
| protected Core | $caller_reference | Instance calling this portlet |
from ModulePortlet |
| protected bool | $isEmpty | Can be set with setIsEmpty() and should be set to true if there is no data for this portlet It is used by the frontend to allow hiding elements if empty |
from ModulePortlet |
| protected XF | $XF | from ModulePortlet | |
| array | $meta_info | Used in CMS to show icon |
from ModulePortlet |
Methods
No description
Set current portlet configuration as default values as expected with old CMS This will override currently set defaults
Copies the references from the staging page to the live page as passive or read references.
Cleanup references or stored data associated with this portlet instance.
Getter for the cms component which displays this portlet
Return Empty Placeholder WebComponent
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
No description
No description
No description
No description
Used in Portal extension
Used in lookbook extension
No description
When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.
Returns true if the portlet returns an empty result (is used be the frontend to hide empty elements)
Called when the staging page is replaced with the live page.
Called when the staging page is published.
Copies the read references from the live page to the staging page and re-creates owner references for the staging page.
Setter for the cms component
Mark portlet as empty (is used be the frontend to hide empty elements) Should be set to true if portlet is empty or shows no content template
Set Caller Reference This function is automatically called from get_hooks
Moves the staging page owner reference to the live page to prevent deletion of the documents.
is called during update() method of cms component. Can be overwritten in portlet, if there is an action required after a form submit.
Details
at line 27
__construct()
No description
in
ModulePortlet at line 154
array
convertToCmsFDLWithDefaults(array $fdl)
Set current portlet configuration as default values as expected with old CMS This will override currently set defaults
in
ModulePortlet at line 528
protected
copyReferences(DocumentIndex $livePageIndex, DocumentIndex $stagingPageIndex, array $documentIds)
Copies the references from the staging page to the live page as passive or read references.
in
ModulePortlet at line 349
delete()
Cleanup references or stored data associated with this portlet instance.
Remove references, moves (owner) references from the staging to the live page, when a staging component is deleted.
in
ModulePortlet at line 394
Core|null
getCallingContext()
No description
in
ModulePortlet at line 122
xmodel_cms_component|xmodel_cms_component_live|null
getCmsComponent()
Getter for the cms component which displays this portlet
in
ModulePortlet at line 590
protected string
getEmptyPlaceholder(string $message = null, string $description = null, string $icon = 'ph-cursor-click')
Return Empty Placeholder WebComponent
at line 134
array
getExtensionConfigFields(Controller $mod)
No description
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
in
BaseHook at line 97
mixed
getOption(string $key)
Returns the option with $key set in the config.yml
in
ModulePortlet at line 413
Page|null
getPageContext()
No description
at line 154
string|null
getPagesMigrationComponent()
No description
at line 161
string|null
getPagesMigrationHelpText()
No description
at line 147
string
getPagesMigrationStatus()
No description
in
ModulePortlet at line 231
mixed
get_config()
No description
at line 49
array|bool
get_fdl(mixed $component_id = null, $config = false, $profileUuid = null)
No description
at line 100
string
get_html($size = 'default')
Used in Portal extension
in
ModulePortlet at line 191
final string
get_options()
No description
at line 115
Template|array
get_properties(mixed $profile_id, null $config = null, null $profile_uuid = null)
Used in lookbook extension
at line 37
string
get_title()
No description
in
ModulePortlet at line 281
mixed
get_title_link()
No description
in
ModulePortlet at line 446
protected
handleDeletedDocumentReferences(array $documentIds)
When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.
in
ModulePortlet at line 182
init()
No description
in
ModulePortlet at line 318
bool
isAvailable()
No description
in
ModulePortlet at line 327
bool
isEmpty()
Returns true if the portlet returns an empty result (is used be the frontend to hide empty elements)
in
ModulePortlet at line 402
bool
isPagesContext()
Is this portlet used in pages?
in
ModulePortlet at line 421
bool
isPagesEditorContext()
Is this portlet currently used in pages editor?
in
ModulePortlet at line 379
onDiscardChanges(xmodel_cms_page_live $livePage, xmodel_cms_page $stagingPage)
Called when the staging page is replaced with the live page.
Restores the (owner) references from the staging page to the documents.
in
ModulePortlet at line 364
onPublish(xmodel_cms_page_live $livePage, xmodel_cms_page $stagingPage)
Called when the staging page is published.
Creates a read-reference of the document from the staging to the live page.
in
ModulePortlet at line 298
string
render()
No description
in
ModulePortlet at line 560
protected
restoreReferences(DocumentIndex $liveIndex, DocumentIndex $stagingIndex, array $documentIds)
Copies the read references from the live page to the staging page and re-creates owner references for the staging page.
in
ModulePortlet at line 390
ModulePortlet
setCallingContext(Core $context)
No description
in
ModulePortlet at line 114
void
setCmsComponent(xmodel_cms_component|xmodel_cms_component_live $cmsComponent)
Setter for the cms component
in
ModulePortlet at line 337
void
setIsEmpty(bool $isEmpty = true)
Mark portlet as empty (is used be the frontend to hide empty elements) Should be set to true if portlet is empty or shows no content template
in
ModulePortlet at line 408
ModulePortlet
setPageContext(Page|null $page)
No description
in
ModulePortlet at line 311
set_caller_reference(Core $instance_ref)
Set Caller Reference This function is automatically called from get_hooks
in
ModulePortlet at line 239
set_config($config = array())
No description
in
ModulePortlet at line 204
set_download_handler($handler)
No description
in
ModulePortlet at line 254
set_mod($mod)
No description
in
ModulePortlet at line 223
final
set_options($config = array())
No description
in
ModulePortlet at line 215
set_storage_path($path)
No description
in
ModulePortlet at line 506
protected
swapOwnerReference(DocumentIndex $documentIndex, DocumentIndexReference $ownerReference, DocumentIndex $newOwnerIndex)
Moves the staging page owner reference to the live page to prevent deletion of the documents.
As soon as the live page is deleted, the reference and document will also be deleted.
in
ModulePortlet at line 168
void
update(string|null $type)
is called during update() method of cms component. Can be overwritten in portlet, if there is an action required after a form submit.