ReferenceAssetRel
extends BaseEntity
in package
implements
AssetRelInterface
AbstractYes
Link between a reference and an item of its gallery (`cms_mod_company_reference_image_rel`), photo or video.
Composite PK (reference + asset) plus order, main and removed. The Api afterSave
writes it from meta['orderedAssets']
(AssetProcessingTrait); the first item in the
order is main and is also copied to Reference::$imageId.
Tags
Attributes
- #[MappedSuperclass]
- #[TableAlias]
- $alias: 'referenceImageRel'
Table of Contents
Interfaces
- AssetRelInterface
- Link between an entity and an image or file (`*AssetRel`, `*ImageRel`) with order and flags.
Properties
- $asset : TImage|null
- $main : bool
- $order : int
- $reference : TReference|null
- $removed : bool
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.
- getAsset() : TImage|null
- getMain() : bool
- getOrder() : int
- getReference() : TReference|null
- getRemoved() : bool
- isMain() : bool
- isRemoved() : bool
- setAsset() : $this
- setMain() : $this
- setOrder() : $this
- setReference() : $this
- setRemoved() : $this
- getTraitsRecursive() : array<string, string>
- Walks the trait list recursively and collects nested traits too.
Properties
$asset
protected
TImage|null
$asset
= null
$main
protected
bool
$main
= false
Attributes
- #[Column]
- $name: 'main'
- $type: 'boolean'
$order
protected
int
$order
= 0
Attributes
- #[Column]
- $name: '`order`'
- $type: 'integer'
- $options: ['unsigned' => true]
$reference
protected
TReference|null
$reference
= null
$removed
protected
bool
$removed
= false
Attributes
- #[Column]
- $name: 'removed'
- $type: 'boolean'
Methods
__construct()
public
__construct([mixed $reference = null ][, mixed $asset = null ][, bool $main = false ][, bool $removed = false ][, int $order = 0 ]) : mixed
Parameters
- $reference : mixed = null
- $asset : mixed = null
- $main : bool = false
- $removed : bool = false
- $order : int = 0
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>getAsset()
public
getAsset() : TImage|null
Return values
TImage|nullgetMain()
public
getMain() : bool
Return values
boolgetOrder()
public
getOrder() : int
Return values
intgetReference()
public
getReference() : TReference|null
Return values
TReference|nullgetRemoved()
public
getRemoved() : bool
Return values
boolisMain()
public
isMain() : bool
Return values
boolisRemoved()
public
isRemoved() : bool
Return values
boolsetAsset()
public
setAsset(TImage|null $asset) : $this
Parameters
- $asset : TImage|null
Return values
$thissetMain()
public
setMain(bool $main) : $this
Parameters
- $main : bool
Return values
$thissetOrder()
public
setOrder(int $order) : $this
Parameters
- $order : int
Return values
$thissetReference()
public
setReference(TReference|null $reference) : $this
Parameters
- $reference : TReference|null
Return values
$thissetRemoved()
public
setRemoved(bool $removed) : $this
Parameters
- $removed : bool
Return values
$thisgetTraitsRecursive()
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>