• 홈
• Piwik
• Plugins
• ScheduledReports
• API

PHP 클래스 Piwik\Plugins\ScheduledReports\API

"generateReport" will generate the requested report (for a specific date range, website and in the requested language). "sendEmailReport" will send the report by email to the recipients specified for this report. You can also get the list of all existing reports via "getReports", create new reports via "addReport", or manage existing reports with "updateReport" and "deleteReport". See also the documentation about Scheduled Email reports in Piwik. 파일 보기 프로젝트 열기: piwik/piwik 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$cache		static cache storing reports

공개 메소드들

메소드	설명
__construct ( Psr\Log\LoggerInterface $logger )
addReport ( integer $idSite, string $description, string $period, integer $hour, string $reportType, string $reportFormat, array $reports, array $parameters, boolean | integer $idSegment = false ) : integer	Creates a new report and schedules it.
allowMultipleReports ( $reportType )
deleteReport ( integer $idReport )	Deletes a specific report
generateReport ( integer $idReport, string $date, boolean | false | string $language = false, boolean | false | integer $outputType = false, boolean | false | string $period = false, boolean | false | string $reportFormat = false, boolean | false | array $parameters = false ) : array | void	Generates a report file.
getReportFormats ( $reportType )
getReportMetadata ( $idSite, $reportType )
getReportRecipients ( $report )
getReportTypes ( )
getReports ( boolean | integer $idSite = false, boolean | string $period = false, boolean | integer $idReport = false, boolean $ifSuperUserReturnOnlySuperUserReports = false, boolean | integer $idSegment = false ) : array	Returns the list of reports matching the passed parameters
getSegment ( $idSegment )
isSegmentEditorActivated ( )
sendReport ( $idReport, $period = false, $date = false, $force = false )
updateReport ( $idReport, $idSite, $description, $period, $hour, $reportType, $reportFormat, $reports, $parameters, $idSegment = false )	Updates an existing report.

비공개 메소드들

메소드	설명
checkUserHasViewPermission ( $login, $idSite )
ensureLanguageSetForUser ( $currentUser )
getAttachments ( $reportRenderer, $report, $processedReports, $prettyDate )
getModel ( )
getReportSubjectAndReportTitle ( $websiteName, $reports )
validateAndTruncateDescription ( &$description )
validateCommonReportAttributes ( $period, $hour, &$description, &$idSegment, $reportType, $reportFormat )
validateIdSegment ( &$idSegment )
validateReportFormat ( $reportType, $reportFormat )
validateReportHour ( $hour )
validateReportParameters ( $reportType, $parameters )
validateReportPeriod ( $period )
validateReportType ( $reportType )
validateRequestedReports ( $idSite, $reportType, $requestedReports )

메소드 상세

프로퍼티 상세