CoolCMS API

PdfTemplate extends PdfTemplate
in package

Admin PDF template (`cms_system_pdf_templates`), hydrated from the Api endpoint `api/system/pdf-template`. Holds translations (name) and owned variants (`PdfTemplateVariant`: css plus name/header/html/footer per language).

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_pdf_templates'
#[TableAlias]
'pdfTemplate'

Table of Contents

Properties

$id  : int|null
$translations  : Collection
$variants  : Collection

Methods

__construct()  : mixed
addTranslation()  : $this
addVariant()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
clearVariants()  : $this
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getId()  : int|null
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
getVariants()  : Collection<int, TVariant>
isPersisted()  : bool
removeTranslation()  : $this
removeVariant()  : $this
setId()  : $this
setTranslations()  : $this
setVariants()  : $this
translationCollectionInit()  : void
variantCollectionInit()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$id

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

$translations

protected Collection $translations
Attributes
#[CollectionOf]
\App\UI\Admin\System\Models\Entities\PdfTemplateText::class
$owned: true
#[OneToMany]
$targetEntity: \App\UI\Admin\System\Models\Entities\PdfTemplateText::class
$mappedBy: 'parent'
$cascade: ["persist", "remove"]
$orphanRemoval: true
$fetch: "LAZY"

$variants

protected Collection $variants
Attributes
#[CollectionOf]
\App\UI\Admin\System\Models\Entities\PdfTemplateVariant::class
$owned: true
#[OneToMany]
$targetEntity: \App\UI\Admin\System\Models\Entities\PdfTemplateVariant::class
$mappedBy: 'pdfTemplate'
$cascade: ["persist", "remove"]
$orphanRemoval: true
$fetch: "LAZY"

Methods

__construct()

public __construct([int|null $id = null ][, Collection $translations = new ArrayCollection() ][, Collection $variants = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$translations : Collection = new ArrayCollection()
$variants : Collection = new ArrayCollection()

addTranslation()

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

addVariant()

public addVariant(TVariant $variant) : $this
Parameters
$variant : TVariant
Return values
$this

callInitMethods()

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

public callInitMethods() : void

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>

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>

getVariants()

public getVariants() : Collection<int, TVariant>
Return values
Collection<int, TVariant>

removeTranslation()

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

removeVariant()

public removeVariant(TVariant $variant) : $this
Parameters
$variant : TVariant
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
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

setVariants()

public setVariants(Collection<int, TVariant>|array<int, TVariant> $variants) : $this
Parameters
$variants : Collection<int, TVariant>|array<int, TVariant>
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