lucee.Componentcontentbox.models.media.MediaService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manage's the system's media files
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
log
|
true
|
false
|
|
any
|
moduleSettings
|
true
|
false
|
|
struct
|
providers
ContentBox Providers Map.
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
Constructor Summary | |
---|---|
init(any wirebox)
Constructor. |
Method Summary | |
---|---|
any
|
getCoreMediaRoot(boolean absolute='false')
Get the path to the core media root. |
any
|
getDefaultProvider()
Get the default system media provider object. |
any
|
getDefaultProviderName()
Get the default system media provider name. |
string
|
getLog()
|
string
|
getModuleSettings()
|
any
|
getProvider(any name)
Get a named provider object. |
string
|
getProviders()
|
array
|
getRegisteredProviders()
Get an array of registered providers in alphabetical order. |
array
|
getRegisteredProvidersMap()
Get an array of registered provider names in alphabetical order with their display names. |
string
|
getSettingService()
|
MediaService
|
registerProvider(IMediaProvider provider)
Register a new media provider in ContentBox. |
any
|
setLog(any log)
|
any
|
setModuleSettings(any moduleSettings)
|
any
|
setProviders(struct providers)
|
any
|
setSettingService(any settingService)
|
MediaService
|
unRegisterProvider(any name)
UnRegister a provider in ContentBox. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
wirebox
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:modulesettings:contentbox-uiserializable
- trueContentBox Providers Map
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- settingservice@cbserializable
- trueMethod Detail |
---|
Get the path to the core media root
absolute
- Return the absolute path or relative, if absolute then it expands the path.Get the default system media provider object
Get the default system media provider name
Get a named provider object
name
- The provider to get,that must be registeredGet an array of registered providers in alphabetical order
Get an array of registered provider names in alphabetical order with their display names
Register a new media provider in ContentBox
provider
- The provider object to registerlog
moduleSettings
providers
settingService
UnRegister a provider in ContentBox
name
- The name of the provider to unregister