オープンソース・ソフトウェアの開発とダウンロード

CVS リポジトリの参照

Contents of /perldocjp/docs/modules/Date-Japanese-Era-0.03/lib/Date/Japanese/Era.pod

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.3 - (show annotations) (download)
Thu Jan 27 13:14:51 2011 UTC (13 years, 3 months ago) by iwai
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +3 -0 lines
add encoding tag

1
2 =encoding euc-jp
3
4 =head1 NAME
5
6 Date::Japanese::Era - 和暦と西暦の相互変換
7
8 =head1 SYNOPSIS
9
10 use Date::Japanese::Era;
11
12 # グレゴリア暦から (月と日が必須)
13 $era = Date::Japanese::Era->new(1970, 1, 1);
14
15 # 和暦から
16 $era = Date::Japanese::Era->new('昭和', 52);
17
18 $name = $era->name; # '昭和' in EUC-jp (default)
19 $gengou = $era->gengou; # 同上
20
21 $year = $era->year; # 52
22 $gregorian = $era->gregorian_year; # 1977
23
24 # JIS X0301 テーブルを変換に使用する
25 use Date::Japanese::Era 'JIS_X0301';
26
27 =head1 DESCRIPTION
28
29 Date::Japanese::Era は和暦と西暦(グレゴリア暦)の相互変換を行うモジュー
30 ルです。
31
32 =head1 METHODS
33
34 =over 4
35
36 =item codeset
37
38 $codeset = Date::Japanese::Era->codeset;
39 Date::Japanese::Era->codeset($encoding);
40
41 和暦の文字エンコーディングを設定/取得します。例えば以下のコードでは、
42 和暦の入出力は UTF-8 エンコードされます。
43
44 Date::Japanese::Era->codeset('utf8');
45 $era = Date::Japanese::Era->new($name, $year); # $name は UTF-8
46 print $era->name; # これも UTF-8
47
48 この機能を利用するには Jcode モジュールが必要です。ない場合には
49 codeset() の呼び出しは、warning が出力され、無視されます。
50
51 =item new
52
53 $era = Date::Japanese::Era->new($year, $month, $day);
54 $era = Date::Japanese::Era->new($era_name, $year);
55
56 あたらしく Date::Japanese::Era クラスのインスタンスを生成します。グレ
57 ゴリア暦から生成する場合には、月と日が必須です。グレゴリア暦からの変換
58 には Date::Calc が必要です。
59
60 元号名は日本語か ASCII のどちらでもかまいません。Jcode モジュールがイ
61 ンストールされている場合は、エンコードを codeset() で設定できます。デ
62 フォルトは EUC-JP です。
63
64 入力が不正な場合(たとえば、元号と年の存在しない組合せや、存在しない元
65 号名など)、例外が投げられます。
66
67 =item name
68
69 $name = $era->name;
70
71 元号名を日本語で返します。エンコーディングは codeset() で設定できます。
72 デフォルトは EUC-JP です。
73
74 =item gengou
75
76 name() の別名です。
77
78 =item name_ascii
79
80 $name_ascii = $era->name_ascii;
81
82 元号名を US-ASCII で返します。
83
84 =item year
85
86 $year = $era->year;
87
88 年を和暦で返します。
89
90 =item gregorian_year
91
92 $year = $era->gregorian_year;
93
94 年をグレゴリア暦で返します。
95
96 =back
97
98 =head1 EXAMPLES
99
100 # 2001年は H-13
101 my $era = Date::Japanese::Era->new(2001, 8, 31);
102 printf "%s-%s", uc(substr($era->name_ascii, 0, 1)), $era->year;
103
104 # 西暦に変換
105 my $era = Date::Japanese::Era->new('平成', 13);
106 print $era->gregorian_year; # 2001
107
108 =head1 CAVEATS
109
110 =over 4
111
112 =item *
113
114 元号が変わった日は新しい方(後の方)の元号で扱われます。
115
116 =item *
117
118 現状サポートしているのは「明治」以降です。
119
120 =item *
121
122 もし現在の元号(平成)が変わった場合、Date::Japanese::Era::Table をアッ
123 プグレードする必要があります。(Table はグローバル変数として定義してあ
124 るので、必要なら上書きすることとも出来ます)
125
126 =back
127
128 =head1 TODO
129
130 =over 4
131
132 =item *
133
134 日付パラメータはいろんなフォーマットがありえます。Date::Simple などで
135 置き換えるべきかもしれません。
136
137 =item *
138
139 もっと前の元号もサポート。
140
141 =back
142
143 =head1 AUTHOR
144
145 Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt>
146
147 This library is free software; you can redistribute it and/or
148 modify it under the same terms as Perl itself.
149
150 =head1 SEE ALSO
151
152 L<Date::Calc>, L<Jcode>, L<Date::Simple>
153
154 =cut

Back to OSDN">Back to OSDN
ViewVC Help
Powered by ViewVC 1.1.26