ModulePortlet
abstract class ModulePortlet extends BaseHook
Properties
Core | $mod | ||
array | $_hook_info | Information is populated when called via get_hook (default) |
|
mixed | $portlet_config | ||
protected string | $portlet_title | ||
protected mixed | $portlet_title_link | ||
protected mixed | $download_handler | ||
protected mixed | $storage_path | ||
bool | $skip_auto_init | ||
array | $multi_group_context | ||
protected Core | $caller_reference | Instance calling this portlet |
|
protected XF | $XF | ||
array | $meta_info | Used in CMS to show icon |
Methods
put your comment there.
If false is returned, the portlet will not be loaded.
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
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
If the portlet offers options please supply fdl for options
No description
No description
No description
No description
When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.
No description
No description
Called when the staging page is replaced with the live page.
Called when the staging page is published.
No description
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
Set Caller Reference This function is automatically called from get_hooks
No description
No description
No description
No description
No description
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 128
__construct()
put your comment there.
..
at line 276
bool
can_read()
If false is returned, the portlet will not be loaded.
at line 436
protected
copyReferences(DocumentIndex $livePageIndex, DocumentIndex $stagingPageIndex, array $documentIds)
Copies the references from the staging page to the live page as passive or read references.
at line 294
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.
at line 114
xmodel_cms_component|xmodel_cms_component_live|null
getCmsComponent()
Getter for the cms component which displays this portlet
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
at line 187
mixed
get_config()
No description
at line 220
array|bool
get_fdl(mixed $component_id = false)
If the portlet offers options please supply fdl for options
at line 245
string
get_html($size = 'default')
No description
at line 147
final string
get_options()
No description
at line 229
string
get_title()
No description
at line 237
mixed
get_title_link()
No description
at line 354
protected
handleDeletedDocumentReferences(array $documentIds)
When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.
at line 138
init()
No description
at line 282
bool
isAvailable()
No description
at line 324
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.
at line 309
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.
at line 254
string
render()
No description
at line 468
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.
at line 106
void
setCmsComponent(xmodel_cms_component|xmodel_cms_component_live $cmsComponent)
Setter for the cms component
at line 267
set_caller_reference(Core $instance_ref)
Set Caller Reference This function is automatically called from get_hooks
at line 195
set_config($config = array())
No description
at line 160
set_download_handler($handler)
No description
at line 210
set_mod($mod)
No description
at line 179
final
set_options($config = array())
No description
at line 171
set_storage_path($path)
No description
at line 414
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.
at line 122
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.