eZPublish  3.8
eZDir Class Reference

The class eZDir does. More...

Public Member Functions

 copy ($sourceDirectory, &$destinationDirectory, $asChild=true, $recursive=true, $includeHidden=false, $excludeItems=false)
 
 directoryPermission ()
 
 dirpath ($filepath)
 
 eZDir ()
 
 filenamePath ($filename, $maxCharLen=2)
 
 getPathFromFilename ($filename)
 
 temporaryFileRegexp ($standalone=true)
 

Static Public Member Functions

 cleanPath ($path, $toType=EZ_DIR_SEPARATOR_UNIX)
 
 cleanupEmptyDirectories ($dir)
 
 convertSeparators ($path, $toType=EZ_DIR_SEPARATOR_UNIX)
 
 createMultiLevelPath ($key, $maxDepth=-1)
 
 findSubdirs ($dir, $includeHidden=false, $excludeItems=false)
 
 findSubitems ($dir, $types=false, $fullPath=false, $includeHidden=false, $excludeItems=false)
 
 isWriteable ($dirname)
 
 mkdir ($dir, $perm=false, $parents=false)
 
 path ($names, $includeEndSeparator=false, $type=EZ_DIR_SEPARATOR_UNIX)
 
 recursiveDelete ($dir)
 
 recursiveFind ($dir, $suffix)
 
 recursiveFindRelative ($baseDir, $subDir, $suffix)
 
 recursiveList ($dir, $path, &$fileList)
 
 separator ($type)
 
 unlinkWildcard ($dir, $pattern)
 

Static Private Member Functions

 doMkdir ($dir, $perm)
 

Detailed Description

The class eZDir does.

Member Function Documentation

eZDir::cleanPath (   $path,
  $toType = EZ_DIR_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 cleanupEmptyDirectories(), dirpath(), eZSetupCheckExecutable(), eZSetupTestDirectoryPermissions(), eZSetupTestFilePermissions(), mkdir(), nameFromPath(), and path().

eZDir::cleanupEmptyDirectories (   $dir)
static

Goes trough the directory path $dir and removes empty directories.

Note
This is just the opposite of mkdir() with $parents set to true.

Referenced by eZWebDAVServer\processClientRequest(), eZImageAliasHandler\removeAliases(), eZImageAliasHandler\removeAllAliases(), and eZImageAliasHandler\updateAliasPath().

eZDir::convertSeparators (   $path,
  $toType = EZ_DIR_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().

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

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.
Iftrue 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\add(), and eZExtensionPackageCreator\finalize().

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)

eZDir::dirpath (   $filepath)
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 eZContentObjectPackageHandler\createDOMNodeFromFile(), eZContentObjectPackageHandler\installTemplates(), eZPDF\modify(), and eZImageAliasHandler\removeAllAliases().

eZDir::doMkdir (   $dir,
  $perm 
)
staticprivate

Creates the directory $dir with permission $perm.

Referenced by cleanupEmptyDirectories(), and mkdir().

eZDir::eZDir ( )

Constructor

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

Returns all subdirectories in a folder

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

Returns all subdirectories in a folder

Referenced by copy(), eZSetupPrvtAreDirAndFilesWritable(), and findSubdirs().

eZDir::isWriteable (   $dirname)
static

Check if a given directory is writeable

Returns
TRUE/FALSE

Referenced by eZSetupPrvtAreDirAndFilesWritable(), and eZSetupTestFileUpload().

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

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

Referenced by eZInstallScriptPackageHandler\add(), eZExtensionPackageHandler\add(), eZWebDAVServer\appendLogEntry(), eZImageManager\convert(), copy(), copyFilesFromDB(), eZFile\create(), eZContentObjectPackageHandler\createDOMNodeFromFile(), eZDBPackageHandler\createInstallNode(), eZContentObjectPackageHandler\createObjectListNode(), eZURLAlias\createWildcardMatches(), doMkdir(), eZStepSiteTypes\downloadFile(), eZCharTransform\executeCacheFile(), eZMutex\eZMutex(), eZExtensionPackageCreator\finalize(), eZNodeviewfunctions\generateNodeView(), eZImageAliasHandler\generateXMLData(), eZUser\getCacheDir(), eZSSLZone\getSSLZones(), eZImageAliasHandler\initializeFromFile(), eZStepCreateSites\initializePackage(), eZBinaryFileType\insertRegularFile(), eZMediaType\insertRegularFile(), eZFilePackageHandler\install(), eZExtensionPackageHandler\install(), eZContentObjectPackageHandler\installTemplates(), eZPDF\modify(), eZPHPCreator\open(), eZTemplateCacheFunction\process(), eZSubtreeCache\renameDir(), eZImageVariation\requestVariation(), eZINI\save(), eZINI\saveCache(), eZHTTPFile\store(), eZContentCache\store(), eZImageInterface\store(), eZTranslationCache\storeCache(), eZStaticCache\storeCache(), eZStaticCache\storeCachedFile(), eZCodePage\storeCacheObject(), eZTemplateImageOperator\storeImage(), eZWebDAVServer\storeUploadedFile(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZImageAliasHandler\updateAliasPath(), eZLog\write(), eZDebug\writeFile(), and eZLog\writeStorageLog().

eZDir::path (   $names,
  $includeEndSeparator = false,
  $type = EZ_DIR_SEPARATOR_UNIX 
)
static
eZDir::recursiveDelete (   $dir)
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 eZFilePackageHandler\handleParameters().

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

Referenced by eZTemplateDesignResource\overrideArray().

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

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

Referenced by eZExtensionPackageHandler\add(), and eZExtensionPackageCreator\finalize().

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

Type can be one of the following:

  • EZ_DIR_SEPARATOR_LOCAL - Returns whatever is applicable for the current machine.
  • EZ_DIR_SEPARATOR_UNIX - Returns a /
  • EZ_DIR_SEPARATOR_DOS - Returns a \

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

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

Unlink files match the given pattern in the given directory.

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


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