SectionsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\SectionsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class SectionsService
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. |
| deleteEntryTypeById() | Deletes an entry type(s) by its ID. |
| deleteSectionById() | Deletes a section 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. |
| doesHomepageExist() | Returns whether a homepage section exists. |
| 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. |
| getAllSectionIds() | Returns all of the section IDs. |
| getAllSections() | Returns all sections. |
| getEditableSectionIds() | Returns all of the section IDs that are editable by the current user. |
| getEditableSections() | Returns all editable sections. |
| getEntryTypeById() | Returns an entry type by its ID. |
| getEntryTypesByHandle() | Returns entry types that have a given handle. |
| getEntryTypesBySectionId() | Returns a section’s entry types. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getSectionByHandle() | Gets a section by its handle. |
| getSectionById() | Returns a section by its ID. |
| getSectionLocales() | Returns a section’s locales. |
| getSectionsByType() | Returns all sections of a given type. |
| getTotalEditableSections() | Gets the total number of sections that are editable by the current user. |
| getTotalSections() | Gets the total number of sections. |
| 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. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| isSectionTemplateValid() | Returns whether a section’s entries have URLs, and if the section’s template path is valid. |
| onBeforeDeleteSection() | Fires an 'onBeforeDeleteSection' event. |
| onBeforeSaveEntryType() | Fires an 'onBeforeSaveEntryType' event. |
| onBeforeSaveSection() | Fires an 'onBeforeSaveSection' event. |
| onDeleteSection() | Fires an 'onDeleteSection' event. |
| onSaveEntryType() | Fires an 'onSaveEntryType' event. |
| onSaveSection() | Fires an 'onSaveSection' event. |
| raiseEvent() (opens new window) | Raises an event. |
| reorderEntryTypes() | Reorders entry types. |
| saveEntryType() | Saves an entry type. |
| saveSection() | Saves a section. |
# deleteEntryTypeById()
Deletes an entry type(s) by its ID.
View source (opens new window)
Arguments
$entryTypeId(integer (opens new window), array (opens new window))
Returns
Throws
Signature
public boolean deleteEntryTypeById ( $entryTypeId )
# deleteSectionById()
Deletes a section by its ID.
View source (opens new window)
Arguments
$sectionId(integer (opens new window))
Returns
Throws
Signature
public boolean deleteSectionById ( $sectionId )
# doesHomepageExist()
Signature
public boolean doesHomepageExist ( )
# getAllSectionIds()
Returns all of the section IDs.
View source (opens new window)
Returns
array (opens new window) – All the sections’ IDs.
Signature
public array getAllSectionIds ( )
# getAllSections()
Returns all sections.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Craft\SectionModel[] – All the sections.
Signature
public Craft\SectionModel[] getAllSections ( $indexBy = null )
# getEditableSectionIds()
Returns all of the section IDs that are editable by the current user.
View source (opens new window)
Returns
array (opens new window) – All the editable sections’ IDs.
Signature
public array getEditableSectionIds ( )
# getEditableSections()
Returns all editable sections.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Craft\SectionModel[] – All the editable sections.
Signature
public Craft\SectionModel[] getEditableSections ( $indexBy = null )
# getEntryTypeById()
Returns an entry type by its ID.
View source (opens new window)
Arguments
$entryTypeId(integer (opens new window))
Returns
Signature
public Craft\EntryTypeModel, null getEntryTypeById ( $entryTypeId )
# getEntryTypesByHandle()
Returns entry types that have a given handle.
View source (opens new window)
Arguments
$entryTypeHandle(integer (opens new window))
Returns
Signature
public array getEntryTypesByHandle ( $entryTypeHandle )
# getEntryTypesBySectionId()
Returns a section’s entry types.
View source (opens new window)
Arguments
$sectionId(integer (opens new window))$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getEntryTypesBySectionId ( $sectionId, $indexBy = null )
# getSectionByHandle()
Gets a section by its handle.
View source (opens new window)
Arguments
$sectionHandle(string (opens new window))
Returns
Signature
public Craft\SectionModel, null getSectionByHandle ( $sectionHandle )
# getSectionById()
Returns a section by its ID.
View source (opens new window)
Arguments
$sectionId(integer (opens new window))
Returns
Signature
public Craft\SectionModel, null getSectionById ( $sectionId )
# getSectionLocales()
Returns a section’s locales.
View source (opens new window)
Arguments
$sectionId(integer (opens new window))$indexBy(string (opens new window), null (opens new window))
Returns
Craft\SectionLocaleModel[] – The section’s locales.
Signature
public Craft\SectionLocaleModel[] getSectionLocales ( $sectionId, $indexBy = null )
# getSectionsByType()
Returns all sections of a given type.
View source (opens new window)
Arguments
$type(string (opens new window))
Returns
Craft\SectionModel[] – All the sections of the given type.
Signature
public Craft\SectionModel[] getSectionsByType ( $type )
# getTotalEditableSections()
Gets the total number of sections that are editable by the current user.
View source (opens new window)
Returns
Signature
public integer getTotalEditableSections ( )
# getTotalSections()
Signature
public integer getTotalSections ( )
# isSectionTemplateValid()
Returns whether a section’s entries have URLs, and if the section’s template path is valid.
View source (opens new window)
Arguments
$section(Craft\SectionModel)
Returns
Signature
public boolean isSectionTemplateValid ( Craft\SectionModel $section )
# onBeforeDeleteSection()
Fires an 'onBeforeDeleteSection' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeDeleteSection ( Craft\Event $event )
# onBeforeSaveEntryType()
Fires an 'onBeforeSaveEntryType' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeSaveEntryType ( Craft\Event $event )
# onBeforeSaveSection()
Fires an 'onBeforeSaveSection' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeSaveSection ( Craft\Event $event )
# onDeleteSection()
Fires an 'onDeleteSection' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onDeleteSection ( Craft\Event $event )
# onSaveEntryType()
Fires an 'onSaveEntryType' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveEntryType ( Craft\Event $event )
# onSaveSection()
Fires an 'onSaveSection' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveSection ( Craft\Event $event )
# reorderEntryTypes()
Reorders entry types.
View source (opens new window)
Arguments
$entryTypeIds(array (opens new window))
Returns
Throws
Signature
public boolean reorderEntryTypes ( $entryTypeIds )
# saveEntryType()
Saves an entry type.
View source (opens new window)
Arguments
$entryType(Craft\EntryTypeModel)
Returns
Throws
Signature
public boolean saveEntryType ( Craft\EntryTypeModel $entryType )
# saveSection()
Saves a section.
View source (opens new window)
Arguments
$section(Craft\SectionModel)
Returns
Throws
Signature
public boolean saveSection ( Craft\SectionModel $section )