>Home
>Features
>How does it work?
>Documentation
>Tutorials
>Examples
>Help Forum
>Download
>Extensions
>Project Site
Get SiteFusion at SourceForge.net. Fast, secure and Free Open Source software downloads

Class: ClientDirectory

Source Location: /class/fileHandling.php.inc

Class Overview

ClientBaseFile
   |
   --ClientDirectory

Client filesystem class structure representing files (ClientFile) and directories (ClientDirectory) on the client side

These classes form the object representation of the filesystem of the client and can be created from the methods ClientFileService::getDirectory(), ClientFileService::getSpecialDirectory() and ClientFileService::createDirectory().




Variables

Methods

Inherited Variables

Class: ClientBaseFile

ClientBaseFile::$exists
ClientBaseFile::$fileService
ClientBaseFile::$isExecutable
ClientBaseFile::$isHidden
ClientBaseFile::$isReadable
ClientBaseFile::$isWritable
ClientBaseFile::$name
ClientBaseFile::$path

Class Variables

$entries = array()

access:  public
Type:   mixed

$isDirectory =  TRUE

access:  public
Type:   mixed
Overrides:   Array

Class Methods

method appendDirectory() [line 1585]

ClientDirectory appendDirectory( string $dirName)

Returns a new ClientDirectory representing a new directory in the current one

return:  The (new or existing) directory
access:  public

Parameters:

string   $dirName   The directory name to append to the current path

[ Top ]

method appendFile() [line 1609]

ClientFile appendFile( string $fileName)

Returns a new ClientFile representing a new file in the current directory

return:  The (new or existing) file
access:  public

Parameters:

string   $fileName   The filename to append to the current path

[ Top ]

method create() [line 1638]

void create( [object|string $handlerObj = NULL], [string $handlerMethod = NULL])

Creates the directory

The handler receives these parameters:

  • ClientFileService $fileService - this object
  • bool $status: indicates whether the operation was successful
  • ClientDirectory $dirFile: if successful, a file object referring to the new remote directory


access:  public

Parameters:

object|string   $handlerObj   The object or classname to call the handler on when the operation finishes
string   $handlerMethod   The method to call on the handler object

[ Top ]

method get() [line 1655]

void get( object|string $handlerObj, string $handlerMethod)

Gets the contents of a directory

The handler receives these parameters:

  • ClientFileService $fileService - this object
  • bool $status: indicates whether the operation was successful
  • ClientDirectory $dirFile: if successful, a file object referring to the remote directory with the directory contents in the ClientFile::$entries array


access:  public

Parameters:

object|string   $handlerObj   The object or classname to call the handler on when the operation finishes
string   $handlerMethod   The method to call on the handler object

[ Top ]

method remove() [line 1673]

void remove( [bool $recursive = FALSE], [object|string $handlerObj = NULL], [string $handlerMethod = NULL])

Removes the directory

The handler receives these parameters:

  • ClientFileService $fileService - this object
  • bool $status: indicates whether the operation was successful
  • string $path: the remote path


access:  public

Parameters:

bool   $recursive   If TRUE, all underlying contents are removed as well. If FALSE, the directory needs to be empty
object|string   $handlerObj   The object or classname to call the handler on when the operation finishes
string   $handlerMethod   The method to call on the handler object

[ Top ]

Documentation generated on Tue, 10 May 2011 19:41:09 +0200 by phpDocumentor 1.4.3