Horde_Vcs_Directory_Base
in package
Base directory class that stores information about the files in a single directory in the repository.
Copyright 2008-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_dirName : string
- The directory's path inside the repository.
- $_dirs : array<string|int, mixed>
- A (string) list of directories inside this directory.
- $_files : array<string|int, mixed>
- A list of Horde_Vcs_File_Base objects representing all files inside this directory.
- $_rep : Horde_Vcs_Base
- The directory's repository object.
- __construct() : mixed
- Constructor.
- _fileAgeSort() : mixed
- Sort function for ascending age.
- _fileAuthorSort() : mixed
- Sort function by author name.
- _fileNameSort() : mixed
- Sort function for ascending filename.
- _fileRevSort() : mixed
- Sort function for ascending revision.
- applySort() : mixed
- Sorts the the directory contents.
- getBranches() : array<string|int, mixed>
- Returns a list of all branches in this directory.
- getDirectories() : mixed
- Returns a list of directories inside this directory.
- getFiles() : array<string|int, mixed>
- Returns a list of all files inside this directory.
- _doFileSort() : mixed
- Sorts a list files.
Properties
$_dirName
The directory's path inside the repository.
protected
string
$_dirName
$_dirs
A (string) list of directories inside this directory.
protected
array<string|int, mixed>
$_dirs
= array()
$_files
A list of Horde_Vcs_File_Base objects representing all files inside this directory.
protected
array<string|int, mixed>
$_files
= array()
$_rep
The directory's repository object.
protected
Horde_Vcs_Base
$_rep
Methods
__construct()
Constructor.
public
__construct(Horde_Vcs_Base $rep, string $dn[, array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $rep : Horde_Vcs_Base
-
A repository object.
- $dn : string
-
Path to the directory.
- $opts : array<string|int, mixed> = array()
-
Any additional options:
Tags
Return values
mixed —_fileAgeSort()
Sort function for ascending age.
public
_fileAgeSort(mixed $a, mixed $b) : mixed
Parameters
- $a : mixed
- $b : mixed
Return values
mixed —_fileAuthorSort()
Sort function by author name.
public
_fileAuthorSort(mixed $a, mixed $b) : mixed
Parameters
- $a : mixed
- $b : mixed
Return values
mixed —_fileNameSort()
Sort function for ascending filename.
public
_fileNameSort(mixed $a, mixed $b) : mixed
Parameters
- $a : mixed
- $b : mixed
Return values
mixed —_fileRevSort()
Sort function for ascending revision.
public
_fileRevSort(mixed $a, mixed $b) : mixed
Parameters
- $a : mixed
- $b : mixed
Return values
mixed —applySort()
Sorts the the directory contents.
public
applySort([int $how = Horde_Vcs::SORT_NONE ][, int $dir = Horde_Vcs::SORT_ASCENDING ]) : mixed
Parameters
- $how : int = Horde_Vcs::SORT_NONE
-
A Horde_Vcs::SORT_* constant where * can be: NONE, NAME, AGE, REV for sorting by name, age or revision.
- $dir : int = Horde_Vcs::SORT_ASCENDING
-
A Horde_Vcs::SORT_* constant where * can be: ASCENDING, DESCENDING for the order of the sort.
Return values
mixed —getBranches()
Returns a list of all branches in this directory.
public
getBranches() : array<string|int, mixed>
Return values
array<string|int, mixed> —A branch list.
getDirectories()
Returns a list of directories inside this directory.
public
getDirectories() : mixed
return array A (string) list of directories.
Return values
mixed —getFiles()
Returns a list of all files inside this directory.
public
getFiles([mixed $showdeleted = false ]) : array<string|int, mixed>
Parameters
- $showdeleted : mixed = false
Return values
array<string|int, mixed> —A list of Horde_Vcs_File_Base objects.
_doFileSort()
Sorts a list files.
protected
_doFileSort(array<string|int, mixed> &$fileList[, int $how = Horde_Vcs::SORT_NONE ]) : mixed
Parameters
- $fileList : array<string|int, mixed>
-
A list of files.
- $how : int = Horde_Vcs::SORT_NONE
-
A Horde_Vcs::SORT_* constant.