GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PPIX::EDITORTOOLS::RENAMEVARIABLE (3)

.ds Aq ’

NAME

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

CONTENTS

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 ) =item rename( code => Str $code, line => Int, column => Int, to_camel_case => Bool, [ucfirst => Bool] ) =item rename( code => Str $code, line => Int, column => Int, from_camel_case => Bool, [ucfirst => Bool] ) 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.

Instead of specifying an explicit replacement variable name, you may choose to use the to_camel_case or from_camel_case options that automatically convert to/from camelCase. In that mode, the ucfirst option will force uppercasing of the first letter.

You can not specify a replacement name and use the to/from_camel_case options.

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.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PPIX::EDITORTOOLS::RENAMEVARIABLE (3) 2014-09-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.