ppi::document::fragment(3pm) [debian man page]

PPI::Document::Fragment(3pm)				User Contributed Perl Documentation			      PPI::Document::Fragment(3pm)

NAME

       PPI::Document::Fragment - A fragment of a Perl Document

DESCRIPTION

       In some situations you might want to work with a fragment of a larger document. "PPI::Document::Fragment" is a class intended for this
       purpose.  It is functionally almost identical to a normal PPI::Document, except that it is not possible to get line/column positions for
       the elements within it, and it does not represent a scope.

METHODS

   index_locations
       Unlike when called on a PPI::Document object, you should not be attempting to find locations of things within a PPI::Document::Fragment,
       and thus any call to the "index_locations" will print a warning and return "undef" instead of attempting to index the locations of the
       Elements.

TO DO

       Integrate this into the rest of PPI so it has actual practical uses. The most obvious would be to implement arbitrary cut/copy/paste more
       easily.

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.

perl v5.10.1							    2011-02-26					      PPI::Document::Fragment(3pm)

PPI::Document::File(3)					User Contributed Perl Documentation				    PPI::Document::File(3)

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.

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

perl v5.18.2							    2011-02-25						    PPI::Document::File(3)