.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "DBIx::Class::Candy::Exports 3pm" .TH DBIx::Class::Candy::Exports 3pm "2017-10-29" "perl v5.26.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" DBIx::Class::Candy::Exports \- Create sugar for your favorite ORM, DBIx::Class .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& package DBIx::Class::Widget; \& \& sub create_a_widget { ... } \& \& # so you don\*(Aqt depend on ::Candy \& eval { \& require DBIx::Class::Candy::Exports; \& DBIx::Class::Candy::Exports\->import; \& export_methods [\*(Aqcreate_a_widget\*(Aq]; \& export_method_aliases { \& widget => \*(Aqcreate_a_widget\*(Aq \& }; \& } \& \& 1; .Ve .PP The above will make it such that users of your component who use it with DBIx::Class::Candy will have the methods you designate exported into their namespace. .SH "DESCRIPTION" .IX Header "DESCRIPTION" The whole point of this module is to make sugar a first class citizen in the component world that dominates DBIx::Class. I make enough components and like this sugar idea enough that I want to be able to have both at the same time. .SH "IMPORTED SUBROUTINES" .IX Header "IMPORTED SUBROUTINES" .SS "export_methods" .IX Subsection "export_methods" .Vb 1 \& export_methods [qw( foo bar baz )]; .Ve .PP Use this subroutine to define methods that get exported as subroutines of the same name. .SS "export_method_aliases" .IX Subsection "export_method_aliases" .Vb 3 \& export_method_aliases { \& old_method_name => \*(Aqnew_sub_name\*(Aq, \& }; .Ve .PP Use this subroutine to define methods that get exported as subroutines of a different name. .SH "AUTHOR" .IX Header "AUTHOR" Arthur Axel \*(L"fREW\*(R" Schmidt .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2017 by Arthur Axel \*(L"fREW\*(R" Schmidt. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.