/** * Returns the Metaphone key "heard" from a string. * * The algorithm used to render the [Metaphone](http://en.wikipedia.org/wiki/Metaphone) key is the first-generation * one. * * @param bool $transliterate **OPTIONAL. Default is** `true`. Tells whether to transliterate the string into the * Latin script and then flatten it to ASCII before generating the key. Since the Metaphone algorithm is not * Unicode-aware, the touch of transliteration is something that any arbitrary Unicode string would wish for. For * example, "こんにちは" is transliterated to "kon'nichiha". * * @return CUStringObject The Metaphone key of the string. */ public function metaphoneKey($transliterate = true) { return CUString::metaphoneKey($this, $transliterate); }