contentbox.model.content

Class CategoryService

railo-context.Component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.content.CategoryService
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp 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. Category service for contentbox

    Property Summary
    type property default serializable required
    any contentService


    • inject = contentService@cb
    true false
    any htmlHelper


    • inject = coldbox:plugin:HTMLHelper
    true false
    any populator


    • inject = wirebox:populator
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    array createCategories([any categories])
         Create categories via a comma delimited list and return the entities created.
    boolean deleteCategory(any category)
         Delete a category which also removes itself from all many-to-many relationships.
    array getAllForExport()
         Get all data prepared for export.
    array getAllNames()
         Get an array of names of all categories in the system.
    string importFromData(any importData, [boolean override='false'], [any importLog])
         Import data from an array of structures of categories or just one structure of categories.
    string importFromFile(any importFile, [boolean override='false'])
         Import data from a ContentBox JSON file.
    array inflateCategories([struct memento])
         Inflate categories from a collection via 'category_X' pattern and returns an array of category objects .
    array removeAllRelatedContent(any category)
     
    Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService
    clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getDatasource, getEntityName, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod, setDatasource, setEntityName
     
    Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
    $delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getDefaultAsQuery, getEntityGivenName, getEventHandling, getHQLDynamicCache, getORM, getORMEventHandler, getQueryCacheRegion, getRestrictions, getUseQueryCaching, getUseTransactions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains, setDefaultAsQuery, setEventHandling, setHQLDynamicCache, setORM, setORMEventHandler, setQueryCacheRegion, setUseQueryCaching, setUseTransactions
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    contentService

    property any contentService

    Attributes:
    required - false
    inject - contentService@cb
    serializable - true

    htmlHelper

    property any htmlHelper

    Attributes:
    required - false
    inject - coldbox:plugin:HTMLHelper
    serializable - true

    populator

    property any populator

    Attributes:
    required - false
    inject - wirebox:populator
    serializable - true

    Method Detail

    createCategories

    public array createCategories([any categories])

    Create categories via a comma delimited list and return the entities created

    Parameters:
    categories

    deleteCategory

    public boolean deleteCategory(any category)

    Delete a category which also removes itself from all many-to-many relationships

    Parameters:
    category - The category object to remove from the system

    getAllForExport

    public array getAllForExport()

    Get all data prepared for export


    getAllNames

    public array getAllNames()

    Get an array of names of all categories in the system


    importFromData

    public string importFromData(any importData, [boolean override='false'], [any importLog])

    Import data from an array of structures of categories or just one structure of categories

    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

    inflateCategories

    public array inflateCategories([struct memento])

    Inflate categories from a collection via 'category_X' pattern and returns an array of category objects as its representation

    Parameters:
    memento
    Returns:
    array of categories

    removeAllRelatedContent

    public array removeAllRelatedContent(any category)

    Parameters:
    category