.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MooseX::Aliases 3pm" .TH MooseX::Aliases 3pm "2013-07-12" "perl v5.18.1" "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" MooseX::Aliases \- easy aliasing of methods and attributes in Moose .SH "VERSION" .IX Header "VERSION" version 0.11 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& package MyApp; \& use Moose; \& use MooseX::Aliases; \& \& has this => ( \& isa => \*(AqStr\*(Aq, \& is => \*(Aqrw\*(Aq, \& alias => \*(Aqthat\*(Aq, \& ); \& \& sub foo { my $self = shift; print $self\->that } \& alias bar => \*(Aqfoo\*(Aq; \& \& my $o = MyApp\->new(); \& $o\->this(\*(AqHello World\*(Aq); \& $o\->bar; # prints \*(AqHello World\*(Aq .Ve .PP or .PP .Vb 3 \& package MyApp::Role; \& use Moose::Role; \& use MooseX::Aliases; \& \& has this => ( \& isa => \*(AqStr\*(Aq, \& is => \*(Aqrw\*(Aq, \& alias => \*(Aqthat\*(Aq, \& ); \& \& sub foo { my $self = shift; print $self\->that } \& alias bar => \*(Aqfoo\*(Aq; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The MooseX::Aliases module will allow you to quickly alias methods in Moose. It provides an alias parameter for \f(CW\*(C`has()\*(C'\fR to generate aliased accessors as well as the standard ones. Attributes can also be initialized in the constructor via their aliased names. .PP You can create more than one alias at once by passing a arrayref: .PP .Vb 3 \& has ip_addr => ( \& alias => [ qw(ipAddr ip) ], \& ); .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "alias \s-1ALIAS METHODNAME\s0" .IX Subsection "alias ALIAS METHODNAME" Installs \s-1ALIAS\s0 as a method that is aliased to the method \s-1METHODNAME.\s0 .SH "ALIASING VERSUS OTHER MOOSE FEATURES" .IX Header "ALIASING VERSUS OTHER MOOSE FEATURES" .SS "Aliasing versus inheritance" .IX Subsection "Aliasing versus inheritance" .Vb 7 \& { \& package Parent; \& use Moose; \& use MooseX::Aliases; \& sub method1 { "A" } \& alias method2 => "method1"; \& } \& \& { \& package Child1; \& use Moose; \& extends "Parent"; \& sub method1 { "B" } \& } \& \& { \& package Child2; \& use Moose; \& extends "Parent"; \& sub method2 { "C" } \& } .Ve .PP In the example above, Child1 overrides the method using its original name (\f(CW\*(C`method1\*(C'\fR). As a result, calling \f(CW\*(C`method1\*(C'\fR or \&\f(CW\*(C`method2\*(C'\fR returns \*(L"B\*(R". Child2 overrides the method using its alias (\f(CW\*(C`method2\*(C'\fR). As a result, calling \f(CW\*(C`method2\*(C'\fR returns \*(L"C\*(R", but calling \f(CW\*(C`method1\*(C'\fR falls through to the parent class, so returns \*(L"A\*(R". .SS "Aliasing versus method modifiers" .IX Subsection "Aliasing versus method modifiers" .Vb 8 \& { \& package Class1; \& use Moose; \& use MooseX::Aliases; \& sub method1 { "A" } \& alias method2 => "method1"; \& around method1 => sub { "B" }; \& } \& \& { \& package Class2; \& use Moose; \& use MooseX::Aliases; \& sub method1 { "A" } \& alias method2 => "method1"; \& around method2 => sub { "B" }; \& } .Ve .PP In the example above, Class1's around modifier modifies the method using its original name. As a result, both \f(CW\*(C`method1\*(C'\fR and \f(CW\*(C`method2\*(C'\fR return \*(L"B\*(R". Class2's around modifier modifies the alias, so \f(CW\*(C`method2\*(C'\fR returns \*(L"B\*(R", but \f(CW\*(C`method1\*(C'\fR continues to return \*(L"A\*(R". .SH "BUGS" .IX Header "BUGS" No known bugs. .PP Please report any bugs to GitHub Issues at . .SH "SEE ALSO" .IX Header "SEE ALSO" Method::Alias .SH "SUPPORT" .IX Header "SUPPORT" You can find this documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc MooseX::Aliases .Ve .PP You can also look for information at: .IP "\(bu" 4 MetaCPAN .Sp .IP "\(bu" 4 Github .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Jesse Luehrs .IP "\(bu" 4 Chris Prather .IP "\(bu" 4 Justin Hunter .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Jesse Luehrs. .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.