PHP Class Piwik\Plugins\ScheduledReports\ScheduledReports

Inheritance: extends Piwik\Plugin
Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method Description
allowMultipleReports ( &$allowMultipleReports, $reportType )
deletePhoneNumber ( $phoneNumber )
deleteSiteReport ( $idSite ) Delete reports for the website
deleteUserReport ( $userLogin )
deleteUserReportForSites ( $userLogin, $idSites )
getClientSideTranslationKeys ( &$translationKeys )
getDisplayFormats ( )
getJsFiles ( &$jsFiles )
getPeriodToFrequency ( ) Used in the Report Listing
getPeriodToFrequencyAsAdjective ( ) Used in the Report's email content, ie "monthly report"
getRendererInstance ( &$reportRenderer, $reportType, $outputType, $report )
getReportFormats ( &$reportFormats, $reportType )
getReportMetadata ( &$reportMetadata, $reportType, $idSite )
getReportParameters ( &$availableParameters, $reportType )
getReportRecipients ( &$recipients, $reportType, $report )
getReportTypes ( &$reportTypes )
getStylesheetFiles ( &$stylesheets )
install ( )
processReports ( &$processedReports, $reportType, $outputType, $report )
registerEvents ( )
renameDeprecatedModuleAndAction ( &$module, &$action )
segmentDeactivation ( $idSegment )
segmentUpdated ( $idSegment, $updatedSegment )
sendReport ( $reportType, $report, $contents, $filename, $prettyDate, $reportSubject, $reportTitle, $additionalFiles, Piwik\Period $period = null, $force )
template_reportParametersScheduledReports ( &$out )
validateReportParameters ( &$parameters, $reportType )

Protected Methods

Method Description
setReplyToAsSender ( Piwik\Mail $mail, array $report )
throwExceptionReportsAreUsingSegment ( $reportsUsingSegment )

Private Methods

Method Description
checkAdditionalEmails ( $additionalEmails )
getModel ( )
manageEvent ( $reportType )
markReportAsSent ( $report, Piwik\Period $period )
reportAlreadySent ( $report, Piwik\Period $period )
valueIsTrue ( $value ) based on http://www.php.net/manual/en/filter.filters.validate.php -> FILTER_VALIDATE_BOOLEAN

Method Details

allowMultipleReports() public method

public allowMultipleReports ( &$allowMultipleReports, $reportType )

deletePhoneNumber() public method

public deletePhoneNumber ( $phoneNumber )

deleteSiteReport() public method

Delete reports for the website
public deleteSiteReport ( $idSite )

deleteUserReport() public method

public deleteUserReport ( $userLogin )

deleteUserReportForSites() public method

public deleteUserReportForSites ( $userLogin, $idSites )

getClientSideTranslationKeys() public method

public getClientSideTranslationKeys ( &$translationKeys )

getDisplayFormats() public static method

public static getDisplayFormats ( )

getJsFiles() public method

public getJsFiles ( &$jsFiles )

getPeriodToFrequency() public static method

Used in the Report Listing
public static getPeriodToFrequency ( )

getPeriodToFrequencyAsAdjective() public static method

Used in the Report's email content, ie "monthly report"

getRendererInstance() public method

public getRendererInstance ( &$reportRenderer, $reportType, $outputType, $report )

getReportFormats() public method

public getReportFormats ( &$reportFormats, $reportType )

getReportMetadata() public method

public getReportMetadata ( &$reportMetadata, $reportType, $idSite )

getReportParameters() public method

public getReportParameters ( &$availableParameters, $reportType )

getReportRecipients() public method

public getReportRecipients ( &$recipients, $reportType, $report )

getReportTypes() public method

public getReportTypes ( &$reportTypes )

getStylesheetFiles() public method

public getStylesheetFiles ( &$stylesheets )

install() public method

public install ( )

processReports() public method

public processReports ( &$processedReports, $reportType, $outputType, $report )

registerEvents() public method

See also: Piwik\Plugin::registerEvents
public registerEvents ( )

renameDeprecatedModuleAndAction() public method

public renameDeprecatedModuleAndAction ( &$module, &$action )

segmentDeactivation() public method

public segmentDeactivation ( $idSegment )

segmentUpdated() public method

public segmentUpdated ( $idSegment, $updatedSegment )

sendReport() public method

public sendReport ( $reportType, $report, $contents, $filename, $prettyDate, $reportSubject, $reportTitle, $additionalFiles, Piwik\Period $period = null, $force )
$period Piwik\Period

setReplyToAsSender() protected method

protected setReplyToAsSender ( Piwik\Mail $mail, array $report )
$mail Piwik\Mail
$report array

template_reportParametersScheduledReports() public static method

throwExceptionReportsAreUsingSegment() protected method

protected throwExceptionReportsAreUsingSegment ( $reportsUsingSegment )
$reportsUsingSegment

validateReportParameters() public method

public validateReportParameters ( &$parameters, $reportType )