VPE
in package
implements
VPEInterface
Class VPE
Tags
Interfaces, Classes and Traits
- VPEInterface
- Interface VPEInterface
Table of Contents
- $default : bool
- $id : int
- $names : KeyValueCollection
- __construct() : mixed
- VPE constructor.
- getId() : int
- Returns the id.
- getName() : string
- Returns the language specific name.
- getNames() : array<string|int, mixed>
- Returns all language specific names.
- isDefault() : bool
- Returns true if the vpe entity instance is the shops default.
- setDefault() : $this|VPEInterface
- Sets vpe entity to shops default, if bool type is true.
- setId() : $this|VPEInterface
- Sets the id.
- setName() : $this|VPEInterface
- Sets the language specific name.
Properties
$default
private
bool
$default
= alse
$id
private
int
$id
= 0
$names
private
KeyValueCollection
$names
Methods
__construct()
VPE constructor.
public
__construct(EditableKeyValueCollection $names) : mixed
Parameters
- $names : EditableKeyValueCollection
Return values
mixed —getId()
Returns the id.
public
getId() : int
Return values
int —getName()
Returns the language specific name.
public
getName(LanguageCode $languageCode) : string
Parameters
- $languageCode : LanguageCode
-
Language code for language specific name value.
Return values
string —Language specific name value.
getNames()
Returns all language specific names.
public
getNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —Language specific names value.
isDefault()
Returns true if the vpe entity instance is the shops default.
public
isDefault() : bool
Return values
bool —True if VPE value is shops default.
setDefault()
Sets vpe entity to shops default, if bool type is true.
public
setDefault(BoolType $default) : $this|VPEInterface
Parameters
- $default : BoolType
-
Is current vpe entity shops default?
Return values
$this|VPEInterface —Same instance for chained method calls.
setId()
Sets the id.
public
setId(IdType $vpeId) : $this|VPEInterface
Parameters
- $vpeId : IdType
-
Id to be set.
Return values
$this|VPEInterface —Same instance for chained method calls.
setName()
Sets the language specific name.
public
setName(StringType $name, LanguageCode $languageCode) : $this|VPEInterface
Parameters
- $name : StringType
-
Name value to be set.
- $languageCode : LanguageCode
-
Language code for language specific name value.
Return values
$this|VPEInterface —Same instance for chained method calls.