AirLay backend

ReportTemplateEntity extends DatabaseEntity
in package

Table of Contents

AVAILABLE_TYPES  = ['shared', 'detailed', 'milestone', 'example', 'individual', 'feature', 'objects', 'errors', 'image', 'media']
$_id  : ObjectId
$fieldForZip  : string|null
$file  : string
$filename  : string
$firstCell  : string
$groupField  : string|null
$name  : string
$organizationId  : ObjectId
$template  : array<string|int, mixed>
$type  : string
__construct()  : mixed
__toString()  : string
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
fromArray()  : ReportTemplateEntity
getFieldForZip()  : string|null
getFile()  : string
getFilename()  : string
getFirstCell()  : string
getGroupField()  : string|null
getId()  : ObjectId
getName()  : string
getOrganizationId()  : ObjectId
getTemplate()  : array<string|int, mixed>
getType()  : string
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
setFieldForZip()  : self
setFile()  : self
setFilename()  : self
setFirstCell()  : self
setGroupField()  : self
setId()  : self
setName()  : self
setOrganizationId()  : self
setTemplate()  : self
setType()  : self
toArray()  : array<string|int, mixed>

Constants

AVAILABLE_TYPES

public mixed AVAILABLE_TYPES = ['shared', 'detailed', 'milestone', 'example', 'individual', 'feature', 'objects', 'errors', 'image', 'media']

Properties

Methods

__construct()

public __construct(string $name, string $type, ObjectId $organizationId, string $file, array<string|int, mixed> $template, string $firstCell, string $filename[, string|null $groupField = null ][, string|null $fieldForZip = null ][, ObjectId|null $id = null ]) : mixed
Parameters
$name : string
$type : string
$organizationId : ObjectId
$file : string
$template : array<string|int, mixed>
$firstCell : string
$filename : string
$groupField : string|null = null
$fieldForZip : string|null = null
$id : ObjectId|null = null
Return values
mixed

__toString()

public __toString() : string
Return values
string

bsonSerialize()

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

bsonUnserialize()

public bsonUnserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void

getTemplate()

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

jsonSerialize()

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

parseObjectId()

public static parseObjectId(mixed $objectId) : ObjectId|null
Parameters
$objectId : mixed
Return values
ObjectId|null

setFieldForZip()

public setFieldForZip(string|null $fieldForZip) : self
Parameters
$fieldForZip : string|null
Return values
self

setFile()

public setFile(string $filePath) : self
Parameters
$filePath : string
Return values
self

setFilename()

public setFilename(string $filename) : self
Parameters
$filename : string
Return values
self

setFirstCell()

public setFirstCell(string $firstCell) : self
Parameters
$firstCell : string
Return values
self

setGroupField()

public setGroupField(string|null $groupField) : self
Parameters
$groupField : string|null
Return values
self

setId()

public setId(ObjectId $id) : self
Parameters
$id : ObjectId
Return values
self

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self

setOrganizationId()

public setOrganizationId(ObjectId $organizationId) : self
Parameters
$organizationId : ObjectId
Return values
self

setTemplate()

public setTemplate(array<string|int, mixed> $template) : self
Parameters
$template : array<string|int, mixed>
Return values
self

setType()

public setType(string $type) : self
Parameters
$type : string
Return values
self

toArray()

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

Search results