class ListsPortletShowPortlet extends ModulePortlet

Properties

ListsController $mod
array $_hook_info

Information is populated when called via get_hook (default)

from  ModulePortlet
$portlet_config
protected $portlet_title
$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 XF $XF from  ModulePortlet
$meta_info

Methods

__construct()

put your comment there.

bool
can_read()

If false is returned, the portlet will not be loaded.

copyReferences(DocumentIndex $livePageIndex, DocumentIndex $stagingPageIndex, array $documentIds)

Copies the references from the staging page to the live page as passive or read references.

delete()

Cleanup references or stored data associated with this portlet instance.

xmodel_cms_component|xmodel_cms_component_live|null
getCmsComponent()

Getter for the cms component which displays this portlet

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getObject()

No description

from  BaseHook
mixed
get_config()

No description

array|bool
get_fdl(mixed $component_id = false)

Get Config from this portlet

string
get_html($size = 'default')

No description

string
get_options()

No description

string
get_title()

No description

mixed
get_title_link()

No description

handleDeletedDocumentReferences(array $documentIds)

When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.

init()

No description

bool
isAvailable()

No description

onDiscardChanges(xmodel_cms_page_live $livePage, xmodel_cms_page $stagingPage)

Called when the staging page is replaced with the live page.

onPublish(xmodel_cms_page_live $livePage, xmodel_cms_page $stagingPage)

Called when the staging page is published.

string
render()

No description

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.

void
setCmsComponent(xmodel_cms_component|xmodel_cms_component_live $cmsComponent)

Setter for the cms component

set_caller_reference(Core $instance_ref)

Set Caller Reference This function is automatically called from get_hooks

set_config($config = array())

No description

set_download_handler($handler)

No description

set_mod($mod)

No description

set_options($config = array())

No description

set_storage_path($path)

No description

swapOwnerReference(DocumentIndex $documentIndex, DocumentIndexReference $ownerReference, DocumentIndex $newOwnerIndex)

Moves the staging page owner reference to the live page to prevent deletion of the documents.

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.

Details

at line 22
__construct()

put your comment there.

..

in ModulePortlet at line 276
bool can_read()

If false is returned, the portlet will not be loaded.

Return Value

bool

in ModulePortlet 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.

Parameters

DocumentIndex $livePageIndex

Live page

DocumentIndex $stagingPageIndex

Staging page

array $documentIds

Attached document index ids

in ModulePortlet 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.

in ModulePortlet at line 114
xmodel_cms_component|xmodel_cms_component_live|null getCmsComponent()

Getter for the cms component which displays this portlet

Return Value

xmodel_cms_component|xmodel_cms_component_live|null

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in BaseHook at line 88
getObject()

No description

in ModulePortlet at line 187
mixed get_config()

No description

Return Value

mixed

???

at line 51
array|bool get_fdl(mixed $component_id = false)

Get Config from this portlet

Parameters

mixed $component_id

Return Value

array|bool

FDL or false on fail

at line 93
string get_html($size = 'default')

No description

Parameters

$size

Return Value

string

html

in ModulePortlet at line 147
final string get_options()

No description

Return Value

string

html

at line 40
string get_title()

No description

Return Value

string

No description

Return Value

mixed

???

in ModulePortlet 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.

Parameters

array $documentIds

at line 29
init()

No description

in ModulePortlet at line 282
bool isAvailable()

No description

Return Value

bool

in ModulePortlet 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.

Parameters

xmodel_cms_page_live $livePage
xmodel_cms_page $stagingPage

in ModulePortlet 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.

Parameters

xmodel_cms_page_live $livePage
xmodel_cms_page $stagingPage

in ModulePortlet at line 254
string render()

No description

Return Value

string

html

in ModulePortlet 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.

Parameters

DocumentIndex $liveIndex
DocumentIndex $stagingIndex
array $documentIds

in ModulePortlet at line 106
void setCmsComponent(xmodel_cms_component|xmodel_cms_component_live $cmsComponent)

Setter for the cms component

Parameters

xmodel_cms_component|xmodel_cms_component_live $cmsComponent

Return Value

void

in ModulePortlet at line 267
set_caller_reference(Core $instance_ref)

Set Caller Reference This function is automatically called from get_hooks

Parameters

Core $instance_ref

in ModulePortlet at line 195
set_config($config = array())

No description

Parameters

$config

in ModulePortlet at line 160
set_download_handler($handler)

No description

Parameters

$handler

in ModulePortlet at line 210
set_mod($mod)

No description

Parameters

$mod

in ModulePortlet at line 179
final set_options($config = array())

No description

Parameters

$config

in ModulePortlet at line 171
set_storage_path($path)

No description

Parameters

$path

in ModulePortlet 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.

Parameters

DocumentIndex $documentIndex

Document index of the attached document

DocumentIndexReference $ownerReference

Reference from the staging page to the document

DocumentIndex $newOwnerIndex

The live page

in ModulePortlet 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.

Parameters

string|null $type

Return Value

void