Report Class Reference

Public Member Functions

 __toString ()
 canCurrentUserProperlyRenderResults ()
 getModuleClassName ()
 setModuleClassName ($moduleClassName)
 getDescription ()
 setDescription ($description)
 setFiltersStructure ($filtersStructure)
 getFiltersStructure ()
 getId ()
 setId ($id)
 getName ()
 setName ($name)
 getType ()
 setType ($type)
 getCurrencyConversionType ()
 setCurrencyConversionType ($currencyConversionType)
 getSpotConversionCurrencyCode ()
 setSpotConversionCurrencyCode ($spotConversionCurrencyCode)
 getFromBaseToSpotRate ()
 isNew ()
 getOwner ()
 setOwner (User $owner)
 getFilters ()
 addFilter (FilterForReportForm $filter)
 removeAllFilters ()
 removeRuntimeFilters ()
 getGroupBys ()
 addGroupBy (GroupByForReportForm $groupBy)
 removeAllGroupBys ()
 getOrderBys ()
 addOrderBy (OrderByForReportForm $orderBy)
 removeAllOrderBys ()
 getDisplayAttributes ()
 addDisplayAttribute (DisplayAttributeForReportForm $displayAttribute)
 removeAllDisplayAttributes ()
 getDrillDownDisplayAttributes ()
 addDrillDownDisplayAttribute (DrillDownDisplayAttributeForReportForm $drillDownDisplayAttribute)
 removeAllDrillDownDisplayAttributes ()
 getChart ()
 setChart (ChartForReportForm $chart)
 hasChart ()
 getExplicitReadWriteModelPermissions ()
 setExplicitReadWriteModelPermissions (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 hasRuntimeFilters ()
 getDisplayAttributeIndex ($attribute)
 getDisplayAttributeByAttribute ($attribute)
 resolveGroupBysAsFilters (Array $getData)

Static Public Member Functions

static getTypeDropDownArray ()
static getReportableModulesAndLabelsForCurrentUser ()
static getReportableModulesClassNamesCurrentUserHasAccessTo ()

Data Fields

const TYPE_ROWS_AND_COLUMNS = 'RowsAndColumns'
const TYPE_SUMMATION = 'Summation'
const TYPE_MATRIX = 'Matrix'
const CURRENCY_CONVERSION_TYPE_ACTUAL = 1
const CURRENCY_CONVERSION_TYPE_BASE = 2
const CURRENCY_CONVERSION_TYPE_SPOT = 3

Static Protected Member Functions

static resolveGroupByAsFilterValue ($value, FilterForReportForm $filter)

Detailed Description

Class for interacting with Report definitions. Gets information from either a SavedReport or via a POST. Contains information about how a report should be constructed including how it looks in the user interface when run. The components of a report are filters, orderBys, groupBys, displayAttributes, drillDownDisplayAttributes, and a chart.

There are 3 different types of reports: TYPE_ROWS_AND_COLUMNS, TYPE_SUMMATION, and TYPE_MATRIX. Only Summation utilizes a chart and can have drillDownDisplayAttributes

Definition at line 46 of file Report.php.


Member Function Documentation

static getTypeDropDownArray (  )  [static]
Returns:
array of report type values and labels

Definition at line 185 of file Report.php.

static getReportableModulesAndLabelsForCurrentUser (  )  [static]

Based on the current user, return the reportable modules and their display labels. Only include modules that the user has a right to access.

Returns:
array of module class names and display labels.

Definition at line 197 of file Report.php.

static getReportableModulesClassNamesCurrentUserHasAccessTo (  )  [static]
Returns:
array of module class names and display labels the current user has access to

Definition at line 222 of file Report.php.

canCurrentUserProperlyRenderResults (  ) 

Returns true if the current user can render a report's results properly. This method checks to see if the user has full access to all the related modules and data that the report uses in construction. This method is needed because it is possible the author of a report added access for users that do not have complete rights to the modules that are part of the report. It is also possible this access changed over time and a report that was once properly rendered is no longer.

Returns:
bool

Definition at line 256 of file Report.php.

getModuleClassName (  ) 
Returns:
string

Definition at line 288 of file Report.php.

setModuleClassName ( moduleClassName  ) 
Parameters:
$moduleClassName string

Definition at line 296 of file Report.php.

getDescription (  ) 
Returns:
string

Definition at line 305 of file Report.php.

setDescription ( description  ) 
Parameters:
$description 

Definition at line 313 of file Report.php.

setFiltersStructure ( filtersStructure  ) 
Parameters:
$filtersStructure string

Definition at line 322 of file Report.php.

getFiltersStructure (  ) 
Returns:
array of FilterForReportForm objects

Definition at line 331 of file Report.php.

getId (  ) 
Returns:
int

Definition at line 339 of file Report.php.

setId ( id  ) 
Parameters:
$id int

Definition at line 347 of file Report.php.

getName (  ) 
Returns:
string

Definition at line 356 of file Report.php.

setName ( name  ) 
Parameters:
$name string

Definition at line 364 of file Report.php.

getType (  ) 
Returns:
string

Definition at line 373 of file Report.php.

setType ( type  ) 
Parameters:
$type string

Definition at line 381 of file Report.php.

getCurrencyConversionType (  ) 
Returns:
int

Definition at line 390 of file Report.php.

setCurrencyConversionType ( currencyConversionType  ) 
Parameters:
$currencyConversionType int

Definition at line 398 of file Report.php.

getSpotConversionCurrencyCode (  ) 
Returns:
string

Definition at line 407 of file Report.php.

setSpotConversionCurrencyCode ( spotConversionCurrencyCode  ) 
Parameters:
$spotConversionCurrencyCode string

Definition at line 415 of file Report.php.

getFromBaseToSpotRate (  ) 
Returns:
float

Definition at line 424 of file Report.php.

isNew (  ) 
Returns:
bool

Definition at line 432 of file Report.php.

getOwner (  ) 
Returns:
object

Definition at line 444 of file Report.php.

setOwner ( User owner  ) 
Parameters:
User $owner

Definition at line 456 of file Report.php.

getFilters (  ) 
Returns:
array of FilterForReportForm objects

Definition at line 464 of file Report.php.

addFilter ( FilterForReportForm filter  ) 
Parameters:
FilterForReportForm $filter

Definition at line 472 of file Report.php.

removeAllFilters (  ) 

Removes all FilterForReportForm objects on this report

Definition at line 480 of file Report.php.

removeRuntimeFilters (  ) 

Removes all Runtime FilterForReportForm objects on this report

Definition at line 488 of file Report.php.

getGroupBys (  ) 
Returns:
array of GroupByForReportForm objects

Definition at line 504 of file Report.php.

addGroupBy ( GroupByForReportForm groupBy  ) 
Parameters:
GroupByForReportForm $groupBy

Definition at line 512 of file Report.php.

removeAllGroupBys (  ) 

Removes all GroupByForReportForm objects on this report

Definition at line 520 of file Report.php.

getOrderBys (  ) 
Returns:
array of OrderByForReportForm objects

Definition at line 528 of file Report.php.

addOrderBy ( OrderByForReportForm orderBy  ) 
Parameters:
OrderByForReportForm $orderBy

Definition at line 536 of file Report.php.

removeAllOrderBys (  ) 

Removes all OrderByForReportForm objects on this report

Definition at line 544 of file Report.php.

getDisplayAttributes (  ) 
Returns:
array of DisplayAttributeForReportForm objects

Definition at line 552 of file Report.php.

addDisplayAttribute ( DisplayAttributeForReportForm displayAttribute  ) 
Parameters:
DisplayAttributeForReportForm $displayAttribute

Definition at line 560 of file Report.php.

removeAllDisplayAttributes (  ) 

Removes all DisplayAttributeForReportForm objects on this report

Definition at line 568 of file Report.php.

getDrillDownDisplayAttributes (  ) 
Returns:
array of DrillDownDisplayAttributeForReportForm objects

Definition at line 576 of file Report.php.

addDrillDownDisplayAttribute ( DrillDownDisplayAttributeForReportForm drillDownDisplayAttribute  ) 
Parameters:
DrillDownDisplayAttributeForReportForm $drillDownDisplayAttribute

Definition at line 584 of file Report.php.

removeAllDrillDownDisplayAttributes (  ) 

Removes all DrillDownDisplayAttributeForReportForm objects on this report

Definition at line 592 of file Report.php.

getChart (  ) 
Returns:
ChartForReportForm|object

Definition at line 600 of file Report.php.

setChart ( ChartForReportForm chart  ) 
Parameters:
ChartForReportForm $chart

Definition at line 612 of file Report.php.

hasChart (  ) 

Returns true if the report has a chart

Returns:
bool

Definition at line 621 of file Report.php.

getExplicitReadWriteModelPermissions (  ) 
Returns:
ExplicitReadWriteModelPermissions|object

Definition at line 633 of file Report.php.

setExplicitReadWriteModelPermissions ( ExplicitReadWriteModelPermissions explicitReadWriteModelPermissions  ) 

Set from the value in the SavedReport

Parameters:
ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions

Definition at line 646 of file Report.php.

hasRuntimeFilters (  ) 

Returns true if at least one filter is available at runtime.

Returns:
bool

Definition at line 655 of file Report.php.

getDisplayAttributeIndex ( attribute  ) 

Given an attributeIndexOrDerivedType, return the key of the $displayAttributes that corresponds to the DisplayAttributeForReportForm object that has the given attribute

Parameters:
$attribute 
Returns:
int|null|string

Definition at line 673 of file Report.php.

getDisplayAttributeByAttribute ( attribute  ) 

Given an attributeIndexOrDerivedType, return the DisplayAttributeForReportForm object that has that attributeIndexOrDerivedType

Parameters:
$attribute 
Returns:
mixed
Exceptions:
NotFoundException if it is not found

Definition at line 692 of file Report.php.

resolveGroupBysAsFilters ( Array $  getData  ) 

Utilized for summation with drill down rows. For a given group, the grouped value needs to be used as a filter for the drilled down row. This method will add that groupBy as a filter and update the filterStructure accordingly.

Parameters:
array $getData

Definition at line 710 of file Report.php.

static resolveGroupByAsFilterValue ( value,
FilterForReportForm filter 
) [static, protected]

Given a value and a filter, resolve the value for being null or not. If null then a different operator is used on the value than if it is not null.

Parameters:
$value 
FilterForReportForm $filter

Definition at line 754 of file Report.php.


Field Documentation

const TYPE_ROWS_AND_COLUMNS = 'RowsAndColumns'

Defines a report type of Rows and Columns. This is the basic report type and isa simple list result

Definition at line 51 of file Report.php.

const TYPE_SUMMATION = 'Summation'

Defines a report type of Summation. A summation report can group data into a result grid. It can also have a chart and also allow for drill down into each row to get further information about each group

Definition at line 57 of file Report.php.

const TYPE_MATRIX = 'Matrix'

Defines a report type of Matrix. Complex report type that allows multiple groupings across both the x and y axises.

Definition at line 63 of file Report.php.

Currency Conversion Type for rendering currency information. "Actual" means the currency will not be converted to the base or a spot currency. It can produce mixed results depending on how the data is being aggregated for a report.

Definition at line 70 of file Report.php.

Currency Conversion Type for rendering currency information. "Base" means that currency data is converted into the system base currency and displayed in this currency

Definition at line 76 of file Report.php.

Currency Conversion Type for rendering currency information. "Spot" means the currency is converted into the base currency and then converted into a spot currency defined by the user when creating the report

Definition at line 82 of file Report.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Nov 17 07:10:28 2017