NAME

App::Embra::Role::FilePruner - something that stops files from appearing in a site

VERSION

version 0.001

DESCRIPTION

This role should be implemented by any plugin which prevents files from appearing in your site. It provides one method ("prune_files"), and requires plugins provide an exclude_file method, which accepts a single App::Embra::File object and return true if the file should be removed.

prune_files will be called after all FileGatherer-type plugins have added files, and will remove from the site all files which cause "exclude_file" to return true.

METHODS

prune_files

$plugin->prune_files;

Passes each of the site's files to the plugin's exclude_file method, and removes the file from the site if the method returns true.

AUTHOR

Daniel Holz <dgholz@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Daniel Holz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.