PHP Класс ArticleGalley, ojs

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

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

Свойство Тип Описание
$_submissionFile SubmissionFile

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

Метод Описание
__construct ( ) Constructor.
getBestGalleyId ( ) : string Return the "best" article ID -- If a public article ID is set, use it; otherwise use the internal article Id.
getFile ( ) : SubmissionFile Get the submission file corresponding to this galley.
getFileId ( ) : integer Get file id
getFileType ( ) : string Get the file type corresponding to this galley.
getGalleyLabel ( ) : string Get the localized galley label.
getLabel ( ) : string Get label/title.
getLocale ( ) : string Get locale.
getLocalizedName ( ) : string Override the parent class to fetch the non-localized label.
getName ( $locale ) : array
getViews ( ) : integer Get views count.
isPdfGalley ( ) : boolean Determine whether the galley is a PDF.
setFileId ( $fileId ) Set file ID.
setLabel ( $label ) Set label/title.
setLocale ( $locale ) Set locale.

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

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

Constructor.
public __construct ( )

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

Return the "best" article ID -- If a public article ID is set, use it; otherwise use the internal article Id.
public getBestGalleyId ( ) : string
Результат string

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

Get the submission file corresponding to this galley.
public getFile ( ) : SubmissionFile
Результат SubmissionFile

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

Get file id
public getFileId ( ) : integer
Результат integer

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

Get the file type corresponding to this galley.
public getFileType ( ) : string
Результат string MIME type

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

Get the localized galley label.
public getGalleyLabel ( ) : string
Результат string

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

Get label/title.
public getLabel ( ) : string
Результат string

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

Get locale.
public getLocale ( ) : string
Результат string

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

Override the parent class to fetch the non-localized label.
См. также: Representation::getLocalizedName()
public getLocalizedName ( ) : string
Результат string

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

См. также: Representation::getName() This override exists to provide a functional getName() in order to make native XML export work correctly. It is only used in that single instance.
public getName ( $locale ) : array
$locale string unused, except to match the function prototype in Representation.
Результат array

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

Get views count.
public getViews ( ) : integer
Результат integer

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

Determine whether the galley is a PDF.
public isPdfGalley ( ) : boolean
Результат boolean

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

Set file ID.
public setFileId ( $fileId )
$fileId int

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

Set label/title.
public setLabel ( $label )
$label string

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

Set locale.
public setLocale ( $locale )
$locale string

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

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

public SubmissionFile $_submissionFile
Результат SubmissionFile