contentbox.models.media

Interface IMediaProvider

contentbox.models.media.IMediaProvider
All Known Implementing Classes:
CFContentMediaProvider , ForwardMediaProvider , RelocationMediaProvider

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Interface to implement ContentBox Media Providers

Class Attributes:
None
Method Summary
any deliverMedia(any mediaPath)
     Deliver the media.
any getDescription()
     Get the description of this provider.
any getDisplayName()
     Get the display name of a provider.
any getName()
     The internal name of your media provider.
boolean mediaExists(any mediaPath)
     Validate if a media requested exists.

Method Detail

deliverMedia

public any deliverMedia(any mediaPath)

Deliver the media

Parameters:
mediaPath - the media path to deliver back to the user

getDescription

public any getDescription()

Get the description of this provider


getDisplayName

public any getDisplayName()

Get the display name of a provider


getName

public any getName()

The internal name of your media provider


mediaExists

public boolean mediaExists(any mediaPath)

Validate if a media requested exists

Parameters:
mediaPath - the media path to verify if it exists