Documentation

OutputHandlerInterface
in

Table of Contents

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.
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.

Methods

download()

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

public download() : mixed

getCharset()

Charset of the attachment.

public getCharset() : string

The default of '' means charset is not specified in the mimepart, which is normal for binary attachments, but for text attachments you should specify something like 'utf-8'.

Return values
string

getFileName()

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

public getFileName() : string
Return values
string

getMailBody()

Return the html body of the email.

public getMailBody() : string
Return values
string

getOutputString()

Return the report contents as a string.

public getOutputString() : string
Return values
string

isAbsoluteUrl()

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.

public isAbsoluteUrl() : bool
Tags
todo

Couldn't it just always be absolute?

Return values
bool

isAddPaging()

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

public isAddPaging() : bool
Return values
bool

isOutputHandlerFor()

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

public isOutputHandlerFor(CRM_Report_Form $form) : bool

The class member $form isn't set yet at this point since we don't even know if we're in play yet, so the form is a parameter.

Parameters
$form : CRM_Report_Form
Return values
bool

isPrintOnly()

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

public isPrintOnly() : bool
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results