Class: PEAR_PackageFileManager_File

Source Location: /PEAR_PackageFileManager_Plugins-1.0.2/PackageFileManager/File.php

Class Overview

PEAR_PackageFileManager_Plugins
   |
   --PEAR_PackageFileManager_File

Retrieve the files from a directory listing

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.0.2

Copyright:

2003-2009 The PEAR Group

Methods

Child classes:

PEAR_PackageFileManager_Perforce: Generate a file list from a Perforce checkout.

PEAR_PackageFileManager_Svn: Generate a file list from a Subversion checkout

PEAR_PackageFileManager_CVS: Generate a file list from a CVS checkout.

Inherited Variables

Class: PEAR_PackageFileManager_Plugins

PEAR_PackageFileManager_Plugins::$_options

Inherited Methods

Class: PEAR_PackageFileManager_Plugins

PEAR_PackageFileManager_Plugins::raiseError(): Utility function to shorten error generation code
PEAR_PackageFileManager_Plugins::setOptions(): Merge a new set of options (as an array) to the currently set options

Class Details

[line 37]
Retrieve the files from a directory listing

This class is used to retrieve a raw directory listing. Use the PEAR_PackageFileManager_CVS class to only retrieve the contents of a cvs repository when generating the package.xml

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.0.2
Copyright: 2003-2009 The PEAR Group
Link: http://pear.php.net/package/PEAR_PackageFileManager_Plugins
Since: Class available since Release 1.0.0alpha1
License: New

[ Top ]

Method Detail

PEAR_PackageFileManager_File (Constructor) [line 63]

void PEAR_PackageFileManager_File(
array
$options)

Set up the File filelist generator

'ignore' and 'include' are the only options that this class uses. See PEAR_PackageFileManager::setOptions() for more information and formatting of this option

Parameters:

array $options — list of generation options

[ Top ]

dirList [line 176]

array dirList(
string
$directory)

Retrieve a listing of every file in $directory and all subdirectories.

The return format is an array of full paths to files

Return: list of files in a directory
Throws: PEAR_PACKAGEFILEMANAGER_PLUGINS_DIR_DOESNT_EXIST
Access: protected

Overridden in child classes as:

PEAR_PackageFileManager_Perforce::dirList(): Build a list of files based on the output of the 'p4 have' command.

PEAR_PackageFileManager_Svn::dirList(): Return a list of all files in the SVN repository

PEAR_PackageFileManager_CVS::dirList(): Return a list of all files in the CVS repository

Parameters:

string $directory — full path to the directory you want the list of

[ Top ]

getFileList [line 78]

array getFileList(
)

Generate the <filelist></filelist> section of the package file.

This function performs the backend generation of the array containing all files in this package

[ Top ]