LimelightResults

Contents

• General
• Method Index
• Methods

General

The LimelightResults object contains an array of Limelight\Classes\LimelightWord objects which hold all the information gained from the parse. LimelightResults contains methods to get parse information about the entire text while LimelightWord objects have methods to get information about individual words. Reflecting this usage, methods on LimelightResults are plural and LimelightWord methods are singular.

All examples in this section will use the following text.

$results = $limelight->parse('メキシコ料理ではライムを使うことがよくあります。');

Method Index

• furigana()
• lemmas()
• original()
• partsOfSpeech()
• plugin()
• pronunciations()
• readings()
• romaji()
• string()
• toHiragana()
• toKatakana()
• words()

Methods

furigana()

Get furigana for each word.

$furigana = $results->furigana()->all();

// [
//   'メキシコ',
//   '<ruby><rb>料理</rb><rp>(</rp><rt>りょうり</rt><rp>)</rp></ruby>',
//   'で',
//   'は',
//   'ライム',
//   'を',
//   '<ruby><rb>使</rb><rp>(</rp><rt>つか</rt><rp>)</rp></ruby>う',
//   'こと',
//   'が',
//   'よく',
//   'あります',
//   '。'
// ]

---

lemmas()

Get text lemmas (dictionary forms).

$output = $results->lemmas()->all();

// [
//   'メキシコ',
//   '料理',
//   'で',
//   'は',
//   'ライム',
//   'を',
//   '使う',
//   'こと',
//   'が',
//   'よく',
//   'ある',
//   '。'
// ]

---

original()

Get the original text.

$output = $results->original();

// メキシコ料理ではライムを使うことがよくあります。

---

partsOfSpeech()

Get text parts of speech. Spaces will appear between words by default. (Note that the method is called partsOfSpeech() rather than the awkward partOfSpeechs.)

$partsOfSpeech = $results->partsOfSpeech()->all();

// [
//   'proper noun',
//   'noun',
//   'postposition',
//   'postposition',
//   'noun',
//   'postposition',
//   'verb',
//   'noun',
//   'postposition',
//   'adverb',
//   'verb',
//   'symbol'
// ]

---

plugin()

Get any plugin data stored on the LimelightResults object.

$furigana = $results->plugin('furigana');

// 'メキシコ<ruby><rb>料理</rb><rp>(</rp><rt>りょうり</rt><rp>)</rp></ruby>ではライムを<ruby><rb>使</rb><rp>(</rp><rt>つか</rt><rp>)</rp></ruby>うことがよくあります。'

---

pronunciations()

Get text pronunciations. Output is similar to readings, but long vowels are indicated by 'ー'.

$pronunciations = $results->pronunciations()->all();

// [
//   'メキシコ',
//   'リョーリ',
//   'デ',
//   'ワ',
//   'ライム',
//   'ヲ',
//   'ツカウ',
//   'コト',
//   'ガ',
//   'ヨク',
//   'アリマス',
//   '。'
// ]

---

readings()

Get text readings.

$readings = $results->readings()->all();

// [
//   'メキシコ',
//   'リョウリ',
//   'デ',
//   'ワ',
//   'ライム',
//   'ヲ',
//   'ツカウ',
//   'コト',
//   'ガ',
//   'ヨク',
//   'アリマス',
//   '。'
// ]

---

romaji()

Convert text to romaji.

$romaji = $results->romaji()->all();

// [
//   'Mekishiko',
//   'ryōri',
//   'de',
//   'wa',
//   'raimu',
//   'o',
//   'tsukau',
//   'koto',
//   'ga',
//   'yoku',
//   'arimasu',
//   '.'
// ]

---

string()

Get values as string.

$string = $results->string('word');

// 'メキシコ料理ではライムを使うことがよくあります。'

Pass a word divider as the second argument. If the word divider is a space, the space will not appear before symbols.

$string = $results->string('romaji', ' ');

// 'Mekishiko ryōri de wa raimu o tsukau koto ga yoku arimasu.'

---

toHiragana()

Convert kana in all items to hiragana.

$hiraganaReadings = $results->toHiragana()->readings()->all();

// [
//   'めきしこ',
//   'りょうり',
//   'で',
//   'は',
//   'らいむ',
//   'を',
//   'つかう',
//   'こと',
//   'が',
//   'よく',
//   'あります',
//   '。'
// ]

---

toKatakana()

Convert kana in all items to hiragana.

$katakanaWords = $results->toKatakana()->words()->all();

// [
//   'メキシコ',
//   '料理',
//   'デ',
//   'ワ',
//   'ライム',
//   'ヲ',
//   '使ウ',
//   'コト',
//   'ガ',
//   'ヨク',
//   'アリマス',
//   '。'
// ]

---

words()

Get text words.

$words = $results->words()->all();

// [
//   'メキシコ',
//   '料理',
//   'で',
//   'は',
//   'ライム',
//   'を',
//   '使う',
//   'こと',
//   'が',
//   'よく',
//   'あります',
//   '。'
// ]