Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /sitemap/include/class.dir.php
sitemap - Richy's Site Map

CDir

CDir

Class for reading a directory structure.

 

public class CDir

Class for reading a directory structure.

AuthorsHannesd <dontknow@whatever.com>
Version$Revision: 1.1.1.1 $
Copyright(c)2000 Hannesd
Magic$Id: class.dir.php,v 1.1.1.1 2002/01/19 16:46:58 richy Exp $

 

Public Method Summary

void

CDir()

Constructor of class CDir.
void

Init()

Reset $aFiles.
void

Read(string $sPath, [ string $sInclude, boolean $fRecursive, boolean $fFiles, boolean $fDirectories, string $sRoot, string $sExclude ])

Read the directory structure and fill $aFiles.
void

Output()

Output list with all info about $aFiles.
void

OutputFile(array $aFile)

Output one item of $aFiles.
string

GetPath(array $aFile)

Return path of one item of $aFiles.
string

GetFile(array $aFile)

Return filename (without extension) of one item of $aFiles.
string

GetExtension(array $aFile)

Return extension of one item of $aFiles.
boolean

GetIsDirectory(array $aFile)

Return whether item is a directory or not.
boolean

GetIsFile(array $aFile)

Return whether item is a file or not.
string

FullName(array $aFile)

Return full name (including path) of one item of $aFiles.
string

FileName(array $aFile)

Return filename (with extension) of one item of $aFiles.
string

DirectoryName(array $aFile)

Return filename (with extension) of one item of $aFiles.

Public Field Summary

array

$aFiles

Filled with the directory structure after using Read().

Private Constant Summary

INCLUCDED_DIR >>TRUE<<

Public Method Details

CDir

public void CDir( )

  Constructor of class CDir.

Returns void


Init

public void Init( )

  Reset $aFiles.

Returns void

See Also $aFiles

Read

public void Read( string $sPath, [ string $sInclude, boolean $fRecursive, boolean $fFiles, boolean $fDirectories, string $sRoot, string $sExclude ] )

  Read the directory structure and fill $aFiles.

Parameter
string $sPath
path of where to begin reading (note the last "/")
string $sInclude = >>""<<
regular expression for filtering path- and filenames
boolean $fRecursive = >>false<<
go down the whole structure or not
boolean $fFiles = >>true<<
result set will contain entries which are files
boolean $fDirectories = >>true<<
result set will contain entries which are directories
string $sRoot = >>""<<
root path, will be appended to the entries
string $sExclude = >>""<<
regular expression for filtering path- and filenames
Returns void

See Also $aFiles

Output

public void Output( )

  Output list with all info about $aFiles.

Returns void

See Also $aFiles

OutputFile

public void OutputFile( array $aFile )

  Output one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns void

See Also $aFiles

GetPath

public string GetPath( array $aFile )

  Return path of one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns string

path

See Also $aFiles

GetFile

public string GetFile( array $aFile )

  Return filename (without extension) of one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns string

filename without extension

See Also $aFiles

GetExtension

public string GetExtension( array $aFile )

  Return extension of one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns string

extension

See Also $aFiles

GetIsDirectory

public boolean GetIsDirectory( array $aFile )

  Return whether item is a directory or not.

Parameter
array $aFile
one item of $aFiles
Returns boolean

whether item is a directory or not

See Also $aFiles

GetIsFile

public boolean GetIsFile( array $aFile )

  Return whether item is a file or not.

Parameter
array $aFile
one item of $aFiles
Returns boolean

whether item is a file or not

See Also $aFiles

FullName

public string FullName( array $aFile )

  Return full name (including path) of one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns string

full name (including path)

See Also $aFiles

FileName

public string FileName( array $aFile )

  Return filename (with extension) of one item of $aFiles.

Parameter
array $aFile
one item of $aFiles
Returns string

filename with extension

See Also $aFiles

DirectoryName

public string DirectoryName( array $aFile )

  Return filename (with extension) of one item of $aFiles.
Note: if the current item is a directory, the trailing "/" will be left out.

Parameter
array $aFile
one item of $aFiles
Returns string

filename with extension (without trailing "/")

See Also $aFiles

Public Field Details

$aFiles

public array $aFiles

>><<

Filled with the directory structure after using Read().
Automatically set, do not change!

See Also Read()

Private Constant Details

INCLUCDED_DIR

define( INCLUCDED_DIR, >>TRUE<< )
Case: default: case sensitive




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta