file::find::object::result(3pm) [debian man page]

File::Find::Object::Result(3pm) 			User Contributed Perl Documentation			   File::Find::Object::Result(3pm)

NAME

       File::Find::Object::Result - a result class for File::Find::Object

DESCRIPTION

       This is a class returning a single File::Find::Object result as returned by its next_obj() method.

METHODS

   File::Find::Object::Result->new({%args});
       Initializes a new object from %args. For internal use.

   $result->base()
       Returns the base directory from which searching began.

   $result->path()
       Returns the full path of the result. As such "$ffo->next_obj()->path()" is equivalent to "$ffo->next()" .

   $result->is_dir()
       Returns true if the result refers to a directory.

   $result->is_file()
       Returns true if the result refers to a plain file (equivalent to the Perl "-f" operator).

   $result->is_link()
       Returns true if the result is a symbolic link.

   $result->dir_components()
       The components of the directory part of the path starting from base() (also the full path if the result is a directory) as an array
       reference.

   $result->basename()
       Returns the basename of the file (if it is a file and not a directory.)	Otherwise - undef().

   $result->full_components()
       Returns the full components of the result with the basename if it is a file.

   $result->stat_ret()
       The return value of "stat" in perlfunc for the result, placed inside an array reference. This is calculated by File::Find::Object and kept
       here for convenience and for internal use.

SEE ALSO

       File::Find::Object

LICENSE

       Copyright (C) 2005, 2006 by Olivier Thauvin

       This package is free software; you can redistribute it and/or modify it under the following terms:

       1. The GNU General Public License Version 2.0 - http://www.opensource.org/licenses/gpl-license.php

       2. The Artistic License Version 2.0 - http://www.perlfoundation.org/legal/licenses/artistic-2_0.html

       3. At your option - any later version of either or both of these licenses.

perl v5.10.0							    2009-06-18					   File::Find::Object::Result(3pm)

File::Find::Rule::Extending(3)				User Contributed Perl Documentation			    File::Find::Rule::Extending(3)

NAME

       File::Find::Rule::Extending - the mini-guide to extending File::Find::Rule

SYNOPSIS

	package File::Find::Rule::Random;
	use strict;

	# take useful things from File::Find::Rule
	use base 'File::Find::Rule';

	# and force our crack into the main namespace
	sub File::Find::Rule::random () {
	    my $self = shift()->_force_object;
	    $self->exec( sub { rand > 0.5 } );
	}

	1;

DESCRIPTION

       File::Find::Rule went down so well with the buying public that everyone wanted to add extra features.  With the 0.07 release this became a
       possibility, using the following conventions.

   Declare your package
	package File::Find::Rule::Random;
	use strict;

   Inherit methods from File::Find::Rule
	# take useful things from File::Find::Rule
	use base 'File::Find::Rule';

       Force your madness into the main package

	# and force our crack into the main namespace
	sub File::Find::Rule::random () {
	    my $self = shift()->_force_object;
	    $self->exec( sub { rand > 0.5 } );
	}

       Yes, we're being very cavalier here and defining things into the main File::Find::Rule namespace.  This is due to lack of imaginiation on
       my part - I simply can't find a way for the functional and oo interface to work without doing this or some kind of inheritance, and
       inheritance stops you using two File::Find::Rule::Foo modules together.

       For this reason try and pick distinct names for your extensions.  If this becomes a problem then I may institute a semi-official registry
       of taken names.

   Taking no arguments.
       Note the null prototype on random.  This is a cheat for the procedural interface to know that your sub takes no arguments, and so allows
       this to happen:

	find( random => in => '.' );

       If you hadn't declared "random" with a null prototype it would have consumed "in" as a parameter to it, then got all confused as it doesn't
       know about a '.' rule.

AUTHOR

       Richard Clamp <richardc@unixbeard.net>

COPYRIGHT

       Copyright (C) 2002 Richard Clamp.  All Rights Reserved.

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

SEE ALSO

       File::Find::Rule

       File::Find::Rule::MMagic was the first extension module, so maybe check that out.

perl v5.18.2							    2011-09-19					    File::Find::Rule::Extending(3)