|
ContentBox Core API 1.5.7 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.search.DBSearch
public class DBSearch
******************************************************************************* 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. ******************************************************************************* Our DB Search Adapter
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
any |
GETCB()
|
any |
GETCONTENTSERVICE()
|
any |
GETWIREBOX()
|
void |
SETCB(any cb)
|
void |
SETCONTENTSERVICE(any contentService)
|
void |
SETWIREBOX(any wirebox)
|
private any |
highlightSearchTerm(any term, any content)
Utility function to help you highlight search terms in content |
ISearchAdapter |
refresh()
If chosen to be implemented, it should refresh search indexes and collections |
any |
renderSearch(string searchTerm, [numeric max='0'], [numeric offset='0'])
Render the search results according to the adapter and returns HTML |
any |
renderSearchWithResults(SearchResults searchResults)
Render the search results according the passed in search results object |
SearchResults |
search(string searchTerm, [numeric max='0'], [numeric offset='0'])
Search content and return an standardized ContentBox Results object |
private any |
stripHTML([any stringTarget])
utility to strip HTML |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public any GETCB()
public any GETCONTENTSERVICE()
public any GETWIREBOX()
public void SETCB(any cb)
cb
public void SETCONTENTSERVICE(any contentService)
contentService
public void SETWIREBOX(any wirebox)
wirebox
private any highlightSearchTerm(any term, any content)
term
- The search termcontent
- The content searchedpublic ISearchAdapter refresh()
refresh
in interface
ISearchAdapter
public any renderSearch(string searchTerm, [numeric max='0'], [numeric offset='0'])
renderSearch
in interface
ISearchAdapter
searchTerm
max
offset
public any renderSearchWithResults(SearchResults searchResults)
renderSearchWithResults
in interface
ISearchAdapter
searchResults
- The search results objectpublic SearchResults search(string searchTerm, [numeric max='0'], [numeric offset='0'])
search
in interface
ISearchAdapter
searchTerm
- The search term to search onmax
- The max results to return if pagingoffset
- The offset to use in the search results if pagingprivate any stripHTML([any stringTarget])
stringTarget
|
ContentBox Core API 1.5.7 | ||||
FRAMES |