Interface Inx_Api_Reporting_ConfigDescriptor

Description

Every report type has a configuration descriptor.

Every report type has a configuration descriptor. The Inx_Api_Reporting_ConfigDescriptor describes the structure and elements of the report configuration area. A ConfigDescriptor contains a set of Inx_Api_Reporting_ControlUnits (mostly zero or one) which in turn contain a set of Inx_Api_Reporting_Controls. An Inx_Api_Reporting_Control describes a configuration element like the list or mailing chooser. The following snippet shows how to print out the content of the ConfigurationDescriptor for the ClickReactionTimeResponse report:

 $oReportEngine = $oSession->getReportEngine();
 $oConfigDescriptor = $oReportEngine->getDescriptor( "ClickReactionTimeResponse", "en_GB" );

 echo "<pre>";
 echo "Localized Report Title: ".$oConfigDescriptor->getTitle()."<br><br>";

 for( $i = 0; $i < $oConfigDescriptor->getControlUnitCount(); $i++ )
 {
 	echo "Control Unit #".$i.":<br>";
 	$oControlUnit = $oConfigDescriptor->getControlUnit( $i );

 	echo "Localized control title: ".$oControlUnit->getTitle()."<br>";

 	for( $j = 0; $j < $oControlUnit->getControlCount(); $j++ )
 	{
 		$oControl = $oControlUnit->getControl( $j );

 		echo "	Control #".$j.":<br>";
 		echo "	Control type: ".$oControl->getType()."<br>";

 		foreach( $oControl->getPropertyKeys() as $sKey )
 		{
 			echo "		Key: ".$sKey." - Value: ".$oControl->getProperty( $sKey )."<br>";
 		}
 	}
 }

 echo "</pre>";
This snippet will produce the following output:
 Localized Report Title: Clicks over time

 Control Unit #0:
 Localized control title: Settings
 	Control #0:
 	Control type: mailingChooser
 		Key: listTitle - Value: Mailing list:
 		Key: mailingTitle - Value: Mailing:
 		Key: listBind - Value: listid
 		Key: mailingBind - Value: mailingid
 	Control #1:
 	Control type: simpleTimeIntervalControl
 		Key: title - Value: Report time period:
 		Key: countBind - Value: count
 		Key: intervalBind - Value: interval
 		Key: clause - Value: until today

For more information on controls, see the Inx_Api_Reporting_Control documentation.

Located in /Api/Reporting/ConfigDescriptor.php (line 79)


	
			
Method Summary
Methods
getControlUnit (line 96)

Returns the Inx_Api_Reporting_ControlUnit at the specified position.

Returns the Inx_Api_Reporting_ControlUnit at the specified position.

  • return: the control unit at the specified position.
  • access: public
Inx_Api_Reporting_ControlUnit getControlUnit (int $iIndex)
  • int $iIndex: the index of the control unit to return.
getControlUnitCount (line 104)

Returns the number of Inx_Api_Reporting_ControlUnits.

Returns the number of Inx_Api_Reporting_ControlUnits.

  • return: the number of control units.
  • access: public
int getControlUnitCount ()
getTitle (line 87)

Returns the localized title of this report.

Returns the localized title of this report.

  • return: the localized title of this report.
  • access: public
string getTitle ()

Documentation generated on Thu, 17 Sep 2015 14:27:23 +0200 by phpDocumentor 1.3.2