Overview
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • jp3cki
    • gimei
      • address
      • name

Classes

  • jp3cki\gimei\address\Address
  • jp3cki\gimei\address\AddressUnit
  • jp3cki\gimei\address\Dictionary
  • jp3cki\gimei\address\Factory
  • jp3cki\gimei\DataUnit
  • jp3cki\gimei\Gimei
  • jp3cki\gimei\name\Dictionary
  • jp3cki\gimei\name\Factory
  • jp3cki\gimei\name\Gender
  • jp3cki\gimei\name\NameUnit
  • jp3cki\gimei\name\Person

Exceptions

  • jp3cki\gimei\Exception
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 
<?php
/**
 * @author AIZAWA Hina <hina@bouhime.com>
 * @copyright 2015 AIZAWA Hina <hina@bouhime.com>
 * @license https://github.com/fetus-hina/gimei-php/blob/master/LICENSE MIT
 */

namespace jp3cki\gimei;

/**
 * 漢字・かな・カナをひとまとめにしたクラス
 *
 * @internal
 * @property-read string kanji 漢字表記
 * @property-read string hiragana かな表記
 * @property-read string katakana カナ表記
 */
class DataUnit
{
    /**
     * 漢字表記
     * @var string
     */
    private $kanji;

    /**
     * かな表記
     * @var string
     */
    private $hiragana;

    /**
     * カナ表記
     * @var string
     */
    private $katakana;

    /**
     * コンストラクタ
     *
     * @param string[] $data [漢字, かな, カナ] の配列
     */
    public function __construct(array $data)
    {
        $this->kanji = array_shift($data);
        $this->hiragana = array_shift($data);
        $this->katakana = array_shift($data);
    }

    /**
     * 漢字表記を取得
     *
     * @return string
     */
    public function getKanji()
    {
        return $this->kanji;
    }

    /**
     * かな表記を取得
     *
     * @return string
     */
    public function getHiragana()
    {
        return $this->hiragana;
    }

    /**
     * カナ表記を取得
     *
     * @return string
     */
    public function getKatakana()
    {
        return $this->katakana;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->getKanji();
    }

    /**
     * @return string|null
     */
    public function __get($key)
    {
        switch ($key) {
            case 'kanji':
                return $this->getKanji();
            case 'hiragana':
                return $this->getHiragana();
            case 'katakana':
                return $this->getKatakana();
        }
    }
}
API documentation generated by ApiGen