\CGBetterUploadsDisplayableUpload

this class represents the information needed to display an upload on frontend web interface.

It includes regular upload information, and file info, type info, url and download counts etc.

Summary

Methods

Properties

Constants

get()
fieldVal()

$guid
$category_guid
$filename
$display_name
$summary
$description
$author
$created
$fields
$type
$icon
$thumbnail_url
$canonical_url
$file_url
$size
$downloads

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: class.DisplayableUpload.php
Package: CGBetterUploads
Class hierarchy: \CGBetterUploads\DisplayableUpload
Implements
See also: \CGBetterUploads\Upload

Properties

$guid

$guid : string

The upload guid

Type

string

$category_guid

$category_guid : string

The category_guid of the category this upload is associated with

Type

string

$filename

$filename : string

The upload original filename.

Type

string

$display_name

$display_name : string

The upload display name

Type

string

$summary

$summary : string

Brief text summary of this file

Type

string

$description

$description : string

Formatted text details of this file.

Type

string

$author

$author : string

The author's name

Type

string

$created

$created : integer

The unix timestamp when this record was created.

Type

integer

$fields

$fields : array

An associative array of fields for this upload. May be null

Type

array

$type

$type : string

The type of file (See the filetype class). This is for display purposes only.

Type

string

$icon

$icon : string

The URL of the icon that is associated with this files type.

Type

string

$thumbnail_url

$thumbnail_url : string

The URL to the thumbnail associated with this file, if any.

Type

string

$canonical_url

$canonical_url : string

The Canonical URL to this file.

Type

string

$file_url

$file_url : string

The direct URL to the file. Should never be displayed to the public, but can be used for processing.

Type

string

$size

$size : integer

The size of the uploaded file, in bytes.

Type

integer

$downloads

$downloads : integer

The number of times this file has been downloaded

Type

integer

Methods

get()

get(string  $key) : mixed

Get a property of this object.

Parameters

string

$key

The name of the property to retrieve

Returns

mixed

fieldVal()

fieldVal(string  $key) : mixed

Get the value of a field associated with this upload.

Parameters

string

$key

Returns

mixed