CoolCMS API

PdfTemplateVariantLayoutText extends PdfTemplateVariantLayoutText
in package

Per-language content (header/html/footer) of one PDF variant for a given layout (`cms_system_pdf_template_variant_layout_texts`); owned collection `layoutTexts` on {@see PdfTemplateVariant}. Composite PK: `layoutId` + `languageId` (scalars here, with `#[ORM\Id]` and `#[Identity]`) and the `variant` association (owning many-to-one, its `#[ORM\Id]` is declared in the Api child). `variantId` is only a read-only FK mirror (`insertable`/`updatable` false); the association controls writes.

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_pdf_template_variant_layout_texts'
#[TableAlias]
'pdfTemplateVariantLayoutText'

Table of Contents

Properties

$footer  : string|null
$header  : string|null
$html  : string
$languageId  : int|null
$layoutId  : int|null
$variant  : TVariant|null
$variantId  : int|null

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getFooter()  : string|null
getHeader()  : string|null
getHtml()  : string
getLanguageId()  : int|null
getLayoutId()  : int|null
getVariant()  : TVariant|null
getVariantId()  : int|null
setFooter()  : $this
setHeader()  : $this
setHtml()  : $this
setLanguageId()  : $this
setLayoutId()  : $this
setVariant()  : $this
setVariantId()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$languageId

protected int|null $languageId = null
Attributes
#[Column]
$name: 'cms_system_languages_language_id'
$type: 'integer'
$options: ['unsigned' => true]
#[Id]
#[Identity]

$layoutId

protected int|null $layoutId = null
Attributes
#[Column]
$name: 'cms_system_pdf_template_layouts_pdf_template_layout_id'
$type: 'integer'
$options: ['unsigned' => true]
#[Id]
#[Identity]

$variant

protected TVariant|null $variant = null
Attributes
#[EntityOf]
\App\UI\Api\System\Models\Entities\PdfTemplateVariant::class
#[Id]
#[Identity]
#[JoinColumn]
$name: 'cms_system_pdf_template_variants_pdf_template_variant_id'
$referencedColumnName: 'pdf_template_variant_id'
$onDelete: 'CASCADE'
#[ManyToOne]
$targetEntity: \App\UI\Api\System\Models\Entities\PdfTemplateVariant::class
$inversedBy: 'layoutTexts'

$variantId

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

Methods

__construct()

public __construct([int|null $layoutId = null ][, int|null $languageId = null ][, int|null $variantId = null ][, mixed $variant = null ][, string|null $header = null ][, string $html = '' ][, string|null $footer = null ]) : mixed
Parameters
$layoutId : int|null = null
$languageId : int|null = null
$variantId : int|null = null
$variant : mixed = null
$header : string|null = null
$html : string = ''
$footer : string|null = null

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>

setLanguageId()

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