Class PackedDownloadController

This class implements a mass downloader. It can be used to have the shop retrieve a list of resources (denoted by their URLs) and pack them in a ZIP file. The ZIP file is stored in the cache folder and can then be downloaded.

HttpViewController implements HttpViewControllerInterface

AdminHttpViewController implements AdminStatusOnlyInterface

PackedDownloadController

Package: AdminHttpViewControllers
Category: System
Extends: AdminHttpViewController
Located at Controllers/HttpView/Admin/PackedDownloadController.inc.php

Methods summary

`public`	# `__construct( HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $contentView )` initializes the controller initializes the controller Parameters `$httpContextReader` `$httpResponseProcessor` `$contentView` Overrides `HttpViewController::__construct`
`public JsonHttpControllerResponse`	# `defaultAction( )` Returns an error (JSON-encoded) as this controller does not have a default action Returns an error (JSON-encoded) as this controller does not have a default action Returns `JsonHttpControllerResponse`
`public JsonHttpControllerResponse`	# `actionDownloadByJson( )` Retrieves a number of resources and puts them in a ZIP for later retrieval by the user. Retrieves a number of resources and puts them in a ZIP for later retrieval by the user. Input is a JSON-encoded list (array) of URLs. Response is a JSON object with a downloadKey property (cf. actionDownloadPackage()) or an error message. Returns `JsonHttpControllerResponse`
`public HttpControllerResponse`	# `actionDownloadPackage( )` Download a pack of resources retrieved with actionDownloadByJson() identified by a downloadKey Download a pack of resources retrieved with actionDownloadByJson() identified by a downloadKey Returns `HttpControllerResponse` (empty; download is initiated prior to standard response handling)
`protected string`	# `downloadFile( string $url, string $tmpDir )` Retrieve a file/resource and store in $tmpDir File name is determined from URL. Retrieve a file/resource and store in $tmpDir File name is determined from URL. Parameters `$url` `$tmpDir` Returns string name of retrieved file
`protected downloadKey`	# `packForDownload( string $tmpDir, array $files )` Packs up files in $tmpDir into a ZIP file Packs up files in $tmpDir into a ZIP file Parameters `$tmpDir` `$files` Returns downloadKey
`protected boolean`	# `cleanUp( $tmpDir )` Clean up $tmpDir Clean up $tmpDir Parameters `$tmpDir` Returns boolean
`protected string`	# `makeTmpDir( )` Makes a new tmpDir location Makes a new tmpDir location Returns string full path of tmpDir

Methods inherited from AdminHttpViewController

validateCurrentAdminStatus()

Methods inherited from HttpViewController

_callActionMethod(), _getPostData(), _getPostDataCollection(), _getQueryParameter(), _getQueryParametersCollection(), _render(), _validatePageToken(), actionDefault(), proceed()

Properties summary

Properties inherited from HttpViewController

$assets, $contentView, $httpContextReader, $httpResponseProcessor, $postDataArray, $queryParametersArray

Packages

Classes

Class PackedDownloadController

Methods summary

Parameters

Overrides

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Methods inherited from AdminHttpViewController

Methods inherited from HttpViewController

Properties summary

Properties inherited from HttpViewController