Scroll to navigation

PPI::Token::Symbol(3pm) User Contributed Perl Documentation PPI::Token::Symbol(3pm)


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


  isa PPI::Token
      isa PPI::Element


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


This class has several methods beyond what is provided by its PPI::Token and PPI::Element parent classes.

Most methods are provided to help work out what the object is actually pointing at, rather than what it might appear to be pointing at.


The "canonical" method returns a normalized, canonical version of the symbol.

For example, it converts "$ ::foo'bar::baz" to $main::foo::bar::baz.

This does not fully resolve the symbol, but merely removes syntax variations.


The "symbol" method returns the ACTUAL symbol this token refers to.

A token of $foo might actually be referring to @foo, if it is found in the form $foo[1].

This method attempts to resolve these issues to determine the actual symbol.

Returns the symbol as a string.


The "raw_type" method returns the apparent type of the symbol in the form of its sigil.

Returns the sigil as a string.


The "symbol_type" method returns the actual type of the symbol in the form of its sigil.

Returns the sigil as a string.


See the support section in the main module.


Adam Kennedy <>


Copyright 2001 - 2011 Adam Kennedy.

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.

2022-07-23 perl v5.34.0