File: README

package info (click to toggle)
libmethod-alias-perl 1.03-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, sid, stretch
  • size: 144 kB
  • ctags: 71
  • sloc: perl: 897; makefile: 2
file content (105 lines) | stat: -rw-r--r-- 3,101 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
NAME
    Method::Alias - Create method aliases (and do it safely)

SYNOPSIS
      # My method
      sub foo {
          ...
      }
  
      # Alias the method
      use Method::Alias 'bar' => 'foo',
                        'baz' => 'foo';

DESCRIPTION
    For a very long time, whenever I wanted to have a method alias (provide
    an alternate name for a method) I would simple do a GLOB alias. That is,

      # My method
      sub foo {
          ...
      }
  
      # Alias the method
      *bar = *foo;

    While this works fine for functions, it does not work for methods.

    If your class has a subclass that redefines "foo", any call to "bar"
    will result in the overloaded method being ignored and the wrong "foo"
    method being called.

    These are basically bugs waiting to happen, and having completed a
    number of very large APIs with lots of depth myself, I've been bitten
    several times.

    In this situation, the canonical and fasest way to handle an alias looks
    something like this.

      # My method
      sub foo {
         ...
      }
  
      # Alias the method
      sub bar { shift->foo(@_) }

    Note that this adds an extra entry to the caller array, but this isn't
    really all that important unless you are paranoid about these things.

    The alternative would be to try to find the method using UNIVERSAL::can,
    and then goto it. I might add this later if someone really wants it, but
    until then the basic method will suffice.

    That doing this right is even worthy of a module is debatable, but I
    would rather have something that looks like a method alias definition,
    than have to document additional methods all the time.

  Using Method::Alias
    Method::Alias is designed to be used as a pragma, to which you provide a
    set of pairs of method names. Only very minimal checking is done, if you
    wish to create infinite loops or what have you, you are more than
    welcome to shoot yourself in the foot.

      # Add a single method alias
      use Method::Alias 'foo' => 'bar';
  
      # Add several method aliases
      use Method::Alias 'a' => 'b',
                        'c' => 'd',
                        'e' => 'f';

    And for now, that's all there is to it.

METHODS
  import from => to, ...
    Although primarily used as a pragma, you may call import directly if you
    wish.

    Taking a set of pairs of normal strings, the import method creates a
    number of methods in the caller's package to call the real method.

    Returns true, or dies on error.

SUPPORT
    Bugs should always be submitted via the CPAN bug tracker

    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Method-Alias>

    For other issues, contact the maintainer

AUTHORS
    Adam Kennedy <cpan@ali.as>

SEE ALSO
    <http://ali.as/>

COPYRIGHT
    Copyright 2004, 2006 Adam Kennedy. All rights reserved.

    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

    The full text of the license can be found in the LICENSE file included
    with this module.