Documentation

EasyBlogTableDownload extends EasyBlogTable
in package

Table of Contents

Properties

$created  : mixed
$id  : mixed
$params  : mixed
$state  : mixed
$userid  : mixed
$_supportNullValue  : mixed

Methods

__construct()  : mixed
Constructor for this class.
bind()  : mixed
Bind the table properties
delete()  : mixed
Override parent delete method to manually delete archive file as well.
exists()  : mixed
Determine whether user has requested.
getDBO()  : mixed
Retrieves the database object
getDownloadLink()  : mixed
Method generate the download link of this request
getInstance()  : mixed
Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.
getParams()  : mixed
Generic method to retrive raw json params from the table
getRequester()  : mixed
Retrieves the requester
getState()  : mixed
Request state of the download. Return false if not exist.
getStateLabel()  : mixed
Retrieves the label for the state (used for display purposes)
getTitle()  : mixed
Retrieves the translated title
isNew()  : mixed
Determine when the state is ready
isProcessing()  : mixed
Determine when the state is ready
isReady()  : mixed
Determine when the state is ready
reset()  : void
Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.
sendNotification()  : mixed
Method used to send email notification to user who requested to download GDPR details.
setFilePath()  : mixed
Method used to set filepath.
showArchiveDownload()  : mixed
Method to ouput the zip file to browser for download.
store()  : mixed
On Joomla 4, if table object contains array or objects, storing is problematic unlike Joomla 3.
toArray()  : mixed
Converts a table layer into an array
updateState()  : mixed
Method used to update the request state.

Properties

$_supportNullValue

protected mixed $_supportNullValue = true

Methods

__construct()

Constructor for this class.

public __construct(mixed &$db) : mixed
Parameters
$db : mixed
Tags
since
5.2
access

public

bind()

Bind the table properties

public bind(mixed $src[, mixed $ignore = [] ]) : mixed
Parameters
$src : mixed
$ignore : mixed = []
Tags
since
1.1.0
access

public

delete()

Override parent delete method to manually delete archive file as well.

public delete([mixed $pk = null ]) : mixed
Parameters
$pk : mixed = null
Tags
since
5.2
access

public

exists()

Determine whether user has requested.

public exists() : mixed
Tags
since
5.2
access

public

getDBO()

Retrieves the database object

public getDBO() : mixed
Tags
since
6.0.0
access

public

Method generate the download link of this request

public getDownloadLink() : mixed
Tags
since
5.2
access

public

getInstance()

Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.

public static getInstance(string $type[, string $prefix = 'JTable' ][, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$type : string

The type (name) of the JTable class to get an instance of.

$prefix : string = 'JTable'

An optional prefix for the table class name.

$config : array<string|int, mixed> = []

An optional array of configuration values for the JTable object.

Tags
link
http://docs.joomla.org/JTable/getInstance
since
11.1
Return values
mixed

A JTable object if found or boolean false if one could not be found.

getParams()

Generic method to retrive raw json params from the table

public final getParams() : mixed
Tags
since
1.1.0
access

public

getRequester()

Retrieves the requester

public getRequester() : mixed
Tags
since
5.2.6
access

public

getState()

Request state of the download. Return false if not exist.

public getState() : mixed
Tags
since
5.2
access

public

getStateLabel()

Retrieves the label for the state (used for display purposes)

public getStateLabel() : mixed
Tags
since
5.2.6
access

public

getTitle()

Retrieves the translated title

public getTitle() : mixed
Tags
since
1.1.0
access

public

isNew()

Determine when the state is ready

public isNew() : mixed
Tags
since
5.2.6
access

public

isProcessing()

Determine when the state is ready

public isProcessing() : mixed
Tags
since
5.2.6
access

public

isReady()

Determine when the state is ready

public isReady() : mixed
Tags
since
5.2.6
access

public

reset()

Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.

public reset() : void
Tags
link
http://docs.joomla.org/JTable/reset
since
11.1

sendNotification()

Method used to send email notification to user who requested to download GDPR details.

public sendNotification() : mixed
Tags
since
5.2
access

public

setFilePath()

Method used to set filepath.

public setFilePath(mixed $filepath) : mixed
Parameters
$filepath : mixed
Tags
since
5.2
access

public

showArchiveDownload()

Method to ouput the zip file to browser for download.

public showArchiveDownload() : mixed
Tags
since
5.2
access

public

store()

On Joomla 4, if table object contains array or objects, storing is problematic unlike Joomla 3.

public store([mixed $updateNulls = false ]) : mixed

To fix Joomla 4 storing issues, we override the store behavior and normalize the fields accordingly.

Parameters
$updateNulls : mixed = false
Tags
since
1.1.0
access

public

toArray()

Converts a table layer into an array

public toArray() : mixed
Tags
since
1.1.0
access

public

updateState()

Method used to update the request state.

public updateState(mixed $state) : mixed
Parameters
$state : mixed
Tags
since
5.2
access

public


        
On this page

Search results