Documentation

Directory extends Generic
in package

Class \Hoa\File\Directory.

Directory handler.

Tags
copyright

Copyright © 2007-2017 Hoa community

license

New BSD License

Table of Contents

Constants

MODE_CREATE  = 'xb'
Open for reading and writing. If the directory does not exist, attempt to create it.
MODE_CREATE_RECURSIVE  = 'xrb'
Open for reading and writing. If the directory does not exist, attempt to create it recursively.
MODE_READ  = 'rb'
Open for reading.

Properties

$_mode  : string
Mode.

Methods

__construct()  : mixed
Open a directory.
changeGroup()  : bool
Change file group.
changeMode()  : bool
Change file mode.
changeOwner()  : bool
Change file owner.
clearAllStatisticCaches()  : void
Clear all files status cache.
clearStatisticCache()  : void
Clear file status cache.
copy()  : bool
Recursive copy of a directory.
create()  : bool
Create a directory.
delete()  : bool
Delete a directory.
getATime()  : int
Get last access time of file.
getBasename()  : string
Get filename component of path.
getCTime()  : int
Get inode change time of file.
getDirname()  : string
Get directory name component of path.
getExtension()  : string
Get file extension (if exists).
getFilename()  : string
Get filename without extension.
getGroup()  : int
Get file group.
getINode()  : int
Get inode.
getMode()  : string
Get the open mode.
getMTime()  : int
Get file modification time.
getOwner()  : int
Get file owner.
getPermissions()  : int
Get file permissions.
getReadablePermissions()  : string
Get file permissions as a string.
getRealPath()  : string
Get a canonicalized absolute pathname.
getSize()  : int
Get size.
getStatistic()  : array<string|int, mixed>
Get informations about a file.
isBlockSpecial()  : bool
Check if it is block special.
isCaseSensitive()  : bool
Check if the system is case sensitive or not.
isCharacterSpecial()  : bool
Check if it is character special file.
isDirectory()  : bool
Check if it is a directory.
isExecutable()  : bool
Check if the file is executable.
isFIFOPipe()  : bool
Check if it is a FIFO pipe.
isFile()  : bool
Check if it is a file.
isLink()  : bool
Check if it is a link.
isReadable()  : bool
Check if the file is readable.
isSocket()  : bool
Check if it is a socket.
isUnknown()  : bool
Check if it is an unknown type.
isWritable()  : bool
Check if the file is writable.
move()  : bool
Move a file.
touch()  : bool
Set access and modification time of file.
umask()  : int
Change the current umask.
_close()  : bool
Close the current stream.
_open()  : resource
Open the stream and return the associated resource.
setMode()  : string
Set the open mode.

Constants

MODE_CREATE

Open for reading and writing. If the directory does not exist, attempt to create it.

public mixed MODE_CREATE = 'xb'
Tags
const

string

MODE_CREATE_RECURSIVE

Open for reading and writing. If the directory does not exist, attempt to create it recursively.

public mixed MODE_CREATE_RECURSIVE = 'xrb'
Tags
const

string

MODE_READ

Open for reading.

public mixed MODE_READ = 'rb'
Tags
const

string

Properties

$_mode

Mode.

protected string $_mode = null

Methods

__construct()

Open a directory.

public __construct(string $streamName[, string $mode = self::MODE_READ ][, string $context = null ][, bool $wait = false ]) : mixed
Parameters
$streamName : string

Stream name.

$mode : string = self::MODE_READ

Open mode, see the self::MODE* constants.

$context : string = null

Context ID (please, see the \Hoa\Stream\Context class).

$wait : bool = false

Differ opening or not.

changeGroup()

Change file group.

public changeGroup(mixed $group) : bool
Parameters
$group : mixed

Group name or number.

Return values
bool

changeMode()

Change file mode.

public changeMode(int $mode) : bool
Parameters
$mode : int

Mode (in octal!).

Return values
bool

changeOwner()

Change file owner.

public changeOwner(mixed $user) : bool
Parameters
$user : mixed

User.

Return values
bool

clearAllStatisticCaches()

Clear all files status cache.

public static clearAllStatisticCaches() : void

clearStatisticCache()

Clear file status cache.

public clearStatisticCache() : void

copy()

Recursive copy of a directory.

public copy(string $to[, bool $force = StreamIStreamTouchable::DO_NOT_OVERWRITE ]) : bool
Parameters
$to : string

Destination path.

$force : bool = StreamIStreamTouchable::DO_NOT_OVERWRITE

Force to copy if the file $to already exists. Use the \Hoa\Stream\IStream\Touchable::*OVERWRITE constants.

Tags
throws
Exception
Return values
bool

create()

Create a directory.

public static create(string $name[, string $mode = self::MODE_CREATE_RECURSIVE ][, string $context = null ]) : bool
Parameters
$name : string

Directory name.

$mode : string = self::MODE_CREATE_RECURSIVE

Create mode. Please, see the self::MODE_CREATE* constants.

$context : string = null

Context ID (please, see the \Hoa\Stream\Context class).

Tags
throws
Exception
Return values
bool

delete()

Delete a directory.

public delete() : bool
Return values
bool

getATime()

Get last access time of file.

public getATime() : int
Return values
int

getBasename()

Get filename component of path.

public getBasename() : string
Return values
string

getCTime()

Get inode change time of file.

public getCTime() : int
Return values
int

getDirname()

Get directory name component of path.

public getDirname() : string
Return values
string

getExtension()

Get file extension (if exists).

public getExtension() : string
Return values
string

getFilename()

Get filename without extension.

public getFilename() : string
Return values
string

getGroup()

Get file group.

public getGroup() : int
Return values
int

getINode()

Get inode.

public getINode() : int
Return values
int

getMode()

Get the open mode.

public getMode() : string
Return values
string

getMTime()

Get file modification time.

public getMTime() : int
Return values
int

getOwner()

Get file owner.

public getOwner() : int
Return values
int

getPermissions()

Get file permissions.

public getPermissions() : int
Return values
int

getReadablePermissions()

Get file permissions as a string.

public getReadablePermissions() : string

Result sould be interpreted like this:

  • s: socket;
  • l: symbolic link;
  • -: regular;
  • b: block special;
  • d: directory;
  • c: character special;
  • p: FIFO pipe;
  • u: unknown.
Return values
string

getRealPath()

Get a canonicalized absolute pathname.

public getRealPath() : string
Return values
string

getSize()

Get size.

public getSize() : int
Return values
int

getStatistic()

Get informations about a file.

public getStatistic() : array<string|int, mixed>
Return values
array<string|int, mixed>

isBlockSpecial()

Check if it is block special.

public isBlockSpecial() : bool
Return values
bool

isCaseSensitive()

Check if the system is case sensitive or not.

public static isCaseSensitive() : bool
Return values
bool

isCharacterSpecial()

Check if it is character special file.

public isCharacterSpecial() : bool
Return values
bool

isDirectory()

Check if it is a directory.

public isDirectory() : bool
Return values
bool

isExecutable()

Check if the file is executable.

public isExecutable() : bool
Return values
bool

isFIFOPipe()

Check if it is a FIFO pipe.

public isFIFOPipe() : bool
Return values
bool

isFile()

Check if it is a file.

public isFile() : bool
Return values
bool

isLink()

Check if it is a link.

public isLink() : bool
Return values
bool

isReadable()

Check if the file is readable.

public isReadable() : bool
Return values
bool

isSocket()

Check if it is a socket.

public isSocket() : bool
Return values
bool

isUnknown()

Check if it is an unknown type.

public isUnknown() : bool
Return values
bool

isWritable()

Check if the file is writable.

public isWritable() : bool
Return values
bool

move()

Move a file.

public move(string $name[, bool $force = StreamIStreamTouchable::DO_NOT_OVERWRITE ][, bool $mkdir = StreamIStreamTouchable::DO_NOT_MAKE_DIRECTORY ]) : bool
Parameters
$name : string

New name.

$force : bool = StreamIStreamTouchable::DO_NOT_OVERWRITE

Force to move if the file $name already exists. Use the \Hoa\Stream\IStream\Touchable::*OVERWRITE constants.

$mkdir : bool = StreamIStreamTouchable::DO_NOT_MAKE_DIRECTORY

Force to make directory if does not exist. Use the \Hoa\Stream\IStream\Touchable::*DIRECTORY constants.

Return values
bool

touch()

Set access and modification time of file.

public touch([int $time = -1 ][, int $atime = -1 ]) : bool
Parameters
$time : int = -1

Time. If equals to -1, time() should be used.

$atime : int = -1

Access time. If equals to -1, $time should be used.

Return values
bool

umask()

Change the current umask.

public static umask([int $umask = null ]) : int
Parameters
$umask : int = null

Umask (in octal!). If null, given the current umask value.

Return values
int

_close()

Close the current stream.

protected _close() : bool
Return values
bool

_open()

Open the stream and return the associated resource.

protected & _open(string $streamName[, Context $context = null ]) : resource
Parameters
$streamName : string

Stream name (e.g. path or URL).

$context : Context = null

Context.

Tags
throws
FileDoesNotExist
throws
Exception
Return values
resource

setMode()

Set the open mode.

protected setMode(string $mode) : string
Parameters
$mode : string

Open mode. Please, see the child::MODE_* constants.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results