PHP Класс Gaufrette\File

Автор: Antoine Hérault ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$content Content variable is lazy. It will not be read from filesystem until it's requested first time.
$filesystem
$key
$metadata metadata in associative array. Only for adapters that support metadata
$mtime File date modified.
$name Human readable filename (usually the end of the key).
$size File size in bytes.

Открытые методы

Метод Описание
__construct ( string $key, gaufrette\Filesystem $filesystem )
createStream ( ) : gaufrette\Stream Creates a new file stream instance of the file.
delete ( array $metadata = [] ) : boolean Deletes the file from the filesystem.
exists ( ) : boolean Indicates whether the file exists in the filesystem.
getContent ( array $metadata = [] ) : string Returns the content.
getKey ( ) : string Returns the key.
getMtime ( ) : integer Returns the file modified time.
getName ( ) : string
getSize ( ) : integer
setContent ( string $content, array $metadata = [] ) : integer Sets the content.
setName ( string $name )
setSize ( integer $size )

Защищенные методы

Метод Описание
setMetadata ( array $metadata ) : boolean Sets the metadata array to be stored in adapters that can support it.

Приватные методы

Метод Описание
supportsMetadata ( ) : boolean

Описание методов

__construct() публичный Метод

public __construct ( string $key, gaufrette\Filesystem $filesystem )
$key string
$filesystem gaufrette\Filesystem

createStream() публичный Метод

Creates a new file stream instance of the file.
public createStream ( ) : gaufrette\Stream
Результат gaufrette\Stream

delete() публичный Метод

Deletes the file from the filesystem.
public delete ( array $metadata = [] ) : boolean
$metadata array optional metadata which should be send when write
Результат boolean TRUE on success

exists() публичный Метод

Indicates whether the file exists in the filesystem.
public exists ( ) : boolean
Результат boolean

getContent() публичный Метод

Returns the content.
public getContent ( array $metadata = [] ) : string
$metadata array optional metadata which should be set when read
Результат string

getKey() публичный Метод

Returns the key.
public getKey ( ) : string
Результат string

getMtime() публичный Метод

Returns the file modified time.
public getMtime ( ) : integer
Результат integer

getName() публичный Метод

public getName ( ) : string
Результат string name of the file

getSize() публичный Метод

public getSize ( ) : integer
Результат integer size of the file

setContent() публичный Метод

Sets the content.
public setContent ( string $content, array $metadata = [] ) : integer
$content string
$metadata array optional metadata which should be send when write
Результат integer The number of bytes that were written into the file, or FALSE on failure

setMetadata() защищенный Метод

Sets the metadata array to be stored in adapters that can support it.
protected setMetadata ( array $metadata ) : boolean
$metadata array
Результат boolean

setName() публичный Метод

public setName ( string $name )
$name string name of the file

setSize() публичный Метод

public setSize ( integer $size )
$size integer size of the file

Описание свойств

$content защищенное свойство

Content variable is lazy. It will not be read from filesystem until it's requested first time.
protected $content

$filesystem защищенное свойство

protected $filesystem

$key защищенное свойство

protected $key

$metadata защищенное свойство

metadata in associative array. Only for adapters that support metadata
protected $metadata

$mtime защищенное свойство

File date modified.
protected $mtime

$name защищенное свойство

Human readable filename (usually the end of the key).
protected $name

$size защищенное свойство

File size in bytes.
protected $size