Adam Kennedy > File-Tasks-0.07 > File::Tasks::Edit

Download:
File-Tasks-0.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.07   Source  

NAME ^

File::Tasks::Edit - A File::Tasks edit task (change a file)

DESCRIPTION ^

The File::Tasks::Edit task is similar to the File::Tasks::Add task, except that it expects a current file to already exists, which it will change the contents of (without changing permissions).

METHODS ^

new $Tasks, $path, $source

Creates a new File::Tasks::Edit object, although you probably won't be creating this object directly from here.

Returns a new File::Tasks::Edit object, or undef on error.

type

Returns the task type, which is always 'Edit'.

path

The path accessor returns the path to the file within the set of tasks.

source

The source accessor returns the content source, which could be anything supported by File::Tasks::Provider.

test

The test method checks to see if the file can be edited.

Returns true if so, or false if not.

execute

The execute method executes the task on the local filesystem.

Returns true on success or undef on error.

content

The content method returns the content that is to be written to the file.

SUPPORT ^

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Tasks

For other issues, contact the author.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>, http://ali.as/

COPYRIGHT ^

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

syntax highlighting: