XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Fonctions membres publiques | Champs de données
Référence de la classe XoopsFileHandler

Fonctions membres publiques

 __construct ($path, $create=false, $mode=0755)
 
 __destruct ()
 
 create ()
 
 open ($mode='r', $force=false)
 
 read ($bytes=false, $mode='rb', $force=false)
 
 offset ($offset=false, $seek=SEEK_SET)
 
 prepare ($data)
 
 write ($data, $mode='w', $force=false)
 
 append ($data, $force=false)
 
 close ()
 
 delete ()
 
 info ()
 
 ext ()
 
 name ()
 
 safe ($name=null, $ext=null)
 
 md5 ($maxsize=5)
 
 pwd ()
 
 exists ()
 
 perms ()
 
 size ()
 
 writable ()
 
 executable ()
 
 readable ()
 
 owner ()
 
 group ()
 
 lastAccess ()
 
 lastChange ()
 
& folder ()
 

Champs de données

 $folder
 
 $name
 
 $info = array()
 
 $handle
 
 $lock
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $path,
  $create = false,
  $mode = 0755 
)

Constructor

Paramètres
string$pathPath to file
boolean$createCreate file if it does not exist (if true)
integer$modeMode to apply to the folder holding the file @access private
+ Voici le graphe d'appel pour cette fonction :

◆ __destruct()

__destruct ( )

Closes the current file if it is opened

@access private

+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ append()

append (   $data,
  $force = false 
)

Append given data string to this File.

Paramètres
string$dataData to write
bool | string$forceforce the file to open
Renvoie
boolean Success @access public
+ Voici le graphe d'appel pour cette fonction :

◆ close()

close ( )

Closes the current file if it is opened.

Renvoie
boolean True if closing was successful or file was already closed, otherwise false @access public
+ Voici le graphe des appelants de cette fonction :

◆ create()

create ( )

Creates the File.

Renvoie
boolean Success @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ delete()

delete ( )

Deletes the File.

Renvoie
boolean Success @access public
+ Voici le graphe d'appel pour cette fonction :

◆ executable()

executable ( )

Returns true if the File is executable.

Renvoie
boolean true if its executable, false otherwise @access public
+ Voici le graphe d'appel pour cette fonction :

◆ exists()

exists ( )

Returns true if the File exists.

Renvoie
boolean true if it exists, false otherwise @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ ext()

ext ( )

Returns the File extension.

Renvoie
string The File extension @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ folder()

& folder ( )

Returns the current folder.

Renvoie
Folder Current folder @access public
+ Voici le graphe des appelants de cette fonction :

◆ group()

group ( )

Returns the File group.

Renvoie
integer the Filegroup @access public
+ Voici le graphe d'appel pour cette fonction :

◆ info()

info ( )

Returns the File extension.

Renvoie
string The File extension @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ lastAccess()

lastAccess ( )

Returns last access time.

Renvoie
integer timestamp Timestamp of last access time @access public
+ Voici le graphe d'appel pour cette fonction :

◆ lastChange()

lastChange ( )

Returns last modified time.

Renvoie
integer timestamp Timestamp of last modification @access public
+ Voici le graphe d'appel pour cette fonction :

◆ md5()

md5 (   $maxsize = 5)

Get md5 Checksum of file with previous check of Filesize

Paramètres
mixed$maxsizein MB or true to force
Renvoie
string md5 Checksum See md5_file() @access public
+ Voici le graphe d'appel pour cette fonction :

◆ name()

name ( )

Returns the File name without extension.

Renvoie
string The File name without extension. @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ offset()

offset (   $offset = false,
  $seek = SEEK_SET 
)

Sets or gets the offset for the currently opened file.

Paramètres
mixed$offsetThe $offset in bytes to seek. If set to false then the current offset is returned.
integer$seekPHP Constant SEEK_SET | SEEK_CUR | SEEK_END determining what the $offset is relative to
Renvoie
mixed True on success, false on failure (set mode), false on failure or integer offset on success (get mode) @access public
+ Voici le graphe d'appel pour cette fonction :

◆ open()

open (   $mode = 'r',
  $force = false 
)

Opens the current file with a given $mode

Paramètres
string$modeA valid 'fopen' mode string (r|w|a ...)
boolean$forceIf true then the file will be re-opened even if its already opened, otherwise it won't
Renvoie
boolean True on success, false on failure @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ owner()

owner ( )

Returns the File's owner.

Renvoie
integer the Fileowner
+ Voici le graphe d'appel pour cette fonction :

◆ perms()

perms ( )

Returns the "chmod" (permissions) of the File.

Renvoie
string Permissions for the file @access public
+ Voici le graphe d'appel pour cette fonction :

◆ prepare()

prepare (   $data)

Prepares a ascii string for writing fixes line endings

Paramètres
string$dataData to prepare for writing.
Renvoie
string @access public

◆ pwd()

pwd ( )

Returns the full path of the File.

Renvoie
string Full path to file @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ read()

read (   $bytes = false,
  $mode = 'rb',
  $force = false 
)

Return the contents of this File as a string.

Paramètres
bool | string | int$byteswhere to start
string$mode
boolean$forceIf true then the file will be re-opened even if its already opened, otherwise it won't
Renvoie
mixed string on success, false on failure @access public
+ Voici le graphe d'appel pour cette fonction :

◆ readable()

readable ( )

Returns true if the File is readable.

Renvoie
boolean true if file is readable, false otherwise @access public
+ Voici le graphe d'appel pour cette fonction :

◆ safe()

safe (   $name = null,
  $ext = null 
)

makes filename safe for saving

Paramètres
string$namethe name of the file to make safe if different from $this->name
null | string$ext
Renvoie
string $ext the extension of the file @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ size()

size ( )

Returns the Filesize, either in bytes or in human-readable format.

Renvoie
string |int filesize as int or as a human-readable string @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ writable()

writable ( )

Returns true if the File is writable.

Renvoie
boolean true if its writable, false otherwise @access public
+ Voici le graphe d'appel pour cette fonction :

◆ write()

write (   $data,
  $mode = 'w',
  $force = false 
)

Write given data to this File.

Paramètres
string$dataData to write to this File.
string$modeMode of writing. See fwrite().
bool | string$forceforce the file to open
Renvoie
boolean Success @access public
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

Documentation des champs

◆ $folder

$folder

◆ $handle

$handle

◆ $info

$info = array()

◆ $lock

$lock

◆ $name

$name
La documentation de cette classe a été générée à partir du fichier suivant :