/ 
File-DirList-0.04
River stage zero No dependents
/ File::DirList

NAME

File::DirList - provide a sorted list of directory content

Version 0.04

SYNOPSIS

use File::DirList;
#
my @list = File::DirList::list('.', 'dn', 1, 0);

DESCRIPTION

This module is used to get list of directory content. Simple wrapper around DirHandle and sort()

Module have a 2 methods

list($dirName, $sortMode, $noLinks, $hideDotFiles, $showSelf)

Producind a list, accepting 5 parameters:

$dirName

Name of the directory to list

$sortMode

Describes how list should be sorted.

This is a string contains the following symbols

d or D

"Directory" sort. 'd' means all the directories will precede files, 'D' means revese.

n or N

Sort by file (or subdir) name. 'n' means strate, 'N' means revese

i or I

Same as 'n' but case insesitive

m or M

Sort by modification time, strate or revese

c or C

Sort by creation time, strate or revese

a or A

Sort by access time, strate or revese

s or S

Sort by access time, strate or revese

$sortMode is interpreted from left to right. In case first comparation produce equal result next one is used. For example, string 'din' produce a list with all the directories preceding files, directories and files are sorted by name case insensitive, but low case letter preceeding upper case.

If true symbolic links will not be examined. Set it on the platforms without symlink support.

$hideDotFiles

If true 'dot' files will not be reported.

$showSelf

If true '.' directory entry will be reported.

Returned value is a refference for array sorted as described by $sortMode.

Array elemnts are refferences to another arrays representing an item.

Item array contains 17 elements:

[0..12]

Result of stat() for this item. For valid symbolik links stat of the target item is returned.

[13]

Name of the item.

[14]

Is item a directory? Contains 0 for non-directory items, 1 for directories, 2 for '..', 3 for '.'. Used by "d or D" sorting.

[15]

Is item a link? 0 for non-links, 1 for valid links, -1 for invalid links.

[16]

Link target. undef for non-links, target path for links.

[15] and [16] are set to non-link if $examineLinks is false.

sortList($list, $sortMode)

Used to re-sort a list produced by list()

Parameters are

$lis

Reference to a list produced by list()

$sortMode

Sorting rules.

Returning value is similar to list()

EXPORT

None by default

SEE ALSO

DirHandle, stat, lstat, sort

AUTHOR

Daniel Podolsky, <tpaba@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Daniel Podolsky, <tpaba@cpan.org>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.