class CategoryI18n extends DataModel

Localized category properties. localeName, categoryId and a localized name must be set.

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $categoryId
protected string $description
protected string $languageISO
protected string $metaDescription
protected string $metaKeywords
protected string $name
protected string $titleTag
protected string $urlPath

Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
setCategoryId(Identity $categoryId)

No description

getCategoryId()

No description

setDescription(string $description)

No description

string
getDescription()

No description

setLanguageISO(string $languageISO)

No description

string
getLanguageISO()

No description

setMetaDescription(string $metaDescription)

No description

string
getMetaDescription()

No description

setMetaKeywords(string $metaKeywords)

No description

string
getMetaKeywords()

No description

setName(string $name)

No description

string
getName()

No description

setTitleTag(string $titleTag)

No description

string
getTitleTag()

No description

setUrlPath(string $urlPath)

No description

string
getUrlPath()

No description

Details

at line 91
__construct()

Constructor

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in DataModel at line 172
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in DataModel at line 70
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in DataModel at line 35
mixed:string getFields()

Fields Getter

Return Value

mixed:string

in DataModel at line 45
validate()

Object Validation

Exceptions

SchemaException

in DataModel at line 59
mixed:string|NULL getField(boolean $toWawi = false, string $key)

Get a Model Member Name

Parameters

boolean $toWawi
string $key

Return Value

mixed:string|NULL

in DataModel at line 81
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

Parameters

boolean $toWawi
stdClass $obj Object to map

in DataModel at line 42
DataType getModelType()

Return Value

DataType

in DataModel at line 59
boolean isEncrypted()

Encrypted Status

Return Value

boolean

in DataModel at line 123
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

Parameters

string $propertyName
string|null $endpoint
int|null $host

in DataModel at line 179
protected setProperty($name, $value, $type)

Parameters

$name
$value
$type

in DataModel at line 190
protected validateType($value, $type)

Parameters

$value
$type

at line 101
CategoryI18n setCategoryId(Identity $categoryId)

Parameters

Identity $categoryId Reference to category

Return Value

CategoryI18n

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 109
Identity getCategoryId()

Return Value

Identity Reference to category

at line 118
CategoryI18n setDescription(string $description)

Parameters

string $description Optional localized Long Description

Return Value

CategoryI18n

at line 126
string getDescription()

Return Value

string Optional localized Long Description

at line 135
CategoryI18n setLanguageISO(string $languageISO)

Parameters

string $languageISO Locale

Return Value

CategoryI18n

at line 143
string getLanguageISO()

Return Value

string Locale

at line 152
CategoryI18n setMetaDescription(string $metaDescription)

Parameters

string $metaDescription Optional localized short description used for meta tag description

Return Value

CategoryI18n

at line 160
string getMetaDescription()

Return Value

string Optional localized short description used for meta tag description

at line 169
CategoryI18n setMetaKeywords(string $metaKeywords)

Parameters

string $metaKeywords Optional localized meta tag keywords value

Return Value

CategoryI18n

at line 177
string getMetaKeywords()

Return Value

string Optional localized meta tag keywords value

at line 186
CategoryI18n setName(string $name)

Parameters

string $name Localized category name

Return Value

CategoryI18n

at line 194
string getName()

Return Value

string Localized category name

at line 203
CategoryI18n setTitleTag(string $titleTag)

Parameters

string $titleTag Optional localized title tag value

Return Value

CategoryI18n

at line 211
string getTitleTag()

Return Value

string Optional localized title tag value

at line 220
CategoryI18n setUrlPath(string $urlPath)

Parameters

string $urlPath Optional localized category URL

Return Value

CategoryI18n

at line 228
string getUrlPath()

Return Value

string Optional localized category URL