Mark Grimes > PPIx-EditorTools-0.08 > PPIx::EditorTools::RenameVariable

Download:
PPIx-EditorTools-0.08.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.07   Source   Latest Release: PPIx-EditorTools-0.18

NAME ^

PPIx::EditorTools::RenameVariable - Lexically replace a variable name in Perl code

SYNOPSIS ^

    my $munged = PPIx::EditorTools::RenameVariable->new->rename(
        code        => $code,
        line        => 15,
        column      => 13,
        replacement => 'stuff',
    );
    my $code_as_strig = $munged->code;
    my $code_as_ppi   = $munged->ppi;
    my $location      = $munged->element->location;

DESCRIPTION ^

This module will lexically replace a variable name.

METHODS ^

new()

Constructor. Generally shouldn't be called with any arguments.

rename( ppi => PPI::Document $ppi, line => Int, column => Int, replacement => Str ) =item rename( code => Str $code, line => Int, column => Int, replacement => Str )

Accepts either a PPI::Document to process or a string containing the code (which will be converted into a PPI::Document) to process. Renames the variable found at line, column with that supplied in the replacement parameter and returns a PPIx::EditorTools::ReturnObject with the new code available via the ppi or code accessors, as a PPI::Document or string, respectively. The PPI::Token found at line, column is available via the element accessor.

Croaks with a "no token" exception if no token is found at the location. Croaks with a "no declaration" exception if unable to find the declaration.

SEE ALSO ^

This class inherits from PPIx::EditorTools. Also see App::EditorTools, Padre, and PPI.

AUTHOR ^

Mark Grimes, <mgrimes@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (C) 2009 by Mark Grimes

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: