CoolCMS API

Vacation extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait, TranslationCollectionTrait

AbstractYes

Shipping exclusion window (vacation) affecting delivery estimates.

Tags
template
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'vacation'

Table of Contents

Interfaces

IdentifiableInterface
Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$activated  : bool
$endDate  : DateTime
$id  : int|null
$insertDatetime  : DateTime
$startDate  : DateTime
$translations  : Collection<int, TTranslation>

Methods

__construct()  : mixed
addTranslation()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getActivated()  : bool
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getEndDate()  : DateTime
getId()  : int|null
getInsertDatetime()  : DateTime
getStartDate()  : DateTime
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
isActivated()  : bool
isPersisted()  : bool
removeTranslation()  : $this
setActivated()  : $this
setEndDate()  : $this
setId()  : $this
setInsertDatetime()  : $this
setStartDate()  : $this
setTranslations()  : $this
translationCollectionInit()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$activated

protected bool $activated = false
Attributes
#[Column]
$name: 'activated'
$type: 'boolean'
#[ExternalReadonly]

$endDate

protected DateTime $endDate = new DateTime()
Attributes
#[Column]
$name: 'end_date'
$type: 'date'

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'vacation_id'
$type: 'integer'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$insertDatetime

protected DateTime $insertDatetime = new DateTime()
Attributes
#[Column]
$name: 'insert_datetime'
$type: 'datetime'
#[ExternalReadonly]

$startDate

protected DateTime $startDate = new DateTime()
Attributes
#[Column]
$name: 'start_date'
$type: 'date'

$translations

protected Collection<int, TTranslation> $translations = new ArrayCollection()

Methods

__construct()

public __construct([int|null $id = null ][, DateTime $startDate = new DateTime() ][, DateTime $endDate = new DateTime() ][, bool $activated = false ][, DateTime $insertDatetime = new DateTime() ][, Collection $translations = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$startDate : DateTime = new DateTime()
$endDate : DateTime = new DateTime()
$activated : bool = false
$insertDatetime : DateTime = new DateTime()
$translations : Collection = new ArrayCollection()

addTranslation()

public addTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getActivated()

public getActivated() : bool
Return values
bool

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getEndDate()

public getEndDate() : DateTime
Return values
DateTime

getInsertDatetime()

public getInsertDatetime() : DateTime
Return values
DateTime

getStartDate()

public getStartDate() : DateTime
Return values
DateTime

getTranslation()

public getTranslation(int $langId) : TTranslation|null
Parameters
$langId : int
Return values
TTranslation|null

getTranslations()

public getTranslations() : Collection<int, TTranslation>
Return values
Collection<int, TTranslation>

isActivated()

public isActivated() : bool
Return values
bool

removeTranslation()

public removeTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

setActivated()

public setActivated(bool $activated) : $this
Parameters
$activated : bool
Return values
$this

setEndDate()

public setEndDate(DateTime $endDate) : $this
Parameters
$endDate : DateTime
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setInsertDatetime()

public setInsertDatetime(DateTime $insertDatetime) : $this
Parameters
$insertDatetime : DateTime
Return values
$this

setStartDate()

public setStartDate(DateTime $startDate) : $this
Parameters
$startDate : DateTime
Return values
$this

setTranslations()

public setTranslations(Collection<int, TTranslation>|array<int, TTranslation> $translations) : $this
Parameters
$translations : Collection<int, TTranslation>|array<int, TTranslation>
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results