Documentation

Export
in package

Tags
ORM\Entity

(repositoryClass="Vatjar\Data\Repository\ExportRepository")

ORM\Table

(name="exports")

Table of Contents

Constants

STATUS_DONE  = 2
STATUS_ERROR  = -1
STATUS_IN_PROGRESS  = 1
STATUS_INIT  = 0
STATUS_LABELS  = [self::STATUS_ERROR => 'error', self::STATUS_INIT => 'in-queue', self::STATUS_IN_PROGRESS => 'in-progress', self::STATUS_DONE => 'done']

Properties

$_tmp_file_name  : mixed
This is a temporary field, which is not meant for persistence.
$error_message  : string|null
$finished_at  : string|null
$handler_class  : string
$id  : int|null
$parameters  : array<string|int, mixed>
$requested_at  : string
$requestUserAccount  : UserAccount
$size  : int|null
$status  : string
$type  : string
$uri  : string|null

Methods

__construct()  : mixed
getErrorMessage()  : string|null
getFilename()  : mixed
getFinishedAtDateString()  : mixed
getFinishedAtDateTime()  : mixed
getHandlerClass()  : string
getId()  : int|null
getParameters()  : array<string|int, mixed>
getRequestedAtDateString()  : mixed
getRequestedAtDateTime()  : mixed
getRequestUserAccount()  : UserAccount
getRequestUserAccountId()  : int
getSize()  : int|null
getStatus()  : string
getStatusLabel()  : mixed
getTmpFileName()  : string|null
getType()  : string|null
getUri()  : string|null
setErrorMessage()  : self
setFinishedAtDateString()  : mixed
setFinishedAtDateTime()  : mixed
setRequestedAtDateString()  : mixed
setRequestedAtDateTime()  : mixed
setRequestUserAccount()  : self
setRequestUserAccountId()  : self
setSize()  : self
setStatus()  : self
setTmpFileName()  : self
setUri()  : self

Constants

STATUS_DONE

public mixed STATUS_DONE = 2

STATUS_ERROR

public mixed STATUS_ERROR = -1

STATUS_IN_PROGRESS

public mixed STATUS_IN_PROGRESS = 1

STATUS_INIT

public mixed STATUS_INIT = 0

STATUS_LABELS

public mixed STATUS_LABELS = [self::STATUS_ERROR => 'error', self::STATUS_INIT => 'in-queue', self::STATUS_IN_PROGRESS => 'in-progress', self::STATUS_DONE => 'done']

Properties

$_tmp_file_name

This is a temporary field, which is not meant for persistence.

private mixed $_tmp_file_name

It is reserved for the export handler itself. It will have no value elsewhere.

$error_message

private string|null $error_message
Tags
ORM\Column

(type="string", name="error_message")

$finished_at

private string|null $finished_at
Tags
ORM\Column

(type="string", name="finished_at", nullable=true)

$handler_class

private string $handler_class
Tags
ORM\Column

(type="string", name="handler_class", nullable=false)

$id

private int|null $id
Tags
ORM\Column

(type="integer")

ORM\Id

()

ORM\GeneratedValue

()

$parameters

private array<string|int, mixed> $parameters
Tags
ORM\Column

(type="json", name="parameters")

$requested_at

private string $requested_at
Tags
ORM\Column

(type="string", name="requested_at", nullable=false)

$requestUserAccount

private UserAccount $requestUserAccount
Tags
ORM\OneToOne

(targetEntity="UserAccount")

ORM\JoinColumn

(name="request_user_account_id", referencedColumnName="id")

$size

private int|null $size
Tags
ORM\Column

(type="integer", name="size_in_bytes", nullable=true)

$status

private string $status
Tags
ORM\Column

(type="integer", name="status", nullable=false)

$type

private string $type
Tags
ORM\Column

(type="string", name="type", nullable=false)

$uri

private string|null $uri
Tags
ORM\Column

(type="string", name="uri", nullable=true)

Methods

__construct()

public __construct(int|UserAccount $requestUserAccount, string $handler_class, array<string|int, mixed> $parameters[, DateTime|null $requestedAt = null ]) : mixed
Parameters
$requestUserAccount : int|UserAccount
$handler_class : string
$parameters : array<string|int, mixed>
$requestedAt : DateTime|null = null

getErrorMessage()

public getErrorMessage() : string|null
Return values
string|null

getFilename()

public getFilename() : mixed

getFinishedAtDateString()

public getFinishedAtDateString() : mixed

getFinishedAtDateTime()

public getFinishedAtDateTime() : mixed

getHandlerClass()

public getHandlerClass() : string
Return values
string

getId()

public getId() : int|null
Return values
int|null

getParameters()

public getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRequestedAtDateString()

public getRequestedAtDateString() : mixed

getRequestedAtDateTime()

public getRequestedAtDateTime() : mixed

getRequestUserAccountId()

public getRequestUserAccountId() : int
Return values
int

getSize()

public getSize() : int|null
Return values
int|null

getStatus()

public getStatus() : string
Return values
string

getStatusLabel()

public getStatusLabel() : mixed

getTmpFileName()

public getTmpFileName() : string|null
Return values
string|null

getType()

public getType() : string|null
Return values
string|null

getUri()

public getUri() : string|null
Return values
string|null

setErrorMessage()

public setErrorMessage(string|null $error_message) : self
Parameters
$error_message : string|null
Return values
self

setFinishedAtDateString()

public setFinishedAtDateString(string $finished_at) : mixed
Parameters
$finished_at : string

setFinishedAtDateTime()

public setFinishedAtDateTime(DateTimeInterface $finished_at) : mixed
Parameters
$finished_at : DateTimeInterface

setRequestedAtDateString()

public setRequestedAtDateString(string $requested_at) : mixed
Parameters
$requested_at : string

setRequestedAtDateTime()

public setRequestedAtDateTime(DateTimeInterface $requested_at) : mixed
Parameters
$requested_at : DateTimeInterface

setRequestUserAccount()

public setRequestUserAccount(UserAccount $requestUserAccount) : self
Parameters
$requestUserAccount : UserAccount
Return values
self

setRequestUserAccountId()

public setRequestUserAccountId(int $requestUserAccount) : self
Parameters
$requestUserAccount : int
Return values
self

setSize()

public setSize(int|null $size) : self
Parameters
$size : int|null
Return values
self

setStatus()

public setStatus(string $status) : self
Parameters
$status : string
Return values
self

setTmpFileName()

public setTmpFileName(string $_tmp_file_name) : self
Parameters
$_tmp_file_name : string
Return values
self

setUri()

public setUri(string|null $uri) : self
Parameters
$uri : string|null
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results