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


File-Tasks documentation  | view source Contained in the File-Tasks distribution.

Index


NAME

Top

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

DESCRIPTION

Top

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

Top

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

Top

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

Top

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

COPYRIGHT

Top


File-Tasks documentation  | view source Contained in the File-Tasks distribution.