Documentation

ExportDownload
in package
implements ActionInterface uses ActionTrait

Downloads exported profile data file.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$dltoken  : string
$export_dir_slash  : string
$extension  : string
$idhash  : string
$part  : int
$path  : string
$progressfile  : string
$obj  : static

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
execute()  : void
Does the job.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
load()  : static
Static wrapper for constructor.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().
buildFilename()  : string
Figure out the filename we'll tell the browser.

Properties

$dltoken

public string $dltoken

Unique download token for the member whose profile this is.

$export_dir_slash

public string $export_dir_slash

Path to the exports directory, with a trailing slash.

$extension

public string $extension

File extension for the downloadable file.

$idhash

public string $idhash

Unique hash to anonymously identify the member whose profile this is.

$part

public int $part

The requested part of the overall export.

$path

public string $path

Path to the requested export file on disk.

$progressfile

public string $progressfile

Path to the JSON file that tracks our progress exporting this profile.

$obj

protected static static $obj

An instance of this class. This is used by the load() method to prevent multiple instantiations.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed

buildFilename()

Figure out the filename we'll tell the browser.

protected buildFilename() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results