-
-
19 Jul 2022 21:50:31 UTC
- Distribution: PPI
- Module version: 1.276
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (907 / 0 / 0)
- Kwalitee
Bus factor: 2- 85.12% Coverage
- License: perl_5
- Perl: v5.6.0
- Activity
24 month- Tools
- Download (239.45KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 44 contributors-
Adam Kennedy
-
Arnout Pierre
-
bowtie
-
brian d foy
-
Chas. J. Owens IV
-
Chris Capaci
-
Chris Dolan
-
Christian Walde
-
Colin Newell
-
Damyan Ivanov
-
Dan Book
-
David Steinbrunner
-
Edmund Adjei
-
Elliot Shank
-
Gabor Szabo
-
Graham Knop
-
Graham Ollis
-
Guillaume Aubert
-
James E Keenan
-
Joel Maslak
-
Julian Fondren
-
Karen Etheridge
-
Kent Fredric
-
Lance Wicks
-
Matt Church
-
Matthew Horsfall
-
Mike O'Regan
-
Milos Kukla
-
Mohammad S Anwar
-
nanto_vi
-
Olaf Alders
-
Olivier Mengué
-
Philippe Bruhat (BooK)
-
Randy Lauen
-
Reini Urban
-
reneeb
-
Shmuel Fomberg
-
Steffen Müller
-
Szymon Nieznański
-
Takumi Akiyama
-
Thomas Sibley
-
Tom Wyant
-
Van de Bugger
-
Will Braswell
- Dependencies
- Carp
- Clone
- Digest::MD5
- Exporter
- File::Path
- File::Spec
- List::Util
- Params::Util
- Scalar::Util
- Storable
- Task::Weaken
- constant
- if
- overload
- strict
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
PPI::Document::File - A Perl Document located in a specific file
DESCRIPTION
WARNING: This class is experimental, and may change without notice
PPI::Document::File provides a PPI::Document subclass that represents a Perl document stored in a specific named file.
METHODS
new
my $file = PPI::Document::File->new( 'Module.pm' );
The
new
constructor works the same as for the regular one, except that the only params allowed is a file name. You cannot create an "anonymous" PPI::Document::File object, not can you create an empty one.Returns a new PPI::Document::File object, or
undef
on error.save
# Save to the file we were loaded from $file->save; # Save a copy to somewhere else $file->save( 'Module2.pm' );
The
save
method works similarly to the one in the parent PPI::Document class, saving a copy of the document to a file.The difference with this subclass is that if
save
is not passed any filename, it will save it back to the file it was loaded from.Note: When saving to a different file, it is considered to be saving a copy and so the value returned by the
filename
accessor will stay the same, and not change to the new filename.TO DO
- May need to overload some methods to forcefully prevent Document objects becoming children of another Node.
SUPPORT
See the support section in the main module.
AUTHOR
Adam Kennedy <adamk@cpan.org>
COPYRIGHT
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.
Module Install Instructions
To install PPI, copy and paste the appropriate command in to your terminal.
cpanm PPI
perl -MCPAN -e shell install PPI
For more information on module installation, please visit the detailed CPAN module installation guide.