|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.media.CFContentMediaProvider
public class CFContentMediaProvider
******************************************************************************* 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. ******************************************************************************* Deliver file via cfcontent
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
fileUtils
Attributes:
|
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
any
|
mediaService
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETFILEUTILS()
get: |
any |
GETLOG()
get: |
any |
GETMEDIASERVICE()
get: |
CFContentMediaProvider |
SETFILEUTILS(any fileUtils)
set: |
CFContentMediaProvider |
SETLOG(any log)
set: |
CFContentMediaProvider |
SETMEDIASERVICE(any mediaService)
set: |
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 the provider |
private any |
getRealMediaPath(any mediaPath)
*********************************** PRIVATE ******************************************** |
boolean |
mediaExists(any mediaPath)
Validate if a media requested exists |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any fileUtils
inject
- coldbox:plugin:FileUtilsrequired
- falseserializable
- truedefault
- any log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- any mediaService
inject
- mediaService@cbrequired
- falseserializable
- truedefault
- Method Detail |
---|
public any GETFILEUTILS()
public any GETLOG()
public any GETMEDIASERVICE()
public CFContentMediaProvider SETFILEUTILS(any fileUtils)
fileUtils
public CFContentMediaProvider SETLOG(any log)
log
public CFContentMediaProvider SETMEDIASERVICE(any mediaService)
mediaService
public any deliverMedia(any mediaPath)
deliverMedia
in interface
IMediaProvider
mediaPath
- the media path to deliver back to the userpublic any getDescription()
getDescription
in interface
IMediaProvider
public any getDisplayName()
getDisplayName
in interface
IMediaProvider
public any getName()
getName
in interface
IMediaProvider
private any getRealMediaPath(any mediaPath)
mediaPath
public boolean mediaExists(any mediaPath)
mediaExists
in interface
IMediaProvider
mediaPath
- the media path to verify if it exists
|
ContentBox Core API 1.6.0 | ||||
FRAMES |