Documentation

CRM_Report_OutputHandler_Csv extends OutputHandlerBase

in package

• Application

implements OutputHandlerInterface

CSV Report Output Handler

Table of Contents

Interfaces

OutputHandlerInterface

Properties

$form  : CRM_Report_Form

This is for convenience since otherwise several functions would take it as a parameter.

Methods

download()  : mixed

Set headers as appropriate and send the output to the browser.

getCharset()  : string

Charset of the attachment.

getFileName()  : string

Return the download filename. This should be the "clean" name, not a munged temporary filename.

getForm()  : CRM_Report_Form

Getter for $form

getMailBody()  : string

Return the html body of the email.

getMimeType()  : string

Mime type of the attachment.

getOutputString()  : string

Return the report contents as a string, in this case the csv output.

isAbsoluteUrl()  : bool

Create absolute urls for links. Generally for a handler this is always set to TRUE, but for example for 'print' it's displayed on the site so it can be relative.

isAddPaging()  : bool

Use a pager, but for a handler this would be FALSE since paging is a UI element.

isOutputHandlerFor()  : bool

Are we a suitable output handler based on the given form?

isPrintOnly()  : bool

Hide/show various elements in the output, but generally for a handler this is always set to TRUE.

setForm()  : mixed

Setter for $form