phpCoreLib2
[ class tree: phpCoreLib2 ] [ index: phpCoreLib2 ] [ all elements ]

Class: DFile

Source Location: /Files/System/DFile.php

Class Overview

DObject
   |
   --DFile

Base file functionality


Variables

Methods


Child classes:

DDirectory
Base directory functionality

Inherited Constants

Inherited Variables

Inherited Methods

Class: DObject

DObject::__construct()
Constructor
DObject::debug()
Debig
DObject::getClassMembers()
Gets member variables of the instance
DObject::getClassMemberType()
Gets class member type
DObject::getClassMethods()
Gets classes of the class
DObject::getClassName()
Gets class name
DObject::PHPSerialize()
Gets serialized string of the class
DObject::trace()
Trace
DObject::__destruct()
Descructor
DObject::__toString()
Returns String equivalent of the object.

Class Details

[line 24]
Base file functionality



[ Top ]


Class Variables

$extension =  ""

[line 45]

Extension of the file



Tags:

access:  public

Type:   string


[ Top ]

$fullPath =  ""

[line 52]

Full path of the file



Tags:

access:  public

Type:   string


[ Top ]

$group =  ""

[line 94]

Group the file is assigned to



Tags:

access:  public

Type:   DSystemGroup


[ Top ]

$name =  ""

[line 31]

Name of the file with extension



Tags:

access:  public

Type:   string


[ Top ]

$owner =  ""

[line 87]

Owner of the file



Tags:

access:  public

Type:   DSystemUser


[ Top ]

$permissionsNumber =  ""

[line 80]

Permissions string 4 digit way



Tags:

access:  public

Type:   string


[ Top ]

$permissionsString =  ""

[line 73]

Permissions string -rwxrwxrwx



Tags:

access:  public

Type:   string


[ Top ]

$pureName =  ""

[line 38]

Name of the file without extension



Tags:

access:  public

Type:   string


[ Top ]

$purePath =  ""

[line 59]

Pure path of the file



Tags:

access:  public

Type:   string


[ Top ]

$size =  0

[line 66]

File size



Tags:

access:  public

Type:   int


[ Top ]

$timeModified =  null

[line 101]

Modified time



Tags:

access:  public

Type:   DDate


[ Top ]



Class Methods


static method checkIfFileExists [line 162]

static boolean checkIfFileExists( string $fileName)

Checks if file exists



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

static method checkIfFileIsWritable [line 174]

static boolean checkIfFileIsWritable( string $fileName)

Checks if file is readable



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

static method copyFile [line 232]

static boolean copyFile( string $destionation, string $source)

Copies a file



Tags:

access:  public


Parameters:

string   $destionation  
string   $source  

[ Top ]

static method deleteFile [line 215]

static boolean deleteFile( string $fileName)

Delete files



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

static method deleteFileMask [line 190]

static void deleteFileMask( string $fileMask)

Delete files by mask



Tags:

access:  public


Parameters:

string   $fileMask  

[ Top ]

static method generatePermissionsNumbersFromString [line 313]

static string generatePermissionsNumbersFromString( string $permissionsCodeString)

Generates permissions 4 digis



Tags:

access:  public


Parameters:

string   $permissionsCodeString  

[ Top ]

static method generatePermissionsStringFromCode [line 287]

static string generatePermissionsStringFromCode( string $permissionsCode4Digit)

Generates -rwxrwxrwx string from 4 digit numbers



Tags:

access:  public


Parameters:

string   $permissionsCode4Digit  

[ Top ]

static method getFileContent [line 369]

static string getFileContent( string $fileName)

Gets file content to string



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

static method getFileNameByFilePath [line 409]

static string getFileNameByFilePath( string $filePath, [string $directoryDelimiter = PHP_DFILE_DEFAULT_DIRECTORY_DELIMITER])

Gets file name by file path



Tags:

access:  public


Parameters:

string   $filePath  
string   $directoryDelimiter  

[ Top ]

static method getFilePathByFileName [line 424]

static string getFilePathByFileName( string $fileName, [string $directoryDelimiter = PHP_DFILE_DEFAULT_DIRECTORY_DELIMITER])

Gets file path by file name



Tags:

access:  public


Parameters:

string   $fileName  
string   $directoryDelimiter  

[ Top ]

static method moveFile [line 251]

static void moveFile( string $destination, string $source)

Moves file



Tags:

access:  public


Parameters:

string   $destination  
string   $source  

[ Top ]

static method rename [line 275]

static boolean rename( $oldName, $newName)

Renames files



Tags:

access:  public


Parameters:

   $oldName  
   $newName  

[ Top ]

static method toFile [line 385]

static boolean toFile( string $content, string $fileName)

Writes string content to file



Tags:

access:  public


Parameters:

string   $content  
string   $fileName  

[ Top ]

static method toString [line 353]

static string toString( string $fileName)

Gets file content as string



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

constructor __construct [line 110]

DFile __construct( [string $fileName = null])

Constructor



Tags:

access:  public


Overridden in child classes as:

DDirectory::__construct()
Constructor
DDirectoryList::__construct()
Constructor

Overrides DObject::__construct() (Constructor)

Parameters:

string   $fileName  

[ Top ]

method forceInitMemberVariables [line 464]

void forceInitMemberVariables( string $fileName)

Force Inits file options by file name

Usually used to init file parameters for non existing files




Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

method init [line 125]

boolean init( string $fileName)

Inits the file properties



Tags:

access:  public


Overridden in child classes as:

DDirectory::init()
Inits the directory properties
DDirectoryList::init()
Inits structure

Parameters:

string   $fileName  

[ Top ]

method reset [line 140]

void reset( )

Resets data



Tags:

access:  public


[ Top ]

method unlink [line 262]

boolean unlink( )

Deletes files



Tags:

access:  public


[ Top ]

method _initMemberVariables [line 439]

void _initMemberVariables( string $fileName)

Inits file options by file name



Tags:

access:  protected


Parameters:

string   $fileName  

[ Top ]

method __toString [line 333]

string __toString( string $fileName)

Gets file string content



Tags:

access:  public


Overrides DObject::__toString() (Returns String equivalent of the object.)

Parameters:

string   $fileName  

[ Top ]


Documentation generated on Sat, 17 Apr 2010 22:04:58 +0300 by phpDocumentor 1.4.3