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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 
<?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\name;

/**
 * (偽名の)ある人を表すクラス
 *
 * 名字・名前の漢字・かな・カナ表記と性別を保持する
 *
 * @property-read NameUnit first 名前
 * @property-read NameUnit last 名字
 * @property-read bool isMale 男性であれば true
 * @property-read bool isFemale 女性であれば true
 */
class Person
{
    /**
     * 名前
     * @var NameUnit
     */
    private $firstName;

    /**
     * 名字
     * @var NameUnit
     */
    private $lastName;

    /**
     * 性別。男性なら true
     * @var bool
     */
    private $isMale;

    /**
     * コンストラクタ
     *
     * @param NameUnit $firstName 名前
     * @param NameUnit $lastName 名字
     * @param bool $isMale 男性ならtrue、女性ならfalse
     */
    public function __construct(NameUnit $firstName, NameUnit $lastName, $isMale)
    {
        $this->firstName = $firstName;
        $this->lastName = $lastName;
        $this->isMale = !!$isMale;
    }

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

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

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

    /**
     * 性別を取得。男性なら true
     *
     * @return bool
     */
    public function isMale()
    {
        return $this->isMale;
    }

    /**
     * 性別を取得。女性なら true
     *
     * @return bool
     */
    public function isFemale()
    {
        return !$this->isMale;
    }

    /**
     * 名前を取得
     *
     * @return NameUnit
     */
    public function getFirstName()
    {
        return $this->firstName;
    }

    /**
     * 名字を取得
     *
     * @return NameUnit
     */
    public function getLastName()
    {
        return $this->lastName;
    }

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

    /**
     * @inherit
     * @param string $key
     * @return string|null
     */
    public function __get($key)
    {
        switch ($key) {
            case 'kanji':
                return $this->getKanji();

            case 'hiragana':
                return $this->getHiragana();

            case 'katakana':
                return $this->getKatakana();

            case 'isMale':
            case 'is_male':
                return $this->isMale();

            case 'isFemale':
            case 'is_female':
                return $this->isFemale();

            case 'firstName':
            case 'first_name':
            case 'first':
                return $this->getFirstName();

            case 'lastName':
            case 'last_name':
            case 'last':
                return $this->getLastName();
        }
    }

    /**
     * 名字と名前をフォーマットした文字列を取得
     *
     * @param string $key "kanji" | "hiragana" | "katakana"
     * @return string
     */
    private function toString($key)
    {
        return sprintf(
            '%s %s',
            $this->lastName->$key,
            $this->firstName->$key
        );
    }
}
API documentation generated by ApiGen