The Inx_Api_Reporting_ReportRequest describes a report to be generated.
The Inx_Api_Reporting_ReportRequest describes a report to be generated. To generate a report, you first need to create a ReportRequest which contains the relevant information needed to generate the report:
To specify dates, like the begin or end date of a report, use putParameter() and specify the number of milliseconds since the epoch. To do so, use the strtotime() function. The following snippet shows how to specify an end date one week ago:
//strtotime returns the seconds since the epoch -> * 1000 $iOneWeekAgo = strtotime("-1 week") * 1000; $oReportRequest = ... $oReportRequest->putParameter("end", $iOneWeekAgo);To pass a specific date, use the english date format (YYYY-MM-DD HH:MM:SS). The following snippet shows how to specify the begin date 2000-01-01 00:00:
//strtotime returns the seconds since the epoch -> * 1000 $iMillennium = strtotime("2000-01-01 00:00") * 1000; $oReportRequest = ... $oReportRequest->putParameter("begin", $iMillennium);
Please note: some reports require you to specify the type of the mailing for which the report is built. To specify this mailing type, use the putMailingTypeParameter($sKey, $oMailingType) method which accepts Inx_Api_Reporting_ReportMailingTypes. To find out which reports expect a mailing type parameter, take a look at the reports reference in the Inxmail Professional API Developer Guide.
For an example on how to retrieve a report, see the Inx_Api_Reporting_ReportEngine documentation.
Located in /Api/Reporting/ReportRequest.php (line 58)
Creates a new report request object for the report specified by the given name.
Creates a new report request object for the report specified by the given name. The report will be generated in the given output format, using the specified locale and time zone.
Returns the output format of the report.
Returns the output format of the report. May be one of:
Returns the output locale of the report.
Returns the output locale of the report. Use the name of the locale, with the language (defined by ISO-639) or the language and country (defined by ISO-3166) separated by an underscore. For example: "de", "de_CH", "en", "en_GB", "it", "fr"
Returns the output time zone of the report.
Returns the output time zone of the report. Use Inx_Api_Reporting_ReportEngine::getSupportedTimeZones() to find out which time zones are supported. For example: "Europe/Berlin", "Europe/Rome", "America/New_York"
Returns the value to which this Inx_Api_Reportin_ReportRequest maps the specified key.
Returns the value to which this Inx_Api_Reportin_ReportRequest maps the specified key. Returns null if this report request contains no mapping for this key.
Returns an array of the keys contained in this report request.
Returns an array of the keys contained in this report request.
Returns the name of the report to generate.
Returns the name of the report to generate.
Associates the specified value with the specified key in this report request. specify the type of the mailing the report concerns.
Associates the specified value with the specified key in this report request. This method should be used to specify the type of the mailing the report concerns.
Associates the specified value with the specified key in this report request.
Associates the specified value with the specified key in this report request. For an example on how to specify dates, see the documentation of this class.
Output format: Character Separated Values (CSV)
Output format: Character Separated Values (CSV)
Output format: HTML
Output format: HTML
Output format: HTML with inxmail special hyperlinks
Output format: HTML with inxmail special hyperlinks
Output format: PDF on A4 page size
Output format: PDF on A4 page size
Output format: PDF on US-Legal page size
Output format: PDF on US-Legal page size
Output format: PDF on US-Letter page size
Output format: PDF on US-Letter page size
Documentation generated on Thu, 17 Sep 2015 14:27:29 +0200 by phpDocumentor 1.3.2