Phraseanet PHP SDK API
Class

PhraseanetSDK\Entity\Basket

class Basket extends AbstractEntity

Methods

__construct(EntityManager $em)

from AbstractEntity
integer getBasketId()

The basket id
setBasketId($id)

string getName()

The basket name
setName($name)

string getDescription()

The basket description
setDescription($description)

integer|null getPusherUsrId()

The id of the user who created the basket when the current basket is a validation basket
setPusherUsrId($pusherUsrId)

Boolean isUnread()

Tell whether the basket has been read or not
setUnread($unread)

DateTime getCreatedOn()

Creation date
setCreatedOn(DateTime $createdOn)

DateTime getUpdatedOn()

Last update date
setUpdatedOn(DateTime $updatedOn)

Boolean isValidationBasket()

Tell whether the basket is a validation basket
setValidationBasket($validationBasket)

ArrayCollection|null getValidationUsers()

Return a collection of PhraseanetSDK\entity\BasketValidationParticipant object if the basket is a validation basket otherwise it returns null
setValidationUsers(ArrayCollection $validationUsers)

DateTime|null getExpiresOn()

The expiration validation date, if the basket is a validation basket
setExpiresOn(DateTime $expiresOn)

string|null getValidationInfos()

Get some informations about the validation, if the basket is a validation basket
setValidationInfos($validationInfos)

Boolean|null isValidationConfirmed()

Tell whether the validation is confirmed
setValidationConfirmed($validationConfirmed)

Boolean|null isValidationInitiator()

Tell whether the current authenticated user initiates the validation process
setValidationInitiator($validationInitiator)

Details

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

Parameters

EntityManager $em

at line 38
public integer getBasketId()

The basket id

Return Value

integer

at line 43
public setBasketId($id)

Parameters

$id

at line 53
public string getName()

The basket name

Return Value

string

at line 58
public setName($name)

Parameters

$name

at line 68
public string getDescription()

The basket description

Return Value

string

at line 73
public setDescription($description)

Parameters

$description

at line 84
public integer|null getPusherUsrId()

The id of the user who created the basket when the current basket is a validation basket

Return Value

integer|null

at line 89
public setPusherUsrId($pusherUsrId)

Parameters

$pusherUsrId

at line 99
public Boolean isUnread()

Tell whether the basket has been read or not

Return Value

Boolean

at line 104
public setUnread($unread)

Parameters

$unread

at line 114
public DateTime getCreatedOn()

Creation date

Return Value

DateTime

at line 119
public setCreatedOn(DateTime $createdOn)

Parameters

DateTime $createdOn

at line 129
public DateTime getUpdatedOn()

Last update date

Return Value

DateTime

at line 134
public setUpdatedOn(DateTime $updatedOn)

Parameters

DateTime $updatedOn

at line 144
public Boolean isValidationBasket()

Tell whether the basket is a validation basket

Return Value

Boolean

at line 149
public setValidationBasket($validationBasket)

Parameters

$validationBasket

at line 160
public ArrayCollection|null getValidationUsers()

Return a collection of PhraseanetSDK\entity\BasketValidationParticipant object if the basket is a validation basket otherwise it returns null

Return Value

ArrayCollection|null

at line 165
public setValidationUsers(ArrayCollection $validationUsers)

Parameters

ArrayCollection $validationUsers

at line 175
public DateTime|null getExpiresOn()

The expiration validation date, if the basket is a validation basket

Return Value

DateTime|null

at line 180
public setExpiresOn(DateTime $expiresOn)

Parameters

DateTime $expiresOn

at line 191
public string|null getValidationInfos()

Get some informations about the validation, if the basket is a validation basket

Return Value

string|null

at line 196
public setValidationInfos($validationInfos)

Parameters

$validationInfos

at line 206
public Boolean|null isValidationConfirmed()

Tell whether the validation is confirmed

Return Value

Boolean|null

at line 211
public setValidationConfirmed($validationConfirmed)

Parameters

$validationConfirmed

at line 221
public Boolean|null isValidationInitiator()

Tell whether the current authenticated user initiates the validation process

Return Value

Boolean|null

at line 226
public setValidationInitiator($validationInitiator)

Parameters

$validationInitiator