.\" Automatically generated by Pod::Man 4.10 (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 .. .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 .\" ======================================================================== .\" .IX Title "Kavorka::Manual::MethodModifiers 3pm" .TH Kavorka::Manual::MethodModifiers 3pm "2019-01-17" "perl v5.28.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" Kavorka::Manual::MethodModifiers \- before/after/around keywords .SH "DESCRIPTION" .IX Header "DESCRIPTION" Kavorka provides the \f(CW\*(C`before\*(C'\fR, \f(CW\*(C`after\*(C'\fR and \f(CW\*(C`around\*(C'\fR keywords for method modifiers. .PP Method modifiers should work in Moose, Moo, Mouse and Role::Tiny classes and roles. In other classes they will fall back to using Class::Method::Modifiers. .PP The keywords \f(CW\*(C`augment\*(C'\fR and \f(CW\*(C`override\*(C'\fR are also available, but will only work in classes backed by a framework that supports these modifiers (i.e. Moose or Mouse, but \fInot\fR Moo). .PP The anatomy of a method modifier: .IP "1." 4 The keyword introducing the method. .IP "2." 4 The method names. .IP "3." 4 The signature (optional). .IP "4." 4 Traits (optional). .IP "5." 4 The prototype (optional). .IP "6." 4 The attribute list (optional). .IP "7." 4 The modifier body. .PP Example: .PP .Vb 2 \& # (1) (2) (3) (4) (5) (6) (7) \& after foobar ($foo) is cool :($) :cached { $self\->log("foobar $foo") } .Ve .SS "The Keyword" .IX Subsection "The Keyword" By default, these keywords are exported. They must be exported by request: .PP .Vb 2 \& use Kavorka qw( before after around ); \& use Kavorka qw( \-modifiers ); .Ve .SS "The Method Names" .IX Subsection "The Method Names" These are the names of the methods being wrapped. .PP Multiple names may be separated by colons: .PP .Vb 1 \& after foo, bar, baz { ... } .Ve .SS "The Signature" .IX Subsection "The Signature" See Kavorka::Manual::Signatures. .PP The \f(CW\*(C`before\*(C'\fR and \f(CW\*(C`after\*(C'\fR keywords have a default invocant called \&\f(CW$self\fR, but it does not have a type constraint, so can equally be used for class or object methods. .PP The \f(CW\*(C`around\*(C'\fR modifier defines two invocants called \f(CW$next\fR and \&\f(CW$self\fR. (\f(CW\*(C`${^NEXT}\*(C'\fR is also available as an alias for \&\f(CW$next\fR for backwards compatibility with Moops::MethodModifiers.) .PP Beware using type constraints for method modifiers (which are essentially wrappers); constraints will be checked at each level of wrapping which will slow down method calls. .SS "Traits" .IX Subsection "Traits" See Kavorka::Manual::ExtendingKavorka. .SS "The Prototype" .IX Subsection "The Prototype" See Kavorka::Manual::PrototypeAndAttributes. .PP Note however that prototypes are fairly useless for methods. .SS "The Attributes" .IX Subsection "The Attributes" Attributes may alternatively be provided \fIbefore the signature\fR. .PP See Kavorka::Manual::PrototypeAndAttributes. .PP Note that this applies the attribute to the modifier code, and not to the method being modified. .SS "The Modifier Body" .IX Subsection "The Modifier Body" This is more or less what you'd expect from the modifier body you'd write with Moose, however the lexical variables for parameters are pre-declared and pre-populated, and invocants have been shifted off \f(CW@_\fR. .SH "BUGS" .IX Header "BUGS" Please report any bugs to . .SH "SEE ALSO" .IX Header "SEE ALSO" Kavorka::Manual, Kavorka::Manual::Signatures, Kavorka::Manual::PrototypeAndAttributes, Kavorka::Manual::Methods. .SH "AUTHOR" .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2013\-2014, 2017 by Toby Inkster. .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. .SH "DISCLAIMER OF WARRANTIES" .IX Header "DISCLAIMER OF WARRANTIES" \&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0