All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes
PortletRules Class Reference
Inheritance diagram for PortletRules:
CalendarPortletRules ChartPortletRules DetailPortletRules IframePortletRules MixedForDetailsPortletRules ModelDetailsPortletRules MyListPortletRules RelatedCalendarPortletRules RelatedListPortletRules RssReaderPortletRules

Public Member Functions

 __construct ($viewClassName)
 
 getType ()
 
 allowOnDashboard ()
 
 allowMultiplePlacementOnDashboard ()
 
 allowOnRelationView ()
 
 resolveIconTypeName ()
 
 resolveIconName ()
 
 getDescription ()
 
 canUserAccessPortlet (User $user)
 

Protected Member Functions

 getIconType ()
 

Protected Attributes

 $viewClassName
 

Detailed Description

Definition at line 37 of file PortletRules.php.

Member Function Documentation

getType ( )
Returns
the first part of the view name for example 'WorldClock' would be returned if the view was 'WorldClockView'

Definition at line 51 of file PortletRules.php.

allowOnDashboard ( )

Views following this rule, are they able to be shown on a Dashboard

Returns
boolean true/false

Definition at line 61 of file PortletRules.php.

allowMultiplePlacementOnDashboard ( )

Views following this rule, are they able to be shown more than once on a dashboard

Returns
boolean true/false

Definition at line 71 of file PortletRules.php.

allowOnRelationView ( )

Views following this rule, are they able to be shown on a relation view

Returns
boolean true/false

Definition at line 81 of file PortletRules.php.

canUserAccessPortlet ( User  $user)

Override if additional rules are needed to determine access rights to a portlet

Parameters
User$user
Returns
bool

Definition at line 107 of file PortletRules.php.


The documentation for this class was generated from the following file:
Generated on Mon May 25 2020 07:10:56