oxUtilsFile Class Reference

Inheritance diagram for oxUtilsFile:

Inheritance graph
[legend]
Collaboration diagram for oxUtilsFile:

Collaboration graph
[legend]

List of all members.


Detailed Description

File manipulation utility class

Public Member Functions

 normalizeDir ($sDir)
 copyDir ($sSourceDir, $sTargetDir)
 deleteDir ($sSourceDir)
 readRemoteFileAsString ($sPath)
 processFiles ($oObject=null)
 checkFile ($sFile)
 urlValidate ($link)
 handleUploadedFile ($aFileInfo, $sUploadPath)

Static Public Member Functions

static getInstance ()

Static Private Attributes

static $_instance = null

Member Function Documentation

static oxUtilsFile.getInstance (  )  [static]

Returns object instance

Returns:
oxUtilsFile

oxUtilsFile.normalizeDir ( sDir  ) 

Normalizes dir by adding missing trailing slash

Parameters:
string $sDir Directory
Returns:
string

oxUtilsFile.copyDir ( sSourceDir,
sTargetDir 
)

Copies directory tree for creating a new shop.

Parameters:
string $sSourceDir Source directory
string $sTargetDir Target directory
Returns:
null

oxUtilsFile.deleteDir ( sSourceDir  ) 

Deletes directory tree.

Parameters:
string $sSourceDir Path to directory
Returns:
null

oxUtilsFile.readRemoteFileAsString ( sPath  ) 

Reads remote stored file. Returns contents of file.

Parameters:
string $sPath Remote file path & name
Returns:
string

oxUtilsFile.processFiles ( oObject = null  ) 

Uploaded file processor (filters, etc), sets configuration parameters to passed object and returns it.

Parameters:
object $oObject object, that parameters are modified according to passed files
Returns:
object

oxUtilsFile.checkFile ( sFile  ) 

Checks if passed file exists and may be opened for reading. Returns true on success.

Parameters:
string $sFile Name of file to check
Returns:
bool

oxUtilsFile.urlValidate ( link  ) 

�berpr�ft die angegeben URL auf Erreichbarkeit (HTTP-Code: 200)

Parameters:
string $link
Returns:
boolean

oxUtilsFile.handleUploadedFile ( aFileInfo,
sUploadPath 
)

Handles uploaded path. Returns new URL to the file

Parameters:
array $aFileInfo Global $_FILE parameter info
string $sUploadPath RELATIVE (to config sShopDir parameter) path for uploaded file to be copied
Exceptions:
oxException 
Returns:
string


Member Data Documentation

oxUtilsFile.$_instance = null [static, private]


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

Generated on Wed Oct 29 23:46:30 2008 for OXID eShop CE by  doxygen 1.5.5