Newer Older
217 lines | 5.904kb
packaging one directory
yuki-kimoto authored on 2009-11-16
1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2
.\"
3
.\" Standard preamble:
4
.\" ========================================================================
5
.de Sh \" Subsection heading
6
.br
7
.if t .Sp
8
.ne 5
9
.PP
10
\fB\\$1\fR
11
.PP
12
..
13
.de Sp \" Vertical space (when we can't use .PP)
14
.if t .sp .5v
15
.if n .sp
16
..
17
.de Vb \" Begin verbatim text
18
.ft CW
19
.nf
20
.ne \\$1
21
..
22
.de Ve \" End verbatim text
23
.ft R
24
.fi
25
..
26
.\" Set up some character translations and predefined strings.  \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote.  | will give a
29
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
32
.tr \(*W-|\(bv\*(Tr
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34
.ie n \{\
35
.    ds -- \(*W-
36
.    ds PI pi
37
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39
.    ds L" ""
40
.    ds R" ""
41
.    ds C` ""
42
.    ds C' ""
43
'br\}
44
.el\{\
45
.    ds -- \|\(em\|
46
.    ds PI \(*p
47
.    ds L" ``
48
.    ds R" ''
49
'br\}
50
.\"
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD.  Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
55
.if \nF \{\
56
.    de IX
57
.    tm Index:\\$1\t\\n%\t"\\$2"
58
..
59
.    nr % 0
60
.    rr F
61
.\}
62
.\"
63
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
65
.hy 0
66
.if n .na
67
.\"
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70
.    \" fudge factors for nroff and troff
71
.if n \{\
72
.    ds #H 0
73
.    ds #V .8m
74
.    ds #F .3m
75
.    ds #[ \f1
76
.    ds #] \fP
77
.\}
78
.if t \{\
79
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80
.    ds #V .6m
81
.    ds #F 0
82
.    ds #[ \&
83
.    ds #] \&
84
.\}
85
.    \" simple accents for nroff and troff
86
.if n \{\
87
.    ds ' \&
88
.    ds ` \&
89
.    ds ^ \&
90
.    ds , \&
91
.    ds ~ ~
92
.    ds /
93
.\}
94
.if t \{\
95
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101
.\}
102
.    \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
.    \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
.    \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
117
\{\
118
.    ds : e
119
.    ds 8 ss
120
.    ds o a
121
.    ds d- d\h'-1'\(ga
122
.    ds D- D\h'-1'\(hy
123
.    ds th \o'bp'
124
.    ds Th \o'LP'
125
.    ds ae ae
126
.    ds Ae AE
127
.\}
128
.rm #[ #] #H #V #F C
129
.\" ========================================================================
130
.\"
131
.IX Title "DBIx::Custom::Basic 3"
132
.TH DBIx::Custom::Basic 3 "2009-11-16" "perl v5.8.8" "User Contributed Perl Documentation"
133
.SH "NAME"
134
DBIx::Custom::Basic \- DBIx::Custom basic implementation
135
.SH "Version"
136
.IX Header "Version"
137
Version 0.0201
138
.SH "See DBIx::Custom documentation"
139
.IX Header "See DBIx::Custom documentation"
140
This class is DBIx::Custom subclass.
141
.PP
142
You can use all methods of DBIx::Custom
143
.PP
144
Please see DBIx::Custom documentation
145
.SH "Filters"
146
.IX Header "Filters"
147
.Sh "encode_utf8"
148
.IX Subsection "encode_utf8"
149
.Vb 2
150
\&    # Encode to UTF-8 byte stream (utf8::upgrade is done if need)
151
\&    $dbi->filters->{encode_utf8}->($value);
152
.Ve
153
.PP
154
This filter is generally used as bind filter
155
.PP
156
.Vb 1
157
\&    $dbi->bind_filter($dbi->filters->{encode_utf8});
158
.Ve
159
.Sh "decode_utf8"
160
.IX Subsection "decode_utf8"
161
.Vb 2
162
\&    # Decode to perl internal string
163
\&    $dbi->filters->{decode_utf8}->($value);
164
.Ve
165
.PP
166
This filter is generally used as fetch filter
167
.PP
168
.Vb 1
169
\&    $dbi->fetch_filter($dbi->filters->{decode_utf8});
170
.Ve
171
.Sh "Formats"
172
.IX Subsection "Formats"
173
strptime formats is available
174
.PP
175
.Vb 7
176
\&    # format name        format
177
\&    'SQL99_date'         '%Y-%m-%d',
178
\&    'SQL99_datetime'     '%Y-%m-%d %H:%M:%S',
179
\&    'SQL99_time'         '%H:%M:%S',
180
\&    'ISO-8601_date'      '%Y-%m-%d',
181
\&    'ISO-8601_datetime'  '%Y-%m-%dT%H:%M:%S',
182
\&    'ISO-8601_time'      '%H:%M:%S',
183
.Ve
184
.PP
185
You get format as the following
186
.PP
187
.Vb 1
188
\&    my $format = $dbi->formats->{$format_name};
189
.Ve
190
.SH "Methods"
191
.IX Header "Methods"
192
.Sh "utf8_filter_on"
193
.IX Subsection "utf8_filter_on"
194
.Vb 2
195
\&    # Encode and decode utf8 filter on
196
\&    $dbi->utf8_filter_on;
197
.Ve
198
.PP
199
This equel to
200
.PP
201
.Vb 2
202
\&    $dbi->bind_filter($dbi->filters->{encode_utf8});
203
\&    $dbi->fetch_filter($dbi->filters->{decode_utf8});
204
.Ve
205
.SH "AUTHOR"
206
.IX Header "AUTHOR"
207
Yuki Kimoto, \f(CW\*(C`<kimoto.yuki at gmail.com>\*(C'\fR
208
.PP
209
Github <http://github.com/yuki\-kimoto>
210
.PP
211
I develope this module <http://github.com/yuki\-kimoto/DBIx\-Custom>
212
.SH "COPYRIGHT & LICENSE"
213
.IX Header "COPYRIGHT & LICENSE"
214
Copyright 2009 Yuki Kimoto, all rights reserved.
215
.PP
216
This program is free software; you can redistribute it and/or modify it
217
under the same terms as Perl itself.