Phraseanet PHP SDK API
Class

PhraseanetSDK\Entity\Record

class Record extends AbstractEntity

Methods

__construct(EntityManager $em)

from AbstractEntity
integer getRecordId()

Get the record id

setRecordId($recordId)

integer getDataboxId()

Get the databox id

setDataboxId($databoxId)

string getTitle()

Get the record title

setTitle($title)

string getMimeType()

Get the record mime type

setMimeType($mimeType)

string getOriginalName()

Get the record original name

setOriginalName($originalName)

DateTime getUpdatedOn()

Last updated date

setUpdatedOn(DateTime $updatedOn)

DateTime getCreatedOn()

Creation date

setCreatedOn(DateTime $createdOn)

integer getCollectionId()

Get the record collection id

setCollectionId($collectionId)

string getSha256()

Get the record SHA256 hash

setSha256($sha256)

Subdef|null getThumbnail()

Return the thumbnail of the record as a PhraseanetSDK\Entity\Subdef object if the thumbnail exists null otherwise

setThumbnail(Subdef $thumbnail)

string getPhraseaType()

Get the Record phraseaType IMAGE|VIDEO|DOCUMENT etc..

setPhraseaType($phraseaType)

string getUuid()

Get the record UUID

setUuid($uuid)

ArrayCollection getTechnicalInformations()

Get a collection of Phraseanet\Entity\Technical data objects

setTechnicalInformations(ArrayCollection $technicalInformations)

ArrayCollection|Subdef getSubdefs(string|null $name = null)

Return a collection of PhraseanetSDK\Entity\Subdef for the record

ArrayCollection getSubdefsByDevicesAndMimeTypes(array $devices, array $mimes)

Return a collection of PhraseanetSDK\Entity\Subdef for the record

ArrayCollection getMetadatas()

Return the record metdatas as a collection of PhraseanetSDK\Entity\Metadatas objects

ArrayCollection getCaption()

Get the record caption as collection of PhraseanetSDK\Entity\RecordCaption objects

ArrayCollection getStatus()

Get the record status as collection of PhraseanetSDK\Entity\RecordStatus objects

Details

in AbstractEntity at line 21
final public __construct(EntityManager $em)

Parameters

EntityManager $em

at line 39
public integer getRecordId()

Get the record id

Return Value

integer

at line 44
public setRecordId($recordId)

Parameters

$recordId

at line 54
public integer getDataboxId()

Get the databox id

Return Value

integer

at line 59
public setDataboxId($databoxId)

Parameters

$databoxId

at line 69
public string getTitle()

Get the record title

Return Value

string

at line 74
public setTitle($title)

Parameters

$title

at line 84
public string getMimeType()

Get the record mime type

Return Value

string

at line 89
public setMimeType($mimeType)

Parameters

$mimeType

at line 99
public string getOriginalName()

Get the record original name

Return Value

string

at line 104
public setOriginalName($originalName)

Parameters

$originalName

at line 114
public DateTime getUpdatedOn()

Last updated date

Return Value

DateTime

at line 119
public setUpdatedOn(DateTime $updatedOn)

Parameters

DateTime $updatedOn

at line 129
public DateTime getCreatedOn()

Creation date

Return Value

DateTime

at line 134
public setCreatedOn(DateTime $createdOn)

Parameters

DateTime $createdOn

at line 144
public integer getCollectionId()

Get the record collection id

Return Value

integer

at line 149
public setCollectionId($collectionId)

Parameters

$collectionId

at line 159
public string getSha256()

Get the record SHA256 hash

Return Value

string

at line 164
public setSha256($sha256)

Parameters

$sha256

at line 175
public Subdef|null getThumbnail()

Return the thumbnail of the record as a PhraseanetSDK\Entity\Subdef object if the thumbnail exists null otherwise

Return Value

Subdef|null

at line 180
public setThumbnail(Subdef $thumbnail)

Parameters

Subdef $thumbnail

at line 190
public string getPhraseaType()

Get the Record phraseaType IMAGE|VIDEO|DOCUMENT etc..

Return Value

string

at line 195
public setPhraseaType($phraseaType)

Parameters

$phraseaType

at line 205
public string getUuid()

Get the record UUID

Return Value

string

at line 210
public setUuid($uuid)

Parameters

$uuid

at line 220
public ArrayCollection getTechnicalInformations()

Get a collection of Phraseanet\Entity\Technical data objects

Return Value

ArrayCollection

at line 225
public setTechnicalInformations(ArrayCollection $technicalInformations)

Parameters

ArrayCollection $technicalInformations

at line 242
public ArrayCollection|Subdef getSubdefs(string|null $name = null)

Return a collection of PhraseanetSDK\Entity\Subdef for the record

Precise a name to get the desired subdef identified by its name

/!\ This method requests the API

Parameters

string|null $name The desired subdef name

Return Value

ArrayCollection|Subdef

Exceptions

NotFoundException In case the subdef name could not be found

at line 271
public ArrayCollection getSubdefsByDevicesAndMimeTypes(array $devices, array $mimes)

Return a collection of PhraseanetSDK\Entity\Subdef for the record

Precise an array of devices or mime types for the desired sub definitions

/!\ This method requests the API

Parameters

array $devices The desired devices
array $mimes The desired mimes type

Return Value

ArrayCollection

Exceptions

RuntimeException in case of response not valid

at line 288
public ArrayCollection getMetadatas()

Return the record metdatas as a collection of PhraseanetSDK\Entity\Metadatas objects

/!\ This method requests the API

Return Value

ArrayCollection

at line 300
public ArrayCollection getCaption()

Get the record caption as collection of PhraseanetSDK\Entity\RecordCaption objects

/!\ This method requests the API

Return Value

ArrayCollection

at line 312
public ArrayCollection getStatus()

Get the record status as collection of PhraseanetSDK\Entity\RecordStatus objects

/!\ This method requests the API

Return Value

ArrayCollection