Elgg  Version master
Protected Member Functions | List of all members
Elgg\Controllers\JsonDownloadAction Class Reference

Helper class for JSON download actions. More...

Inheritance diagram for Elgg\Controllers\JsonDownloadAction:
Elgg\Controllers\DownloadAction Elgg\Controllers\GenericAction

Protected Member Functions

 getFilename ()
 {File name for download.
Returns
string
} More...
 
 getMimeType ()
 {Return the content mimetype for the Content-Type header.
Returns
string
} More...
 
 success ()
 {{Will be used when an action is successfully finished.
Returns
OkResponse
}} More...
 
- Protected Member Functions inherited from Elgg\Controllers\DownloadAction
 getContents ()
 File contents. More...
 
 getHeaders ()
 Returns headers for download response. More...
 
- Protected Member Functions inherited from Elgg\Controllers\GenericAction
 sanitize ()
 Sanitizes input for the action. More...
 
 validate ()
 Validates the action. More...
 
 executeBefore ()
 Preparation before executing the action. More...
 
 execute ()
 Main part of the action. More...
 
 executeAfter ()
 Action part after the main execution. More...
 
 error (string $message)
 Will be used when something wrong happened during the handling of the action. More...
 

Additional Inherited Members

- Public Member Functions inherited from Elgg\Controllers\GenericAction
 __invoke (\Elgg\Request $request)
 Invoke the action steps. More...
 
- Protected Attributes inherited from Elgg\Controllers\GenericAction
Elgg Request $request
 

Detailed Description

Helper class for JSON download actions.

Since
7.0

Definition at line 12 of file JsonDownloadAction.php.

Member Function Documentation

◆ getFilename()

Elgg\Controllers\JsonDownloadAction::getFilename ( )
protected

{File name for download.

Returns
string
}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 17 of file JsonDownloadAction.php.

◆ getMimeType()

Elgg\Controllers\JsonDownloadAction::getMimeType ( )
protected

{Return the content mimetype for the Content-Type header.

Returns
string
}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 24 of file JsonDownloadAction.php.

◆ success()

Elgg\Controllers\JsonDownloadAction::success ( )
protected

{{Will be used when an action is successfully finished.

Returns
OkResponse
}}

Reimplemented from Elgg\Controllers\DownloadAction.

Definition at line 31 of file JsonDownloadAction.php.


The documentation for this class was generated from the following file: