PHP Class IMP_Compose_Attachment_Storage, horde

Author: Michael Slusarz ([email protected])

Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство	Type	Description
$_id	string	Attachment identifier.
$_tmpfile	string	Temporary file location.
$_user	string	Attachment owner.

Méthodes publiques

Méthode	Description
__construct ( string $user, string $id = null )	Constructor.
__get ( $name )
delete ( )	Delete data from storage.
exists ( ) : boolean	Does the attachment exist in the storage backend?
gc ( )	Garbage collection.
getMetadata ( ) : IMP_Compose_Linked_Metadata	Return metadata about attachment.
getTempFile ( ) : string	Writes attachment data to a temporary file.
read ( ) : Horde_Stream	Read attachment data from storage.
saveMetadata ( IMP_Compose_Linked_Metadata $md = null )	Save attachment metadata.
write ( string $filename, Horde_Mime_Part $part )	Write attachment to storage.

Méthodes protégées

Méthode	Description
_read ( )
_write ( $filename, Horde_Mime_Part $part )

Method Details

__construct() public méthode

Constructor.

public __construct ( string $user, string $id = null )
$user	string	Attachment owner.
$id	string	Attachment identifier.

__get() public méthode

public __get ( $name )

_read() abstract protected méthode

_write() abstract protected méthode

delete() abstract public méthode

Delete data from storage.

abstract public delete ( )

exists() abstract public méthode

Does the attachment exist in the storage backend?

abstract public exists ( ) : boolean
Résultat	boolean	True if the file exists.

gc() public méthode

Garbage collection.

public gc ( )

getMetadata() public méthode

Return metadata about attachment.

public getMetadata ( ) : IMP_Compose_Linked_Metadata
Résultat	IMP_Compose_Linked_Metadata	Metadata object.

getTempFile() public méthode

Writes attachment data to a temporary file.

public getTempFile ( ) : string
Résultat	string	Temporary file path.

read() public méthode

Read attachment data from storage.

public read ( ) : Horde_Stream
Résultat	Horde_Stream	Stream object containing data.

saveMetadata() public méthode

Save attachment metadata.

public saveMetadata ( IMP_Compose_Linked_Metadata $md = null )
$md	IMP_Compose_Linked_Metadata	Metadata object. Null will clear all metadata.

write() public méthode

Write attachment to storage.

public write ( string $filename, Horde_Mime_Part $part )
$filename	string	Filename containing attachment data.
$part	Horde_Mime_Part	Mime part object containing attachment metadata.

Property Details

$_id protected_oe property

Attachment identifier.

protected string $_id
Résultat	string

$_tmpfile protected_oe property

Temporary file location.

protected string $_tmpfile
Résultat	string

$_user protected_oe property

Attachment owner.

protected string $_user
Résultat	string

abstract protected _write ( $filename, Horde_Mime_Part $part )
$part	Horde_Mime_Part