Documentation

NameTranslationParameters extends RosetteParamsSetBase
in package

Class NameTranslationParameters.

Table of Contents

Properties

$entityType  : string
$genre  : string
$name  : string
$sourceLanguageOfOrigin  : string
$sourceLanguageOfUse  : string
$sourceScript  : string
$targetLanguage  : string
$targetScheme  : string
$targetScript  : string

Methods

__construct()  : mixed
constructor.
get()  : mixed
Gets a property value based on the property name.
getMultiPartContent()  : string
Provides default multiPart call for child classes that don't implement it
serialize()  : string
Serialize into a json string.
set()  : mixed
Sets a property based on the name.
validate()  : mixed
Validates parameters.
removeEmptyProperties()  : mixed
Recursively removes empty properties to facilitate json encoding.

Properties

$entityType

public string $entityType

entityType type of entity, e.g. PERSON, LOCATION, ORGANIZATION (optional)

$sourceLanguageOfOrigin

public string $sourceLanguageOfOrigin

sourceLanguageOfOrigin ISO 693-3 code for name's language of origin (optional)

$sourceLanguageOfUse

public string $sourceLanguageOfUse

sourceLanguageOfUse ISO 693-3 code for name's language of use (optional)

$targetScheme

public string $targetScheme

targetScheme transliteration scheme for the translation (optional)

Methods

get()

Gets a property value based on the property name.

public get(string $propertyName) : mixed
Parameters
$propertyName : string

the name of the property

Tags
throws
RosetteException

if property name not found

Return values
mixed

property value

getMultiPartContent()

Provides default multiPart call for child classes that don't implement it

public getMultiPartContent() : string
Return values
string

serialize()

Serialize into a json string.

public serialize(mixed $options) : string
Parameters
$options : mixed

associative array of options

Return values
string

set()

Sets a property based on the name.

public set(string $propertyName, mixed $value) : mixed
Parameters
$propertyName : string

the name of the property

$value : mixed

the value to set

removeEmptyProperties()

Recursively removes empty properties to facilitate json encoding.

private removeEmptyProperties(mixed $obj) : mixed
Parameters
$obj : mixed

Object to clean


        
On this page

Search results