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  -  PPI::DOCUMENT::FILE (3)

.ds Aq ’

NAME

PPI::Document::File - A Perl Document located in a specific file

CONTENTS

DESCRIPTION

<B>WARNING: This class is experimental, and may change without noticeB>

<B>PPI::Document::FileB> 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.

    filename

The filename accessor returns the name of the file in which the document is stored.

    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 <B>copyB> 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PPI::DOCUMENT::FILE (3) 2014-11-11

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