All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
ReportResultsComponentForPortletView Class Reference
Inheritance diagram for ReportResultsComponentForPortletView:
ConfigurableMetadataView PortletViewInterface MetadataView View ReportChartForPortletView ReportResultsGridForPortletView ReportSQLForPortletView RuntimeFiltersForPortletView DashboardReportChartForPortletView

Public Member Functions

 __construct ($viewData, $params, $uniqueLayoutId)
 
 getPortletParams ()
 
 renderPortletHeadContent ()
 
 getTitle ()
 
- Public Member Functions inherited from View
 isUniqueToAPage ()
 
 render ()
 
 setCssClasses (array $classes)
 
 getCssClasses ()
 
 getTitle ()
 
 getPostTruncatedTitleContent ()
 

Static Public Member Functions

static canUserConfigure ()
 
static getPortletRulesType ()
 
static getModuleClassName ()
 
static getPortletDescription ()
 

Protected Member Functions

 resolveAndGetPaginationRoute ()
 
 resolveAndGetPaginationParams ()
 
 getPortletDetailsUrl ()
 
 getSavedReportId ()
 
 getNonAjaxRedirectUrl ()
 
 renderRefreshLink ()
 
 getRefreshLinkContainerId ()
 
 getRefreshLinkId ()
 
- Protected Member Functions inherited from View
 resolveDefaultClasses ()
 
 renderContainerWrapperId ()
 
 getContainerWrapperTag ()
 
 getId ()
 
 renderContent ()
 
 getViewStyle ()
 
 renderTitleContent ()
 
 resolveCustomViewTemplateFileName ($theme, $view)
 

Protected Attributes

 $params
 
 $controllerId
 
 $moduleId
 
 $uniqueLayoutId
 
 $viewData
 
- Protected Attributes inherited from View
 $cssClasses = array()
 
 $title
 
 $makeDefaultClassesFromClassHeirarchy = true
 

Additional Inherited Members

Detailed Description

Base class used for wrapping a view of a component used by the report detail view to show results.

Definition at line 40 of file ReportResultsComponentForPortletView.php.

Constructor & Destructor Documentation

__construct (   $viewData,
  $params,
  $uniqueLayoutId 
)

Some extra assertions are made to ensure this view is used in a way that it supports.

Parameters
array$viewData
array$params
string$uniqueLayoutId

Definition at line 107 of file ReportResultsComponentForPortletView.php.

Member Function Documentation

static canUserConfigure ( )
static
Returns
bool

Definition at line 71 of file ReportResultsComponentForPortletView.php.

static getPortletRulesType ( )
static

What kind of PortletRules this view follows

Returns
string PortletRulesType

Implements PortletViewInterface.

Definition at line 80 of file ReportResultsComponentForPortletView.php.

static getModuleClassName ( )
static

The view's module class name.

Returns
string

Implements PortletViewInterface.

Definition at line 89 of file ReportResultsComponentForPortletView.php.

static getPortletDescription ( )
static

Override to add a description for the view to be shown when adding a portlet

Implements PortletViewInterface.

Definition at line 97 of file ReportResultsComponentForPortletView.php.

getTitle ( )
Returns
null

Definition at line 133 of file ReportResultsComponentForPortletView.php.

resolveAndGetPaginationRoute ( )
protected
Returns
string

Definition at line 141 of file ReportResultsComponentForPortletView.php.

resolveAndGetPaginationParams ( )
protected
Returns
array

Definition at line 149 of file ReportResultsComponentForPortletView.php.

getPortletDetailsUrl ( )
protected

After a portlet action is completed, the portlet must be refreshed. This is the url to correctly refresh the portlet content.

Returns
string

Definition at line 159 of file ReportResultsComponentForPortletView.php.

getNonAjaxRedirectUrl ( )
protected

Url to go to after an action is completed. Typically returns user to either a model's detail view or the home page dashboard.

Returns
string

Definition at line 179 of file ReportResultsComponentForPortletView.php.

renderRefreshLink ( )
protected
Returns
string

Definition at line 188 of file ReportResultsComponentForPortletView.php.


The documentation for this class was generated from the following file:
Generated on Tue Jan 28 2020 07:10:40