CategoriesService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\CategoriesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 2.0
Class CategoriesService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| deleteCategory() | Deletes a category(s). |
| deleteCategoryById() | Deletes an category(s) by its ID. |
| deleteGroupById() | Deletes a category group by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| fillGapsInCategoryIds() | Updates a list of category IDs, filling in any gaps in the family tree. |
| getAllGroupIds() | Returns all of the group IDs. |
| getAllGroups() | Returns all category groups. |
| getCategoryById() | Returns a category by its ID. |
| getEditableGroupIds() | Returns all of the category group IDs that are editable by the current user. |
| getEditableGroups() | Returns all editable groups. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getGroupByHandle() | Returns a group by its handle. |
| getGroupById() | Returns a group by its ID. |
| getGroupLocales() | Returns a group's locales. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getTotalGroups() | Gets the total number of category groups. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isGroupTemplateValid() | Returns whether a group’s categories have URLs, and if the group’s template path is valid. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| onBeforeDeleteCategory() | Fires an 'onBeforeDeleteCategory' event. |
| onBeforeDeleteGroup() | Fires an 'onBeforeDeleteGroup' event. |
| onBeforeSaveCategory() | Fires an 'onBeforeSaveCategory' event. |
| onDeleteCategory() | Fires an 'onDeleteCategory' event. |
| onDeleteGroup() | Fires an 'onDeleteGroup' event. |
| onSaveCategory() | Fires an 'onSaveCategory' event. |
| raiseEvent() (opens new window) | Raises an event. |
| saveCategory() | Saves a category. |
| saveGroup() | Saves a category group. |
# deleteCategory()
Deletes a category(s).
View source (opens new window)
Arguments
$categories(Craft\CategoryModel, array (opens new window))
Returns
Throws
Signature
public boolean deleteCategory ( $categories )
# deleteCategoryById()
Deletes an category(s) by its ID.
View source (opens new window)
Arguments
$categoryId(integer (opens new window), array (opens new window))
Returns
Signature
public boolean deleteCategoryById ( $categoryId )
# deleteGroupById()
Deletes a category group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Throws
Signature
public boolean deleteGroupById ( $groupId )
# fillGapsInCategoryIds()
Updates a list of category IDs, filling in any gaps in the family tree.
View source (opens new window)
Arguments
$ids(array (opens new window)) – The original list of category IDs
Returns
array (opens new window) – The list of category IDs with all the gaps filled in.
Signature
public array fillGapsInCategoryIds ( $ids )
# getAllGroupIds()
Signature
public array getAllGroupIds ( )
# getAllGroups()
Returns all category groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getAllGroups ( $indexBy = null )
# getCategoryById()
Returns a category by its ID.
View source (opens new window)
Arguments
$categoryId(integer (opens new window))$localeId(integer (opens new window), null (opens new window))
Returns
Signature
public Craft\CategoryModel, null getCategoryById ( $categoryId, $localeId = null )
# getEditableGroupIds()
Returns all of the category group IDs that are editable by the current user.
View source (opens new window)
Returns
Signature
public array getEditableGroupIds ( )
# getEditableGroups()
Returns all editable groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getEditableGroups ( $indexBy = null )
# getGroupByHandle()
Returns a group by its handle.
View source (opens new window)
Arguments
$groupHandle(string (opens new window))
Returns
Signature
public Craft\CategoryGroupModel, null getGroupByHandle ( $groupHandle )
# getGroupById()
Returns a group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Signature
public Craft\CategoryGroupModel, null getGroupById ( $groupId )
# getGroupLocales()
Returns a group's locales.
View source (opens new window)
Arguments
$groupId(integer (opens new window))$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getGroupLocales ( $groupId, $indexBy = null )
# getTotalGroups()
Signature
public integer getTotalGroups ( )
# isGroupTemplateValid()
Returns whether a group’s categories have URLs, and if the group’s template path is valid.
View source (opens new window)
Arguments
$group(Craft\CategoryGroupModel)
Returns
Signature
public boolean isGroupTemplateValid ( Craft\CategoryGroupModel $group )
# onBeforeDeleteCategory()
Fires an 'onBeforeDeleteCategory' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeDeleteCategory ( Craft\Event $event )
# onBeforeDeleteGroup()
Fires an 'onBeforeDeleteGroup' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeDeleteGroup ( Craft\Event $event )
# onBeforeSaveCategory()
Fires an 'onBeforeSaveCategory' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeSaveCategory ( Craft\Event $event )
# onDeleteCategory()
Fires an 'onDeleteCategory' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onDeleteCategory ( Craft\Event $event )
# onDeleteGroup()
Fires an 'onDeleteGroup' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onDeleteGroup ( Craft\Event $event )
# onSaveCategory()
Fires an 'onSaveCategory' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveCategory ( Craft\Event $event )
# saveCategory()
Saves a category.
View source (opens new window)
Arguments
$category(Craft\CategoryModel)
Returns
Throws
\Craft\Exception|\Exception
Signature
public boolean saveCategory ( Craft\CategoryModel $category )
# saveGroup()
Saves a category group.
View source (opens new window)
Arguments
$group(Craft\CategoryGroupModel)
Returns
Throws
Signature
public boolean saveGroup ( Craft\CategoryGroupModel $group )