An Inx_Api_Reporting_Control describes a configuration element like the list or mailing chooser.
An Inx_Api_Reporting_Control describes a configuration element like the list or mailing chooser. You can determine which element a Control describes using the getType() method. For a list of all available types, see below. A Control also provides some localized labels and the names of the value bindings, used to set the value of a property. The following snippet shows how to use getProperty($sKey) to acquire the parameter bindings:
$domainParam = $domainControl->getProperty( "bind" ); // $domainControl is of type stringControl $intervalParam = $timeIntervalChooser->getProperty( "intervalBind" ); $countParam = $timeIntervalChooser->getProperty( "countBind" ); $oReportRequest = new Inx_Api_Reporting_ReportRequest( "IncomingMailDetailsForDomain", Inx_Api_Reporting_ReportRequest::OUTPUT_FORMAT_HTML, "de_DE", "Europe/Berlin" ); $oReportRequest->putParameter( $domainParam, "org" ); $oReportRequest->putParameter( $intervalParam, "day" ); $oReportRequest->putParameter( $countParam, "14" );
<u>Supported control types since Inxmail 3.5:</u>
stringControl
This control has following properties:
title - the localized title of the control
bind - the unique parameter key (like "domain"); the value as string (like "com")
timeIntervalChooser
title - the localized title of this control
beginBind - the unique parameter key; the begin date of the interval as number of milliseconds since January 1, 1970, 00:00:00 GMT
endBind - the unique parameter key; the end date of the interval as number of milliseconds since January 1, 1970, 00:00:00 GMT
intervalBind - the unique parameter key; the interval type - hour, day, week and month
countBind - the unique parameter key; the count of intervals
simpleTimeIntervalControl
title - the localized title of this control
clause - the localized title of this control
intervalBind - the unique parameter key; the interval type - hour, day, week and month
countBind - the unique parameter key; the count of intervals
dateSpanControl
title - the localized title of this control
beginBind - the unique parameter key; the begin date of the interval as number of milliseconds since January 1, 1970, 00:00:00 GMT
endBind - the unique parameter key; the end date of the interval as number of milliseconds since January 1, 1970, 00:00:00 GMT
countBind - the unique parameter key; the count of intervals
limitControl
title - the localized title of this control
bind - the unique parameter key (like "limit"); the integer value as string (like "25")
attributeChooser
title - the localized title of this control
bind - the unique parameter key (like "attrid"); the parameter value is the attribute id
listChooser
title - the localized title of this control
bind - the unique parameter key (like "listid"); the parameter value is the list id
mailingChooser
listTitle - the localized title of this control
mailingTitle - the localized title of this control
listBind - the unique parameter key (like "attrid"); the parameter value is the attribute id
mailingBind - the unique parameter key (like "listid"); the parameter value is the list id
checkboxControl
title - the localized title of this control
bind - the unique parameter key (like "enabled1"); the valid values are "true" and "false"
For more information on the report configuration in general, see the Inx_Api_Reporting_ConfigDescriptor documentation.
Located in /Api/Reporting/Control.php (line 89)
Returns the value to which this control maps the specified key.
Returns the value to which this control maps the specified key. The control contains localized titles and parameter bindings.
Returns an array of the keys contained in this control.
Returns an array of the keys contained in this control.
Returns the type of this control.
Returns the type of this control. The supported types are:
Documentation generated on Thu, 17 Sep 2015 14:27:23 +0200 by phpDocumentor 1.3.2