|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.media.MediaService
public class MediaService
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* Manage's the system's media files
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
log
Attributes:
|
|
true
|
false
|
any
|
moduleSettings
Attributes:
|
|
true
|
false
|
any
|
providers
Attributes: |
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init(any wirebox)
Constructor |
Method Summary | |
---|---|
any |
GETLOG()
get: |
any |
GETMODULESETTINGS()
get: |
any |
GETPROVIDERS()
get: |
any |
GETSETTINGSERVICE()
get: |
MediaService |
SETLOG(any log)
set: |
MediaService |
SETMODULESETTINGS(any moduleSettings)
set: |
MediaService |
SETPROVIDERS(any providers)
set: |
MediaService |
SETSETTINGSERVICE(any settingService)
set: |
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 |
any |
getProvider(any name)
Get a named provider object |
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 |
MediaService |
registerProvider(IMediaProvider provider)
Register a new media provider in ContentBox |
MediaService |
unRegisterProvider(any name)
UnRegister a provider in ContentBox |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any wirebox)
wirebox
Property Detail |
---|
any log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- any moduleSettings
inject
- coldbox:modulesettings:contentbox-uirequired
- falseserializable
- truedefault
- any providers
default
- serializable
- truerequired
- falseany settingService
inject
- settingservice@cbrequired
- falseserializable
- truedefault
- Method Detail |
---|
public any GETLOG()
public any GETMODULESETTINGS()
public any GETPROVIDERS()
public any GETSETTINGSERVICE()
public MediaService SETLOG(any log)
log
public MediaService SETMODULESETTINGS(any moduleSettings)
moduleSettings
public MediaService SETPROVIDERS(any providers)
providers
public MediaService SETSETTINGSERVICE(any settingService)
settingService
public any getCoreMediaRoot(boolean absolute='false')
absolute
public any getDefaultProvider()
public any getDefaultProviderName()
public any getProvider(any name)
name
public array getRegisteredProviders()
public array getRegisteredProvidersMap()
public MediaService registerProvider(IMediaProvider provider)
provider
public MediaService unRegisterProvider(any name)
name
|
ContentBox Core API 1.6.0 | ||||
FRAMES |