ContentBox Core API 1.5.7

contentbox.model.content
Class CustomHTMLService

WEB-INF.cftags.component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.content.CustomHTMLService

public class CustomHTMLService
extends coldbox.system.orm.hibernate.VirtualEntityService

******************************************************************************* 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. ******************************************************************************* Custom HTML service for ContentBox


Constructor Summary
init()
          Constructor
 
Method Summary
 any bulkPublishStatus(any contentID, any status)
          Bulk Publish Status Updates
 any findBySlug(any slug, [boolean throwException='true'])
          Retrieve a content piece by slug
 array getAllForExport()
          Get all data prepared for export
 string importFromData(any importData, [boolean override='false'], [any importLog])
          Import data from an array of structures of customHTML or just one structure of CustomHTML
 string importFromFile(any importFile, [boolean override='false'])
          Import data from a ContentBox JSON file
 any isSlugUnique(any slug, [any contentID=''])
          Verify an incoming slug is unique or not
 any saveCustomHTML(any customHTML)
          Save a custom HTML snippet
 struct search([any search=''], [any isPublished], [any author], [any max='0'], [any offset='0'], [any sortOrder='title'], [boolean searchActiveContent='true'])
          custom HTML search returns struct with keys [entries,count]
 
Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService
GETDATASOURCE, GETENTITYNAME, SETDATASOURCE, SETENTITYNAME, clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod
 
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, GETDEFAULTASQUERY, GETEVENTHANDLING, GETHQLDYNAMICCACHE, GETQUERYCACHEREGION, GETUSEQUERYCACHING, GETUSETRANSACTIONS, SETDEFAULTASQUERY, SETEVENTHANDLING, SETHQLDYNAMICCACHE, SETQUERYCACHEREGION, SETUSEQUERYCACHING, SETUSETRANSACTIONS, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getEntityGivenName, getRestrictions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, refresh, save, saveAll, sessionContains
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Constructor

Method Detail

bulkPublishStatus

public any bulkPublishStatus(any contentID, any status)
Bulk Publish Status Updates

Parameters:
contentID - The list or array of ID's to bulk update
status - The status either 'publish' or 'draft

findBySlug

public any findBySlug(any slug, [boolean throwException='true'])
Retrieve a content piece by slug

Parameters:
slug - The unique slug this content is tied to
throwException - Throw an exception if not found.

getAllForExport

public array getAllForExport()
Get all data prepared for export


importFromData

public string importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures of customHTML or just one structure of CustomHTML

Parameters:
importData
override
importLog

importFromFile

public string importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. Returns the import log

Parameters:
importFile
override

isSlugUnique

public any isSlugUnique(any slug, [any contentID=''])
Verify an incoming slug is unique or not

Parameters:
slug - The slug to search for uniqueness
contentID

saveCustomHTML

public any saveCustomHTML(any customHTML)
Save a custom HTML snippet

Parameters:
customHTML

search

public struct search([any search=''], [any isPublished], [any author], [any max='0'], [any offset='0'], [any sortOrder='title'], [boolean searchActiveContent='true'])
custom HTML search returns struct with keys [entries,count]

Parameters:
search - The search term to search on
isPublished - Flag that searches content as published=1, published=0 (draft) or published=any for all
author - Search with an author or empty/null for all
max - The max records to return
offset - The offset in the return of records
sortOrder - The sorting required. Title by default
searchActiveContent

ContentBox Core API 1.5.7