1PPI::Token::Symbol(3) User Contributed Perl DocumentationPPI::Token::Symbol(3)
2
3
4

NAME

6       PPI::Token::Symbol - A token class for variables and other symbols
7

INHERITANCE

9         PPI::Token::Symbol
10         isa PPI::Token
11             isa PPI::Element
12

DESCRIPTION

14       The "PPI::Token::Symbol" class is used to cover all tokens that
15       represent variables and other things that start with a sigil.
16

METHODS

18       This class has several methods beyond what is provided by its
19       PPI::Token and PPI::Element parent classes.
20
21       Most methods are provided to help work out what the object is actually
22       pointing at, rather than what it might appear to be pointing at.
23
24   canonical
25       The "canonical" method returns a normalized, canonical version of the
26       symbol.
27
28       For example, it converts "$ ::foo'bar::baz" to $main::foo::bar::baz.
29
30       This does not fully resolve the symbol, but merely removes syntax
31       variations.
32
33   symbol
34       The "symbol" method returns the ACTUAL symbol this token refers to.
35
36       A token of $foo might actually be referring to @foo, if it is found in
37       the form $foo[1].
38
39       This method attempts to resolve these issues to determine the actual
40       symbol.
41
42       Returns the symbol as a string.
43
44   raw_type
45       The "raw_type" method returns the apparent type of the symbol in the
46       form of its sigil.
47
48       Returns the sigil as a string.
49
50   symbol_type
51       The "symbol_type" method returns the actual type of the symbol in the
52       form of its sigil.
53
54       Returns the sigil as a string.
55

SUPPORT

57       See the support section in the main module.
58

AUTHOR

60       Adam Kennedy <adamk@cpan.org>
61

63       Copyright 2001 - 2011 Adam Kennedy.
64
65       This program is free software; you can redistribute it and/or modify it
66       under the same terms as Perl itself.
67
68       The full text of the license can be found in the LICENSE file included
69       with this module.
70
71
72
73perl v5.16.3                      2011-02-26             PPI::Token::Symbol(3)
Impressum