PHP Class Attachment

Author: Marcel Werk
Inheritance: extends DatabaseObject
ファイルを表示 Open project: sourcefabric/newscoop Class Usage Examples

Public Properties

Property Type Description
$m_columnNames
$m_dbTableName
$m_keyColumnNames
$m_keyIsAutoIncrement

Public Methods

Method 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 method

public Attachment ( $p_id = null )

GetTotalAttachments() public static method

public static GetTotalAttachments ( ) : integer
return integer

GetUnedited() public static method

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

OnFileUpload() public static method

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.
return mixed The Attachment object that was created or updated. Return a PEAR_Error on failure.

ProcessFile() public static method

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
return Image | null

delete() public method

constructor
public delete ( )

getAttachmentId() public method

public getAttachmentId ( ) : integer
return integer

getAttachmentUri() public method

Return the full URL to the attached image.
public getAttachmentUri ( ) : string
return string

getAttachmentUrl() public method

Return the full URL to the attached image.
public getAttachmentUrl ( ) : string
return string

getCharset() public method

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

getContentDisposition() public method

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

getDescription() public method

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

getDescriptionId() public method

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

getExtension() public method

Return the file name extension
public getExtension ( ) : string
return string

getFileName() public method

public getFileName ( ) : string
return string

getLanguageId() public method

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

getLastModified() public method

fn setDescription
public getLastModified ( )

getLevel1DirectoryName() public method

fn getStorageLocation
public getLevel1DirectoryName ( )

getLevel2DirectoryName() public method

fn getLevel1DirectoryName
public getLevel2DirectoryName ( )

getMimeType() public method

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

getSizeInBytes() public method

Get the size of the file in bytes
public getSizeInBytes ( ) : integer
return integer

getSource() public method

public getSource ( ) : string
return string

getStatus() public method

public getStatus ( ) : string
return string

getStorageLocation() public method

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

getTimeCreated() public method

fn getLastModified
public getTimeCreated ( )

getUploadingUserId() public method

public getUploadingUserId ( ) : integer
return integer

inUse() public method

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

makeDirectories() public method

fn getLevel2DirectoryName
public makeDirectories ( )

setContentDisposition() public method

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

setDescription() public method

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

setLanguageId() public method

public setLanguageId ( integer $p_value ) : boolean
$p_value integer
return 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