PHP Class Attachment

Author: Marcel Werk
Inheritance: extends DatabaseObject
Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Méthodes publiques

Свойство Type Description
$m_columnNames
$m_dbTableName
$m_keyColumnNames
$m_keyIsAutoIncrement

Méthodes publiques

Méthode Description
Attachment ( $p_id = null )
GetTotalAttachments ( ) : integer
GetUnedited ( $p_id ) : array Return the ids of the file not edited yet.
OnFileUpload ( array $p_fileVar, array $p_attributes, integer $p_id = null, boolean $p_uploaded = false ) : mixed This function should be called when an attachment is uploaded. It will save the attachment to the appropriate place on the disk, and create a database entry for the file.
ProcessFile ( string $p_tmpFile, string $p_newFile, integer $p_userId = NULL, $p_attributes = NULL ) : Image | null Process multi-upload file.
delete ( ) constructor
getAttachmentId ( ) : integer
getAttachmentUri ( ) : string Return the full URL to the attached image.
getAttachmentUrl ( ) : string Return the full URL to the attached image.
getCharset ( ) : string Return the CHARSET which should be set in the HTTP header sent to the downloader.
getContentDisposition ( ) : mixed Return whether the "content-disposition" HTTP header should be set.
getDescription ( integer $p_languageId ) : string Get the description in the given language.
getDescriptionId ( ) : integer Get the description ID which is an index into the Translations table.
getExtension ( ) : string Return the file name extension
getFileName ( ) : string
getLanguageId ( ) : integer If this attachment is language-specific, e.g. a PDF written in Serbian, this will return the language id of the attachment.
getLastModified ( ) fn setDescription
getLevel1DirectoryName ( ) fn getStorageLocation
getLevel2DirectoryName ( ) fn getLevel1DirectoryName
getMimeType ( ) : string Return the MIME type which should be set in the HTTP header to the downloader.
getSizeInBytes ( ) : integer Get the size of the file in bytes
getSource ( ) : string
getStatus ( ) : string
getStorageLocation ( ) : string Get the full path to the storage location of the file on disk.
getTimeCreated ( ) fn getLastModified
getUploadingUserId ( ) : integer
inUse ( ) : boolean Return true if the attachment is being used by an article.
makeDirectories ( ) fn getLevel2DirectoryName
setContentDisposition ( mixed $p_value ) : boolean Set the "content-disposition" HTTP header.
setDescription ( integer $p_languageId, string $p_text ) Set the description in the given language.
setLanguageId ( integer $p_value ) : boolean

Method Details

Attachment() public méthode

public Attachment ( $p_id = null )

GetTotalAttachments() public static méthode

public static GetTotalAttachments ( ) : integer
Résultat integer

GetUnedited() public static méthode

Return the ids of the file not edited yet.
public static GetUnedited ( $p_id ) : array
Résultat array

OnFileUpload() public static méthode

This function should be called when an attachment is uploaded. It will save the attachment to the appropriate place on the disk, and create a database entry for the file.
public static OnFileUpload ( array $p_fileVar, array $p_attributes, integer $p_id = null, boolean $p_uploaded = false ) : mixed
$p_fileVar array 
	The variable from the $_FILES array.  The array specifies the following:
$a["name"] = original name of the file.
	$a["type"] = the MIME type of the file
$a["tmp_name"] = the temporary storage location on disk of the file
$a["size"] = size of the file, in bytes (not required)
$a["error"] = 0 (zero) if there was no error
$p_attributes array Optional attributes which are stored in the database. Indexes can be the following: 'content_disposition', 'fk_language_id', 'http_charset', 'fk_user_id'
$p_id integer If the attachment already exists and we just want to update it, specify the current ID here.
$p_uploaded boolean If the attachment was uploaded with other mechanism (ex: plUploader) this is set so that the single upload file from article functionality is still secured.
Résultat mixed The Attachment object that was created or updated. Return a PEAR_Error on failure.

ProcessFile() public static méthode

Process multi-upload file.
public static ProcessFile ( string $p_tmpFile, string $p_newFile, integer $p_userId = NULL, $p_attributes = NULL ) : Image | null
$p_tmpFile string
$p_newFile string
$p_userId integer
Résultat Image | null

delete() public méthode

constructor
public delete ( )

getAttachmentId() public méthode

public getAttachmentId ( ) : integer
Résultat integer

getAttachmentUri() public méthode

Return the full URL to the attached image.
public getAttachmentUri ( ) : string
Résultat string

getAttachmentUrl() public méthode

Return the full URL to the attached image.
public getAttachmentUrl ( ) : string
Résultat string

getCharset() public méthode

Return the CHARSET which should be set in the HTTP header sent to the downloader.
public getCharset ( ) : string
Résultat string

getContentDisposition() public méthode

This will return either NULL or the string "attachment".
public getContentDisposition ( ) : mixed
Résultat mixed

getDescription() public méthode

This is a convenience function that wraps the Translation::GetPhrase() function.
public getDescription ( integer $p_languageId ) : string
$p_languageId integer
Résultat string

getDescriptionId() public méthode

Get the description ID which is an index into the Translations table.
public getDescriptionId ( ) : integer
Résultat integer

getExtension() public méthode

Return the file name extension
public getExtension ( ) : string
Résultat string

getFileName() public méthode

public getFileName ( ) : string
Résultat string

getLanguageId() public méthode

Otherwise, it will return NULL.
public getLanguageId ( ) : integer
Résultat integer

getLastModified() public méthode

fn setDescription
public getLastModified ( )

getLevel1DirectoryName() public méthode

fn getStorageLocation
public getLevel1DirectoryName ( )

getLevel2DirectoryName() public méthode

fn getLevel1DirectoryName
public getLevel2DirectoryName ( )

getMimeType() public méthode

Return the MIME type which should be set in the HTTP header to the downloader.
public getMimeType ( ) : string
Résultat string

getSizeInBytes() public méthode

Get the size of the file in bytes
public getSizeInBytes ( ) : integer
Résultat integer

getSource() public méthode

public getSource ( ) : string
Résultat string

getStatus() public méthode

public getStatus ( ) : string
Résultat string

getStorageLocation() public méthode

Get the full path to the storage location of the file on disk.
public getStorageLocation ( ) : string
Résultat string

getTimeCreated() public méthode

fn getLastModified
public getTimeCreated ( )

getUploadingUserId() public méthode

public getUploadingUserId ( ) : integer
Résultat integer

inUse() public méthode

Return true if the attachment is being used by an article.
public inUse ( ) : boolean
Résultat boolean

makeDirectories() public méthode

fn getLevel2DirectoryName
public makeDirectories ( )

setContentDisposition() public méthode

Set the "content-disposition" HTTP header.
public setContentDisposition ( mixed $p_value ) : boolean
$p_value mixed
Résultat boolean

setDescription() public méthode

Set the description in the given language.
public setDescription ( integer $p_languageId, string $p_text )
$p_languageId integer
$p_text string

setLanguageId() public méthode

public setLanguageId ( integer $p_value ) : boolean
$p_value integer
Résultat boolean

Property Details

$m_columnNames public_oe property

public $m_columnNames

$m_dbTableName public_oe property

public $m_dbTableName

$m_keyColumnNames public_oe property

public $m_keyColumnNames

$m_keyIsAutoIncrement public_oe property

public $m_keyIsAutoIncrement