LimeSurvey API - Master branch

FileFetcher
in package

AbstractYes

Fetch files for the ExtensionInstaller to install.

Fetching files can happen in different ways:

  • Upload ZIP
  • wget ZIP from a URL
  • Enter git repo
  • Etc. Each method is its own subclass of this class. Each extension type can support a number of different file fetch methods.
Tags
since
2018-09-24
author

LimeSurvey GmbH

Table of Contents

Methods

abort()  : void
Abort procedure, remove temporary files.
fetch()  : void
Move files from source to tmp/ folder.
getConfig()  : ExtensionConfig
move()  : bool
Move files from tmp/ folder to final destination.
setSource()  : void
Set source for this file fetcher.

Methods

abort()

Abort procedure, remove temporary files.

public abstract abort() : void

fetch()

Move files from source to tmp/ folder.

public abstract fetch() : void

move()

Move files from tmp/ folder to final destination.

public abstract move(string $destdir) : bool
Parameters
$destdir : string
Return values
bool

setSource()

Set source for this file fetcher.

public abstract setSource(string $source) : void

Can be ZIP file name, git repo URL, folder name, etc.

Parameters
$source : string

        
On this page

Search results