contentbox.models.media

Class MediaService

lucee.Component
    extended by contentbox.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

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any log
          --------------------------------------------------------------------------.

    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    struct providers
          ContentBox Providers Map.

    • access = public
    • returntype = any
    true false
    any settingService


    • access = public
    • returntype = any
    • inject = settingservice@contentbox
    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 as a string.
    string getLog()
    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(BaseProvider provider)
         Register a new media provider in ContentBox.
    any setLog(any log)
    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

    init

    public init(any wirebox)

    Constructor

    Parameters:
    wirebox

    Property Detail

    log

    property any log

    -------------------------------------------------------------------------- DI --------------------------------------------------------------------------

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    providers

    property struct providers

    ContentBox Providers Map

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    settingService

    property any settingService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - settingservice@contentbox
    serializable - true

    Method Detail

    getCoreMediaRoot

    public any getCoreMediaRoot(boolean absolute='false')

    Get the path to the core media root

    Parameters:
    absolute - Return the absolute path or relative, if absolute then it expands the path.

    getDefaultProvider

    public any getDefaultProvider()

    Get the default system media provider object

    Returns:
    contentbox.models.media.BaseProvider

    getDefaultProviderName

    public any getDefaultProviderName()

    Get the default system media provider name as a string


    getLog

    public string getLog()


    getProvider

    public any getProvider(any name)

    Get a named provider object

    Parameters:
    name - The provider to get,that must be registered
    Returns:
    contentbox.models.media.BaseProvider

    getProviders

    public string getProviders()


    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

    Returns:
    array of structs { name, displayName, description }

    getSettingService

    public string getSettingService()


    registerProvider

    public MediaService registerProvider(BaseProvider provider)

    Register a new media provider in ContentBox

    Parameters:
    provider - The provider object to register

    setLog

    public any setLog(any log)

    Parameters:
    log

    setProviders

    public any setProviders(struct providers)

    Parameters:
    providers

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    unRegisterProvider

    public MediaService unRegisterProvider(any name)

    UnRegister a provider in ContentBox

    Parameters:
    name - The name of the provider to unregister