Synonyms
in package
Uses
Configurable
Class Synonyms List out UK to US synonyms and synonyms from {@link SiteConfig} Source: @link https://raw.githubusercontent.com/heiswayi/spelling-uk-vs-us/
Table of Contents
Properties
- $synonyms : array<string|int, mixed>
Methods
- getSynonyms() : array<string|int, mixed>
- Get the available synonyms as an array from config Defaulting to adding the UK to US spelling differences
- getSynonymsAsString() : string
- Make the UK to US spelling synonyms as a newline separated string Or any other synonyms defined if the user wishes to do so
- getSynonymsFlattened() : mixed
Properties
$synonyms
protected
static array<string|int, mixed>
$synonyms
Synonym list
Methods
getSynonyms()
Get the available synonyms as an array from config Defaulting to adding the UK to US spelling differences
public
static getSynonyms([bool $defaults = true ]) : array<string|int, mixed>
Parameters
- $defaults : bool = true
-
adds the UK to US spelling to the list if true
Return values
array<string|int, mixed>getSynonymsAsString()
Make the UK to US spelling synonyms as a newline separated string Or any other synonyms defined if the user wishes to do so
public
static getSynonymsAsString([bool $defaults = true ]) : string
Parameters
- $defaults : bool = true
-
add Default UK-US synonyms to the list
Return values
stringgetSynonymsFlattened()
public
static getSynonymsFlattened([mixed $defaults = true ]) : mixed
Parameters
- $defaults : mixed = true