oxUtilsFile Class Reference

Inheritance diagram for oxUtilsFile:
[legend]
Collaboration diagram for oxUtilsFile:
[legend]

List of all members.


Detailed Description

File manipulation utility class

Definition at line 6 of file oxutilsfile.php.


Public Member Functions

 normalizeDir ($sDir)
 copyDir ($sSourceDir, $sTargetDir)
 deleteDir ($sSourceDir)
 readRemoteFileAsString ($sPath)
 processFiles ($oObject=null)
 checkFile ($sFile)
 urlValidate ($sLink)
 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

Definition at line 20 of file oxutilsfile.php.

oxUtilsFile.normalizeDir ( sDir  ) 

Normalizes dir by adding missing trailing slash

Parameters:
string $sDir Directory
Returns:
string

Definition at line 45 of file oxutilsfile.php.

oxUtilsFile.copyDir ( sSourceDir,
sTargetDir 
)

Copies directory tree for creating a new shop.

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

Definition at line 62 of file oxutilsfile.php.

oxUtilsFile.deleteDir ( sSourceDir  ) 

Deletes directory tree.

Parameters:
string $sSourceDir Path to directory
Returns:
null

Definition at line 97 of file oxutilsfile.php.

oxUtilsFile.readRemoteFileAsString ( sPath  ) 

Reads remote stored file. Returns contents of file.

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

Definition at line 128 of file oxutilsfile.php.

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

Definition at line 152 of file oxutilsfile.php.

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

Definition at line 423 of file oxutilsfile.php.

oxUtilsFile.urlValidate ( sLink  ) 

Checks if given URL is accessible (HTTP-Code: 200)

Parameters:
string $sLink given link
Returns:
boolean

Definition at line 456 of file oxutilsfile.php.

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 if file is not valid
Returns:
string

Definition at line 507 of file oxutilsfile.php.


Member Data Documentation

oxUtilsFile.$_instance = null [static, private]

Definition at line 13 of file oxutilsfile.php.


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

Generated on Thu Dec 4 12:05:35 2008 for OXID eShop CE by  doxygen 1.5.5