PHP Класс Attachment

Автор: Marcel Werk
Наследование: extends DatabaseObject
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$m_columnNames
$m_dbTableName
$m_keyColumnNames
$m_keyIsAutoIncrement

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

Метод Описание
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

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

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

public Attachment ( $p_id = null )

GetTotalAttachments() публичный статический Метод

public static GetTotalAttachments ( ) : integer
Результат integer

GetUnedited() публичный статический Метод

Return the ids of the file not edited yet.
public static GetUnedited ( $p_id ) : array
Результат array

OnFileUpload() публичный статический Метод

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.
Результат mixed The Attachment object that was created or updated. Return a PEAR_Error on failure.

ProcessFile() публичный статический Метод

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
Результат Image | null

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

constructor
public delete ( )

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

public getAttachmentId ( ) : integer
Результат integer

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

Return the full URL to the attached image.
public getAttachmentUri ( ) : string
Результат string

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

Return the full URL to the attached image.
public getAttachmentUrl ( ) : string
Результат string

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

Return the CHARSET which should be set in the HTTP header sent to the downloader.
public getCharset ( ) : string
Результат string

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

This will return either NULL or the string "attachment".
public getContentDisposition ( ) : mixed
Результат mixed

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

This is a convenience function that wraps the Translation::GetPhrase() function.
public getDescription ( integer $p_languageId ) : string
$p_languageId integer
Результат string

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

Get the description ID which is an index into the Translations table.
public getDescriptionId ( ) : integer
Результат integer

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

Return the file name extension
public getExtension ( ) : string
Результат string

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

public getFileName ( ) : string
Результат string

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

Otherwise, it will return NULL.
public getLanguageId ( ) : integer
Результат integer

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

fn setDescription
public getLastModified ( )

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

fn getStorageLocation
public getLevel1DirectoryName ( )

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

fn getLevel1DirectoryName
public getLevel2DirectoryName ( )

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

Return the MIME type which should be set in the HTTP header to the downloader.
public getMimeType ( ) : string
Результат string

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

Get the size of the file in bytes
public getSizeInBytes ( ) : integer
Результат integer

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

public getSource ( ) : string
Результат string

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

public getStatus ( ) : string
Результат string

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

Get the full path to the storage location of the file on disk.
public getStorageLocation ( ) : string
Результат string

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

fn getLastModified
public getTimeCreated ( )

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

public getUploadingUserId ( ) : integer
Результат integer

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

Return true if the attachment is being used by an article.
public inUse ( ) : boolean
Результат boolean

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

fn getLevel2DirectoryName
public makeDirectories ( )

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

Set the "content-disposition" HTTP header.
public setContentDisposition ( mixed $p_value ) : boolean
$p_value mixed
Результат boolean

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

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

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

public setLanguageId ( integer $p_value ) : boolean
$p_value integer
Результат boolean

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

$m_columnNames публичное свойство

public $m_columnNames

$m_dbTableName публичное свойство

public $m_dbTableName

$m_keyColumnNames публичное свойство

public $m_keyColumnNames

$m_keyIsAutoIncrement публичное свойство

public $m_keyIsAutoIncrement