Documentation

Language extends AbstractStyle

Language A couple of predefined values are defined here, see the websites below for more values

Tags
see
http://www.datypic.com/sc/ooxml/t-w_CT_Language.html
see
https://technet.microsoft.com/en-us/library/cc287874(v=office.12).aspx

Table of Contents

DE_DE  = 'de-DE'
DE_DE_ID  = 1031
EN_GB  = 'en-GB'
EN_GB_ID  = 2057
EN_US  = 'en-US'
EN_US_ID  = 1033
ES_ES  = 'es-ES'
ES_ES_ID  = 3082
FR_BE  = 'fr-BE'
FR_BE_ID  = 2060
FR_FR  = 'fr-FR'
FR_FR_ID  = 1036
HE_IL  = 'he-IL'
HE_IL_ID  = 1037
HI_IN  = 'hi-IN'
HI_IN_ID  = 1081
IT_IT  = 'it-IT'
IT_IT_ID  = 1040
JA_JP  = 'ja-JP'
JA_JP_ID  = 1041
KO_KR  = 'ko-KR'
KO_KR_ID  = 1042
NL_NL  = 'nl-NL'
NL_NL_ID  = 1043
PT_BR  = 'pt-BR'
PT_BR_ID  = 1046
RU_RU  = 'ru-RU'
RU_RU_ID  = 1049
UK_UA  = 'uk-UA'
UK_UA_ID  = 1058
ZH_CN  = 'zh-CN'
ZH_CN_ID  = 2052
$aliases  : array<string|int, mixed>
Aliases
$index  : int|null
Index number in Style collection for named style
$styleName  : string
Style name
$bidirectional  : string
Complex Script Language
$eastAsia  : string
East Asian Language
$isAuto  : bool
Is this an automatic style? (Used primarily in OpenDocument driver)
$langId  : int
Language ID, used for RTF document generation
$latin  : string
Latin Language
__construct()  : mixed
Constructor
getBidirectional()  : string|null
Get the Complex Script Language
getChildStyleValue()  : mixed
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`
getEastAsia()  : string|null
Get the East Asian Language
getIndex()  : int|null
Get index number
getLangId()  : int
Get the Language ID
getLatin()  : string|null
Get the Latin Language
getStyleName()  : string
Get style name
isAuto()  : bool
Get is automatic style flag
setArrayStyle()  : self
Set style using associative array
setAuto()  : self
Set is automatic style flag
setBidirectional()  : self
Set the Complex Script Language
setEastAsia()  : self
Set the East Asian Language
setIndex()  : self
Set index number
setLangId()  : self
Set the Language ID
setLatin()  : self
Set the Latin Language
setStyleByArray()  : self
Set style by using associative array
setStyleName()  : self
Set style name
setStyleValue()  : self
Set style value template method
setBoolVal()  : bool
Set bool value
setEnumVal()  : mixed
Set enum value
setFloatVal()  : float|null
Set float value: Convert string that contains only numeric into float
setIntVal()  : int|null
Set integer value: Convert string that contains only numeric into integer
setNonEmptyVal()  : string
Set default for null and empty value
setNumericVal()  : int|float|null
Set numeric value
setObjectVal()  : mixed
Set object value
setPairedVal()  : self
Set $property value and set $pairProperty = false when $value = true
validateLocale()  : string
Validates that the language passed is in the format xx-xx

Constants

Properties

$aliases

Aliases

protected array<string|int, mixed> $aliases = array()

$index

Index number in Style collection for named style

protected int|null $index

This number starts from one and defined in Style::setStyleValues()

$bidirectional

Complex Script Language

private string $bidirectional

$eastAsia

East Asian Language

private string $eastAsia

$isAuto

Is this an automatic style? (Used primarily in OpenDocument driver)

private bool $isAuto = false
Tags
since
0.11.0

$latin

Latin Language

private string $latin

Methods

__construct()

Constructor

public __construct([string|null $latin = null ][, string|null $eastAsia = null ][, string|null $bidirectional = null ]) : mixed
Parameters
$latin : string|null = null
$eastAsia : string|null = null
$bidirectional : string|null = null
Return values
mixed —

getBidirectional()

Get the Complex Script Language

public getBidirectional() : string|null
Return values
string|null —

getChildStyleValue()

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`

public getChildStyleValue(AbstractStyle $substyleObject, string $substyleProperty) : mixed
Parameters
$substyleObject : AbstractStyle
$substyleProperty : string
Tags
since
0.12.0
Return values
mixed —

getEastAsia()

Get the East Asian Language

public getEastAsia() : string|null
Return values
string|null —

getIndex()

Get index number

public getIndex() : int|null
Return values
int|null —

getLangId()

Get the Language ID

public getLangId() : int
Return values
int —

getLatin()

Get the Latin Language

public getLatin() : string|null
Return values
string|null —

getStyleName()

Get style name

public getStyleName() : string
Return values
string —

isAuto()

Get is automatic style flag

public isAuto() : bool
Return values
bool —

setArrayStyle()

Set style using associative array

public setArrayStyle([array<string|int, mixed> $style = array() ]) : self
Parameters
$style : array<string|int, mixed> = array()
Tags
deprecated
0.11.0
codeCoverageIgnore
Return values
self —

setAuto()

Set is automatic style flag

public setAuto([bool $value = true ]) : self
Parameters
$value : bool = true
Return values
self —

setBidirectional()

Set the Complex Script Language

public setBidirectional(string $bidirectional) : self
Parameters
$bidirectional : string

The value for the complex script language

Return values
self —

setEastAsia()

Set the East Asian Language

public setEastAsia(string $eastAsia) : self
Parameters
$eastAsia : string

The value for the east asian language

Return values
self —

setIndex()

Set index number

public setIndex([int|null $value = null ]) : self
Parameters
$value : int|null = null
Return values
self —

setLatin()

Set the Latin Language

public setLatin(string $latin) : self
Parameters
$latin : string

The value for the latin language

Return values
self —

setStyleByArray()

Set style by using associative array

public setStyleByArray([array<string|int, mixed> $values = array() ]) : self
Parameters
$values : array<string|int, mixed> = array()
Return values
self —

setStyleName()

Set style name

public setStyleName(string $value) : self
Parameters
$value : string
Return values
self —

setStyleValue()

Set style value template method

public setStyleValue(string $key, string $value) : self

Some child classes have their own specific overrides. Backward compability check for versions < 0.10.0 which use underscore prefix for their private properties. Check if the set method is exists. Throws an exception?

Parameters
$key : string
$value : string
Return values
self —

setBoolVal()

Set bool value

protected setBoolVal(bool $value, bool $default) : bool
Parameters
$value : bool
$default : bool
Return values
bool —

setEnumVal()

Set enum value

protected setEnumVal([mixed $value = null ][, array<string|int, mixed> $enum = array() ][, mixed $default = null ]) : mixed
Parameters
$value : mixed = null
$enum : array<string|int, mixed> = array()
$default : mixed = null
Tags
throws
InvalidArgumentException
Return values
mixed —

setFloatVal()

Set float value: Convert string that contains only numeric into float

protected setFloatVal(mixed $value[, float|null $default = null ]) : float|null
Parameters
$value : mixed
$default : float|null = null
Return values
float|null —

setIntVal()

Set integer value: Convert string that contains only numeric into integer

protected setIntVal(int|null $value[, int|null $default = null ]) : int|null
Parameters
$value : int|null
$default : int|null = null
Return values
int|null —

setNonEmptyVal()

Set default for null and empty value

protected setNonEmptyVal(string $value, string $default) : string
Parameters
$value : string

(was: mixed)

$default : string

(was: mixed)

Return values
string —

(was: mixed)

setNumericVal()

Set numeric value

protected setNumericVal(mixed $value[, int|float|null $default = null ]) : int|float|null
Parameters
$value : mixed
$default : int|float|null = null
Return values
int|float|null —

setObjectVal()

Set object value

protected setObjectVal(mixed $value, string $styleName, mixed &$style) : mixed
Parameters
$value : mixed
$styleName : string
$style : mixed
Return values
mixed —

setPairedVal()

Set $property value and set $pairProperty = false when $value = true

protected setPairedVal(bool &$property, bool &$pairProperty, bool $value) : self
Parameters
$property : bool
$pairProperty : bool
$value : bool
Return values
self —

validateLocale()

Validates that the language passed is in the format xx-xx

private validateLocale(string $locale) : string
Parameters
$locale : string
Return values
string —

Search results