View on
MetaCPAN
Yanick Champoux > PPIx-EditorTools > PPIx::EditorTools::RenamePackage

Download:
PPIx-EditorTools-0.20.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.20   Source  

NAME ^

PPIx::EditorTools::RenamePackage - Change the package name

VERSION ^

version 0.20

SYNOPSIS ^

    my $munged = PPIx::EditorTools::RenamePackage->new->rename(
        code        => <<'END_CODE',
            package TestPackage;
            use strict;

            BEGIN { $^W = 1; }
            1;
    END_CODE
        replacement => 'NewPackage'
    );

    my $new_code_as_string = $munged->code;
    my $package_ppi_element = $munged->element;

DESCRIPTION ^

This module uses PPI to change the package name of code.

METHODS ^

new()

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

rename( ppi => PPI::Document $ppi, replacement => Str )
rename( code => Str $code, 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. Replaces the package name 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.

Croaks with a "package name not found" exception if unable to find the package name.

SEE ALSO ^

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

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..

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

syntax highlighting: