axDirectoryFilterIterator Class Reference

Directory Filter Iterator. More...

Public Member Functions
	__construct (DirectoryIterator $iterator, array $exclude=array('.', '..'))
	Constructor.
	accept ()
	FilterIterator::accept() implementation http://www.php.net/manual/en/filteriterator.accept.php.
	exclude ($filename)
	Add on (or many) filenames to exclude from the Iterator.
Protected Attributes
	$_exclude
	Exclusion names.

---

Detailed Description

Directory Filter Iterator.

This class is defined as a DirectoryIterator wrapper where each valid elements are folder (excluding .. and .). Since Axiom 1.2.0, you may now add your own exclude names (for instance to ommit .git directory).

Author:

Delespierre

Copyright:

Copyright 2010-2011, Benjamin Delespierre (http://bdelespierre.fr)

License:

http://www.gnu.org/licenses/lgpl.html Lesser General Public Licence version 3

Definition at line 19 of file axDirectoryFilterIterator.class.php.

---

Constructor & Destructor Documentation

axDirectoryFilterIterator::__construct	(	DirectoryIterator $	iterator,
		array $	exclude = array('.', '..')
	)

Constructor.

Parameters:

DirectoryIterator	$iterator
array	$exclude	[optional] {array('.', '..')}

Definition at line 32 of file axDirectoryFilterIterator.class.php.

---

Member Function Documentation

axDirectoryFilterIterator::accept

(

)

FilterIterator::accept() implementation http://www.php.net/manual/en/filteriterator.accept.php.

Returns:

boolean

Definition at line 41 of file axDirectoryFilterIterator.class.php.

axDirectoryFilterIterator::exclude

(

$

filename

)

Add on (or many) filenames to exclude from the Iterator.

You may pass as many parameter as filenames you want to exclude.

Parameters:

string

$filename

[...]

Returns:

axDirectoryFilterIterator

Definition at line 56 of file axDirectoryFilterIterator.class.php.

---

Field Documentation

array axDirectoryFilterIterator::$_exclude [protected]

Exclusion names.

Definition at line 25 of file axDirectoryFilterIterator.class.php.

---

The documentation for this class was generated from the following file:

• H:/Workspace/php-axiom/www/php-axiom/libraries/axiom/axDirectoryFilterIterator.class.php