PortletPersistentConfigUtil Class Reference

Inheritance diagram for PortletPersistentConfigUtil:
CampaignItemsPortletPersistentConfigUtil LatestActivitiesPortletPersistentConfigUtil MarketingListMembersPortletPersistentConfigUtil ProductsPortletPersistentConfigUtil

Static Public Member Functions

static setForCurrentUserByPortletIdAndKey ($portletId, $keyName, $value)
static getForCurrentUserByPortletIdAndKey ($portletId, $keyName, $returnBoolean=false)

Static Protected Member Functions

static resolveKeyNameByPortletId ($portletId, $keyName)
static getModuleName ()

Detailed Description

Helper class for working with portlets to maintain user configs across multiple sessions

Definition at line 40 of file PortletPersistentConfigUtil.php.


Member Function Documentation

static setForCurrentUserByPortletIdAndKey ( portletId,
keyName,
value 
) [static]

Set a persistent config value for current user against portletId and keyName.

Parameters:
$portletId integer Id of the portlet or string representation of the unique id of the portlet to set value against
$keyName string Name of the key that should be set
$value string|integer|boolean Value that should be assigned to keyName config

Definition at line 49 of file PortletPersistentConfigUtil.php.

static getForCurrentUserByPortletIdAndKey ( portletId,
keyName,
returnBoolean = false 
) [static]

Get a persistent config value for current user against portletId and keyName.

Parameters:
$portletId integer Id of the portlet or string representation of the unique id of the portlet to get value against
$keyName string Name of the key that should be returned
bool $returnBoolean bool Force return value to be boolean (explicit type casting)
Returns:
bool|null|string

Definition at line 66 of file PortletPersistentConfigUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Dec 14 07:10:27 2017