CoolCMS API

PdfTemplateVariant extends PdfTemplateVariant
in package

Admin variant of a PDF template (`cms_system_pdf_template_variants`), an owned collection of the template (`PdfTemplate.variants`, cascade persist/remove). Holds `css` per variant, a semantic name (`translations`: name/header/html/footer; the form does not edit header/html/footer) and content per variant and layout (`layoutTexts`).

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_pdf_template_variants'
#[TableAlias]
'pdfTemplateVariant'

Table of Contents

Properties

$css  : string
$id  : int|null
$layoutTexts  : Collection<int, PdfTemplateVariantLayoutText>
Per-language content of this variant for every layout; owned collection, fully replaced by the object-graph save of the variant.
$pdfTemplate  : PdfTemplate|null
$pdfTemplateId  : int|null
$translations  : Collection

Methods

__construct()  : mixed
addLayoutText()  : $this
addTranslation()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
clearLayoutTexts()  : $this
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getCss()  : string
getId()  : int|null
getLayoutText()  : TLayoutText|null
getLayoutTexts()  : Collection<int, TLayoutText>
getPdfTemplate()  : PdfTemplate|null
getPdfTemplateId()  : int|null
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
isPersisted()  : bool
pdfTemplateVariantLayoutTextCollectionInit()  : void
removeLayoutText()  : $this
removeTranslation()  : $this
setCss()  : $this
setId()  : $this
setLayoutTexts()  : $this
setPdfTemplate()  : self
setPdfTemplateId()  : $this
setTranslations()  : $this
translationCollectionInit()  : 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_variant_id'
$type: 'integer'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$layoutTexts

Per-language content of this variant for every layout; owned collection, fully replaced by the object-graph save of the variant.

protected Collection<int, PdfTemplateVariantLayoutText> $layoutTexts
Attributes
#[CollectionOf]
\App\UI\Admin\System\Models\Entities\PdfTemplateVariantLayoutText::class
$owned: true
#[OneToMany]
$targetEntity: \App\UI\Admin\System\Models\Entities\PdfTemplateVariantLayoutText::class
$mappedBy: 'variant'
$cascade: ["persist", "remove"]
$orphanRemoval: true
$fetch: "LAZY"

$pdfTemplate

protected PdfTemplate|null $pdfTemplate = null
Attributes
#[EntityOf]
\App\UI\Admin\System\Models\Entities\PdfTemplate::class
#[JoinColumn]
$name: 'cms_system_pdf_templates_pdf_template_id'
$referencedColumnName: 'pdf_template_id'
$onDelete: 'CASCADE'
#[ManyToOne]
$targetEntity: \App\UI\Admin\System\Models\Entities\PdfTemplate::class
$inversedBy: 'variants'
#[ParentRef]

$pdfTemplateId

protected int|null $pdfTemplateId = null
Attributes
#[Column]
$name: 'cms_system_pdf_templates_pdf_template_id'
$type: 'integer'
$options: ['unsigned' => true]
$insertable: false
$updatable: false

$translations

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

Methods

__construct()

public __construct([int|null $id = null ][, int|null $pdfTemplateId = null ][, string $css = '' ][, Collection $translations = new ArrayCollection() ][, Collection $layoutTexts = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$pdfTemplateId : int|null = null
$css : string = ''
$translations : Collection = new ArrayCollection()
$layoutTexts : 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

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>

getLayoutText()

public getLayoutText([int|null $layoutId = null ][, int|null $languageId = null ]) : TLayoutText|null
Parameters
$layoutId : int|null = null
$languageId : int|null = null
Return values
TLayoutText|null

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>

removeTranslation()

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

setCss()

public setCss(string $css) : $this
Parameters
$css : string
Return values
$this

setId()

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

setLayoutTexts()

public setLayoutTexts(Collection<int, TLayoutText>|array<string|int, TLayoutText> $layoutTexts) : $this
Parameters
$layoutTexts : Collection<int, TLayoutText>|array<string|int, TLayoutText>
Return values
$this

setPdfTemplateId()

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

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