CoolCMS API

Shipper extends Shipper
in package

Carrier. Legacy `last_updated_shipper_branch_id` is not carried over (without a branch import a cache column has no purpose).

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_mod_eshop_shippers'
#[TableAlias]
'shipper'

Table of Contents

Properties

$attributeClass  : string|null
$id  : int|null
$scriptName  : string|null
$sendEmail  : bool
$settings  : string|null
$translations  : Collection

Methods

__construct()  : mixed
addTranslation()  : $this
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.
getAttributeClass()  : string|null
getId()  : int|null
getScriptName()  : string|null
getSendEmail()  : bool
getSetting()  : string|null
Settings are one plain string `key1[value1],key2[value2]…`, the same format and lookbehind as {@see \App\Core\Base\Shared\System\Models\Entities\PaymentGate::getSetting()} (without the lookbehind `id` would also match inside `client_id[…]`).
getSettings()  : string|null
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
isPersisted()  : bool
isSendEmail()  : bool
removeTranslation()  : $this
setAttributeClass()  : $this
setId()  : $this
setScriptName()  : $this
setSendEmail()  : $this
setSettings()  : $this
setTranslations()  : $this
translationCollectionInit()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$attributeClass

protected string|null $attributeClass = null
Attributes
#[Column]
$name: 'attribute_class'
$type: 'string'
$length: 80
$nullable: true

$id

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

$scriptName

protected string|null $scriptName = null
Attributes
#[Column]
$name: 'script_name'
$type: 'string'
$length: 45
$nullable: true

$sendEmail

protected bool $sendEmail = false
Attributes
#[Column]
$name: 'send_email'
$type: 'boolean'

$settings

protected string|null $settings = null
Attributes
#[Column]
$name: 'settings'
$type: 'text'
$nullable: true
#[FieldAccess]
$read: Audience::Privileged
$insert: Audience::Privileged
$update: Audience::Privileged

$translations

protected Collection $translations
Attributes
#[OneToMany]
$targetEntity: \App\UI\Api\Eshop\Models\Entities\ShipperText::class
$mappedBy: 'parent'
$cascade: ['persist', 'remove']
$orphanRemoval: true
$fetch: 'LAZY'

Methods

__construct()

public __construct([int|null $id = null ][, bool $sendEmail = false ][, string|null $attributeClass = null ][, string|null $scriptName = null ][, string|null $settings = null ][, Collection $translations = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$sendEmail : bool = false
$attributeClass : string|null = null
$scriptName : string|null = null
$settings : string|null = null
$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

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>

getAttributeClass()

public getAttributeClass() : string|null
Return values
string|null

getScriptName()

public getScriptName() : string|null
Return values
string|null

getSendEmail()

public getSendEmail() : bool
Return values
bool

getSetting()

Settings are one plain string `key1[value1],key2[value2]…`, the same format and lookbehind as {@see \App\Core\Base\Shared\System\Models\Entities\PaymentGate::getSetting()} (without the lookbehind `id` would also match inside `client_id[…]`).

public getSetting(string $key) : string|null
Parameters
$key : string
Return values
string|null

getSettings()

public getSettings() : string|null
Return values
string|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>

isSendEmail()

public isSendEmail() : bool
Return values
bool

removeTranslation()

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

setAttributeClass()

public setAttributeClass(string|null $attributeClass) : $this
Parameters
$attributeClass : string|null
Return values
$this

setId()

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

setScriptName()

public setScriptName(string|null $scriptName) : $this
Parameters
$scriptName : string|null
Return values
$this

setSendEmail()

public setSendEmail(bool $sendEmail) : $this
Parameters
$sendEmail : bool
Return values
$this

setSettings()

public setSettings(string|null $settings) : $this
Parameters
$settings : string|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