|
Packit |
26bf30 |
=head1 NAME
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
File::Find::Object::Rule::Extending - the mini-guide to extending File::Find::Object::Rule
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 SYNOPSIS
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
package File::Find::Object::Rule::Random;
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
use strict;
|
|
Packit |
26bf30 |
use warnings;
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
# take useful things from File::Find::Object::Rule
|
|
Packit |
26bf30 |
use base 'File::Find::Object::Rule';
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
# and force our crack into the main namespace
|
|
Packit |
26bf30 |
sub File::Find::Object::Rule::random () {
|
|
Packit |
26bf30 |
my $self = shift()->_force_object;
|
|
Packit |
26bf30 |
$self->exec( sub { rand > 0.5 } );
|
|
Packit |
26bf30 |
}
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
1;
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 DESCRIPTION
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
L<File::Find::Object::Rule> inherits L<File::Find::Rule>'s extensibility. It
|
|
Packit |
26bf30 |
is now possibile to extend it, using the following conventions.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head2 Declare your package
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
package File::Find::Object::Rule::Random;
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
use strict;
|
|
Packit |
26bf30 |
use warnings;
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head2 Inherit methods from File::Find::Object::Rule
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
# take useful things from File::Find::Object::Rule
|
|
Packit |
26bf30 |
use base 'File::Find::Object::Rule';
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head3 Force your madness into the main package
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
# and force our crack into the main namespace
|
|
Packit |
26bf30 |
sub File::Find::Object::Rule::random () {
|
|
Packit |
26bf30 |
my $self = shift()->_force_object;
|
|
Packit |
26bf30 |
$self->exec( sub { rand > 0.5 } );
|
|
Packit |
26bf30 |
}
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
Yes, we're being very cavalier here and defining things into the main
|
|
Packit |
26bf30 |
File::Find::Object::Rule namespace. This is due to lack of imaginiation on my
|
|
Packit |
26bf30 |
part - I simply can't find a way for the functional and oo interface
|
|
Packit |
26bf30 |
to work without doing this or some kind of inheritance, and
|
|
Packit |
26bf30 |
inheritance stops you using two File::Find::Object::Rule::Foo modules
|
|
Packit |
26bf30 |
together.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
For this reason try and pick distinct names for your extensions. If
|
|
Packit |
26bf30 |
this becomes a problem then I may institute a semi-official registry
|
|
Packit |
26bf30 |
of taken names.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head2 Taking no arguments.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
Note the null prototype on random. This is a cheat for the procedural
|
|
Packit |
26bf30 |
interface to know that your sub takes no arguments, and so allows this
|
|
Packit |
26bf30 |
to happen:
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
find( random => in => '.' );
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
If you hadn't declared C<random> with a null prototype it would have
|
|
Packit |
26bf30 |
consumed C<in> as a parameter to it, then got all confused as it
|
|
Packit |
26bf30 |
doesn't know about a C<'.'> rule.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 NOTES ABOUT THE CALLBACK
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
The callback can access the L<File::Find::Object::Result> using
|
|
Packit |
26bf30 |
C<<< $self->finder->item_obj() >>>.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 AUTHOR
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
Richard Clamp <richardc@unixbeard.net>
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 COPYRIGHT
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
Copyright (C) 2002 Richard Clamp. All Rights Reserved.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
This module is free software; you can redistribute it and/or modify it
|
|
Packit |
26bf30 |
under the same terms as Perl itself.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=head1 SEE ALSO
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
L<File::Find::Object::Rule>
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
L<File::Find::::Rule::MMagic> was the first extension module for
|
|
Packit |
26bf30 |
L<File::Find::Rule>, so maybe check that out.
|
|
Packit |
26bf30 |
|
|
Packit |
26bf30 |
=cut
|