ContentBox Core API 1.6.0

contentbox.model.media
Class MediaService

WEB-INF.cftags.component
        extended by contentbox.model.media.MediaService

public class MediaService
extends WEB-INF.cftags.component

******************************************************************************* 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:
  • inject = logbox:logger:{this}
true false
 any moduleSettings


Attributes:
  • inject = coldbox:modulesettings:contentbox-ui
true false
 any providers


Attributes:
true false
 any settingService


Attributes:
  • inject = settingservice@cb
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

init

public init(any wirebox)
Constructor

Parameters:
wirebox
Property Detail

log

any log

Attributes:
inject - logbox:logger:{this}
required - false
serializable - true
default -

moduleSettings

any moduleSettings

Attributes:
inject - coldbox:modulesettings:contentbox-ui
required - false
serializable - true
default -

providers

any providers

Attributes:
default -
serializable - true
required - false

settingService

any settingService

Attributes:
inject - settingservice@cb
required - false
serializable - true
default -

Method Detail

GETLOG

public any GETLOG()
get:


GETMODULESETTINGS

public any GETMODULESETTINGS()
get:


GETPROVIDERS

public any GETPROVIDERS()
get:


GETSETTINGSERVICE

public any GETSETTINGSERVICE()
get:


SETLOG

public MediaService SETLOG(any log)
set:

Parameters:
log

SETMODULESETTINGS

public MediaService SETMODULESETTINGS(any moduleSettings)
set:

Parameters:
moduleSettings

SETPROVIDERS

public MediaService SETPROVIDERS(any providers)
set:

Parameters:
providers

SETSETTINGSERVICE

public MediaService SETSETTINGSERVICE(any settingService)
set:

Parameters:
settingService

getCoreMediaRoot

public any getCoreMediaRoot(boolean absolute='false')
Get the path to the core media root

Parameters:
absolute

getDefaultProvider

public any getDefaultProvider()
Get the default system media provider object


getDefaultProviderName

public any getDefaultProviderName()
Get the default system media provider name


getProvider

public any getProvider(any name)
Get a named provider object

Parameters:
name

getRegisteredProviders

public array getRegisteredProviders()
Get an array of registered providers in alphabetical order


getRegisteredProvidersMap

public array getRegisteredProvidersMap()
Get an array of registered provider names in alphabetical order with their display names


registerProvider

public MediaService registerProvider(IMediaProvider provider)
Register a new media provider in ContentBox

Parameters:
provider

unRegisterProvider

public MediaService unRegisterProvider(any name)
UnRegister a provider in ContentBox

Parameters:
name

ContentBox Core API 1.6.0