FileSharingLib
in package
AbstractYes
FileSharingLib
Tags
Table of Contents
Methods
- cleanUp() : mixed
- clean up the database and shared files deletes expired files and none existing files
- createCheck() : string
- create check code
- createHash() : string
- create the hash code
- getDeleteLink() : string
- getDownloadLink() : string
- getTemporaryFilePaths() : array<string|int, mixed>
- isShared() : bool
- sendMailById() : mixed
- Send an email about a shared file
- sendMailByUploadId() : mixed
- Send an email about the newly uploaded files
- initUploader() : int
- Init the uploader which is directly included in the webpage
- sendMail() : mixed
- Send an email about shared files
Methods
cleanUp()
clean up the database and shared files deletes expired files and none existing files
public
static cleanUp() : mixed
Tags
createCheck()
create check code
public
static createCheck(string $hash) : string
Parameters
- $hash : string
-
the hash of the file
Tags
Return values
string —the check code
createHash()
create the hash code
public
static createHash() : string
Tags
Return values
string —the hash code
getDeleteLink()
public
static getDeleteLink(int $fileId) : string
Parameters
- $fileId : int
Tags
Return values
string —the download link
getDownloadLink()
public
static getDownloadLink(int $fileId) : string
Parameters
- $fileId : int
Tags
Return values
string —the download link
getTemporaryFilePaths()
public
static getTemporaryFilePaths(int $uploadId) : array<string|int, mixed>
Parameters
- $uploadId : int
-
the upload id of the active upload
Return values
array<string|int, mixed>isShared()
public
static isShared([int $fileId = null ][, mixed $fileSource = null ]) : bool
Parameters
- $fileId : int = null
-
file id
- $fileSource : mixed = null
Tags
Return values
bool —is shared or not
sendMailById()
Send an email about a shared file
public
static sendMailById(int $id, string $subject, array<string|int, mixed> $emails[, string $message = '' ]) : mixed
Parameters
- $id : int
-
The ID of a shared file
- $subject : string
-
The subject of the mail
- $emails : array<string|int, mixed>
- $message : string = ''
-
The message for the recipient
sendMailByUploadId()
Send an email about the newly uploaded files
public
static sendMailByUploadId(string $uploadId, string $subject, array<string|int, mixed> $emails[, string $message = '' ]) : mixed
Parameters
- $uploadId : string
-
The upload ID (from Uploader::generateId())
- $subject : string
-
The subject of the mail
- $emails : array<string|int, mixed>
- $message : string = ''
-
The message for the recipient
initUploader()
Init the uploader which is directly included in the webpage
protected
initUploader() : int
Return values
int —the uploader id
sendMail()
Send an email about shared files
protected
static sendMail(array<string|int, mixed> $files, string $subject, array<string|int, mixed> $emails, string $message) : mixed
Parameters
- $files : array<string|int, mixed>
-
IDs of shared files to list in the email
- $subject : string
-
The subject of the mail for the recipient
- $emails : array<string|int, mixed>
- $message : string
-
The message for the recipient