eZPublishCommunityProject(LegacyStack)  2013.9
eZDir Class Reference

The class eZDir does. More...

Static Public Member Functions

static cleanPath ($path, $toType=self::SEPARATOR_UNIX)
 
static cleanupEmptyDirectories ($dir)
 
static convertSeparators ($path, $toType=self::SEPARATOR_UNIX)
 
static copy ($sourceDirectory, &$destinationDirectory, $asChild=true, $recursive=true, $includeHidden=false, $excludeItems=false)
 
static createMultiLevelPath ($key, $maxDepth=-1)
 
static directoryPermission ()
 
static dirpath ($filepath)
 
static filenamePath ($filename, $maxCharLen=2)
 
static findSubdirs ($dir, $includeHidden=false, $excludeItems=false)
 
static findSubitems ($dir, $types=false, $fullPath=false, $includeHidden=false, $excludeItems=false)
 
static getPathFromFilename ($filename)
 
static isWriteable ($dirname)
 
static mkdir ($dir, $perm=false, $recursive=false)
 
static path ($names, $includeEndSeparator=false, $type=self::SEPARATOR_UNIX)
 
static recursiveDelete ($dir, $rootCheck=true)
 Removes a directory and all it's contents, recursively. More...
 
static recursiveFind ($dir, $suffix)
 
static recursiveFindRelative ($baseDir, $subDir, $suffix)
 
static recursiveList ($dir, $path, &$fileList)
 
static separator ($type)
 
static temporaryFileRegexp ($standalone=true)
 
static unlinkWildcard ($dir, $pattern)
 

Public Attributes

const SEPARATOR_DOS = 3
 
const SEPARATOR_LOCAL = 1
 
const SEPARATOR_UNIX = 2
 

Static Private Member Functions

static doMkdir ($dir, $perm, $recursive=false)
 

Detailed Description

The class eZDir does.

Member Function Documentation

static eZDir::cleanPath (   $path,
  $toType = self::SEPARATOR_UNIX 
)
static

Removes all unneeded directory separators and resolves any "."s and ".."s found in $path.

For instance: "var/../lib/ezdb" becomes "lib/ezdb", while "../site/var" will not be changed.

Note
Will also convert separators
See Also
convertSeparators.

Referenced by dirpath(), eZSetupCheckExecutable(), eZSetupTestDirectoryPermissions(), eZSetupTestFilePermissions(), mkdir(), eZExtension\nameFromPath(), and path().

static eZDir::cleanupEmptyDirectories (   $dir)
static
static eZDir::convertSeparators (   $path,
  $toType = self::SEPARATOR_UNIX 
)
static

Converts any directory separators found in $path, in both unix and dos style, into the separator type specified by $toType and returns it.

Referenced by cleanPath().

static eZDir::copy (   $sourceDirectory,
$destinationDirectory,
  $asChild = true,
  $recursive = true,
  $includeHidden = false,
  $excludeItems = false 
)
static

Copies a directory (and optionally all it's subitems) to another directory.

Parameters
$sourceDirectoryThe source directory which should be copied, this location must exist.
$destinationDirectoryThe location for the copied directory structure, this location must exist. This parameter will be modified if $asChild is true.
$asChildIf true then it will use last part of the $sourceDirectory as a sub-folder to $destinationDirectory. e.g. copying /etc/httpd to /var/ will create /var/httpd and place all folders/files under it.
$recursiveIf true then it will copy folders/files recursively from folders found in $sourceDirectory.
$includeHiddenIf true it will include files or folders beginning with a dot (.).
$excludeItemsA regular expression used to exclude files or folders in the subtree, use false for no exclusion.
Note
The parameter $recursive is currently unused, it will always copy recursively.

Referenced by eZInstallScriptPackageHandler\add(), eZExtensionPackageHandler\addExtension(), eZPackage\appendFile(), eZSiteInstaller\createSiteAccess(), eZPackage\exportToArchive(), and eZExtensionPackageHandler\install().

static eZDir::createMultiLevelPath (   $key,
  $maxDepth = -1 
)
static
Returns
a multi-level path from a specific key. For example:
echo createMultiLevelPath( "42abce", 3 );
returns "/4/2/abce"

Parameters: $key: the key to be used as path $maxDepth: the maximum number of path elements to be created (-1 is unlimited)

static eZDir::directoryPermission ( )
static
Returns
the default permissions to use for directories.
Note
The permission is converted from octal text to decimal value.

Referenced by copy(), mkdir(), and eZWebDAVContentBackend\tempDirectory().

static eZDir::dirpath (   $filepath)
static
Returns
the dirpath portion of the filepath $filepath.
$dirpath = eZDir::dirpath( "path/to/some/file.txt" );
print( $dirpath ); // prints out path/to/some

Referenced by eZPackage\appendSimpleFile(), eZClusterFileHandler\cleanupEmptyDirectories(), eZContentObjectPackageHandler\createDOMNodeFromFile(), eZContentObjectPackageHandler\installTemplates(), eZPDF\modify(), and eZImageAliasHandler\removeAllAliases().

static eZDir::doMkdir (   $dir,
  $perm,
  $recursive = false 
)
staticprivate

Creates the directory $dir with permission $perm.

static eZDir::filenamePath (   $filename,
  $maxCharLen = 2 
)
static
static eZDir::findSubdirs (   $dir,
  $includeHidden = false,
  $excludeItems = false 
)
static

Returns all subdirectories in a folder

Referenced by eZTSTranslator\fetchList().

static eZDir::findSubitems (   $dir,
  $types = false,
  $fullPath = false,
  $includeHidden = false,
  $excludeItems = false 
)
static
static eZDir::isWriteable (   $dirname)
static

Check if a given directory is writeable

Returns
TRUE/FALSE

Referenced by eZSetupPrvtAreDirAndFilesWritable(), and eZSetupTestFileUpload().

static eZDir::mkdir (   $dir,
  $perm = false,
  $recursive = false 
)
static

Creates the directory $dir with permissions $perm. If $recursive is true it will create any missing parent directories, just like 'mkdir -p'.

Referenced by ezpRestCacheStorageCluster\__construct(), eZDFSFileHandlerMySQLiBackend\__mkdir_p(), eZInstallScriptPackageHandler\add(), eZExtensionPackageHandler\addExtension(), eZPackage\appendFile(), eZPackage\appendInstall(), eZWebDAVContentBackend\appendLogEntry(), eZPackage\appendSimpleFile(), eZCharTransform\cacheFilePath(), changeDBCharsetORACLE(), checkDir(), eZImageManager\convert(), copy(), copyFilesFromDB(), eZFile\create(), eZContentObjectPackageHandler\createDOMNodeFromFile(), eZDBPackageHandler\createInstallNode(), eZContentObjectPackageHandler\createObjectListNode(), eZSiteInstaller\createSiteAccess(), eZURLWildcard\createWildcardsIndex(), doMkdir(), eZStepSiteTypes\downloadFile(), eZMutex\eZMutex(), eZSetupTestDirectoryPermissions(), eZUser\getCacheDir(), eZSSLZone\getSSLZones(), eZPackage\import(), eZImageAliasHandler\initializeFromFile(), eZStepCreateSites\initializePackage(), eZBinaryFileType\insertRegularFile(), eZMediaType\insertRegularFile(), eZFilePackageHandler\install(), eZExtensionPackageHandler\install(), eZContentObjectPackageHandler\installTemplates(), eZPDF\modify(), eZPHPCreator\open(), eZFile\rename(), eZSubtreeCache\renameDir(), eZINI\save(), eZINI\saveCache(), eZHTTPFile\store(), eZContentCache\store(), eZImageInterface\store(), eZTranslationCache\storeCache(), eZPackage\storeCache(), eZStaticCache\storeCachedFile(), eZPackage\storePackageFile(), eZWebDAVContentBackend\storeUploadedFile(), eZWebDAVContentBackend\tempDirectory(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZImageAliasHandler\updateAliasPath(), eZLog\write(), eZDebug\writeFile(), and eZLog\writeStorageLog().

static eZDir::path (   $names,
  $includeEndSeparator = false,
  $type = self::SEPARATOR_UNIX 
)
static

Creates a path out of all the dir and file items in the array $names with correct separators in between them. It will also remove unneeded separators. $type is used to determine the separator type, see eZDir::separator. If $includeEndSeparator is true then it will make sure that the path ends with a separator if false it make sure there are no end separator.

Referenced by eZTranslationCache\cacheDirectory(), eZTemplateTreeCache\cacheDirectory(), eZSys\cacheDirectory(), eZSSLZone\cacheFileName(), eZContentCache\cachePathInfo(), eZContentCache\cleanup(), eZTemplateCompiler\compilationDirectory(), eZTemplateCompiler\executeCompilation(), eZMutex\eZMutex(), eZSetupCheckExecutable(), eZPackage\fileStorePath(), eZINI\findInputFiles(), eZTemplateCompiler\generatePHPCodeChildren(), eZNodeviewfunctions\generateViewCacheFile(), eZCollaborationItemHandler\handlerRepositories(), eZTemplateImageOperator\hasImage(), eZPackage\import(), eZDBInterface\insertFile(), eZCollaborationItemHandler\instantiate(), eZTemplateImageOperator\loadImage(), eZTSTranslator\loadTranslationFile(), eZDebug\printReport(), eZImageInterface\processImage(), removeRelatedCache(), eZStaticCache\removeURL(), eZPackage\repositoryPath(), eZTranslationCache\rootCacheDirectory(), eZINI\save(), eZTemplateImageOperator\setLoadImage(), eZSys\storageDirectory(), eZImageInterface\store(), eZPHPCreator\store(), eZTemplateImageOperator\storeImage(), eZPackageType\storeObjectAttribute(), eZStepSiteTypes\tempDir(), eZPackage\temporaryExportPath(), eZPackage\temporaryImportPath(), and eZSys\varDirectory().

static eZDir::recursiveDelete (   $dir,
  $rootCheck = true 
)
static

Removes a directory and all it's contents, recursively.

Parameters
string$dirDirectory to remove
bool$rootCheckCheck whether $dir is supposed to be contained in eZ Publish root directory
Returns
bool True if the operation succeeded, false otherwise

Referenced by changeDBCharsetORACLE(), eZCache\clearGlobalINICache(), eZCache\clearItem(), eZCache\clearTemplateCompileCache(), eZCache\clearTemplateOverrideCache(), eZFSFileHandler\delete(), downloadPackages(), eZFSFileHandler\fileDelete(), eZExtensionPackageHandler\install(), eZDFSFileHandler\purge(), eZPackage\remove(), eZPackage\removeFiles(), and eZExtensionPackageHandler\uninstall().

static eZDir::recursiveFind (   $dir,
  $suffix 
)
static

Recurses through the directory and returns the files that matches the given suffix

Note
This function will not traverse . (hidden) folders

Referenced by getContributors(), and eZFilePackageHandler\handleParameters().

static eZDir::recursiveFindRelative (   $baseDir,
  $subDir,
  $suffix 
)
static

Recurses through the directory and returns the files that matches the given suffix. This function will store the relative path from the given base only. Note: this function will not traverse . (hidden) folders

static eZDir::recursiveList (   $dir,
  $path,
$fileList 
)
static

Creates a list of all files and dirs in the directory.

Referenced by eZExtensionPackageHandler\addExtension(), and eZPackage\exportToArchive().

static eZDir::separator (   $type)
static
Returns
the separator used between directories and files according to $type.

Type can be one of the following:

  • self::SEPARATOR_LOCAL - Returns whatever is applicable for the current machine.
  • self::SEPARATOR_UNIX - Returns a /
  • self::SEPARATOR_DOS - Returns a \

Referenced by cleanPath(), convertSeparators(), createMultiLevelPath(), and path().

static eZDir::temporaryFileRegexp (   $standalone = true)
static
Returns
a regexp which will match certain temporary files.

Referenced by eZPackage\appendFile().

static eZDir::unlinkWildcard (   $dir,
  $pattern 
)
static

Unlink files match the given pattern in the given directory.

Referenced by removeRelatedCache(), and eZPackageType\storeObjectAttribute().

Member Data Documentation

const eZDir::SEPARATOR_DOS = 3
const eZDir::SEPARATOR_LOCAL = 1
const eZDir::SEPARATOR_UNIX = 2

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