SectionsService

Type
Class
Namespace
Craft
Inherits
Craft\SectionsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class SectionsService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteEntryTypeById()Deletes an entry type(s) by its ID.
deleteSectionById()Deletes a section by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
doesHomepageExist()Returns whether a homepage section exists.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()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

Arguments

Returns

boolean

Throws

Signature

public boolean deleteEntryTypeById ( $entryTypeId )

deleteSectionById()

Deletes a section by its ID.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean deleteSectionById ( $sectionId )

doesHomepageExist()

Returns whether a homepage section exists.

View source

Returns

boolean

Signature

public boolean doesHomepageExist ( )

getAllSectionIds()

Returns all of the section IDs.

View source

Returns

array – All the sections’ IDs.

Signature

public array getAllSectionIds ( )

getAllSections()

Returns all sections.

View source

Arguments

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

Returns

array – All the editable sections’ IDs.

Signature

public array getEditableSectionIds ( )

getEditableSections()

Returns all editable sections.

View source

Arguments

Returns

Craft\SectionModel[] – All the editable sections.

Signature

public Craft\SectionModel[] getEditableSections ( $indexBy = null )

getEntryTypeById()

Returns an entry type by its ID.

View source

Arguments

Returns

Craft\EntryTypeModel, null

Signature

public Craft\EntryTypeModel, null getEntryTypeById ( $entryTypeId )

getEntryTypesByHandle()

Returns entry types that have a given handle.

View source

Arguments

Returns

array

Signature

public array getEntryTypesByHandle ( $entryTypeHandle )

getEntryTypesBySectionId()

Returns a section’s entry types.

View source

Arguments

Returns

array

Signature

public array getEntryTypesBySectionId ( $sectionId, $indexBy = null )

getSectionByHandle()

Gets a section by its handle.

View source

Arguments

Returns

Craft\SectionModel, null

Signature

public Craft\SectionModel, null getSectionByHandle ( $sectionHandle )

getSectionById()

Returns a section by its ID.

View source

Arguments

Returns

Craft\SectionModel, null

Signature

public Craft\SectionModel, null getSectionById ( $sectionId )

getSectionLocales()

Returns a section’s locales.

View source

Arguments

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

Arguments

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

Returns

integer

Signature

public integer getTotalEditableSections ( )

getTotalSections()

Gets the total number of sections.

View source

Returns

integer

Signature

public integer getTotalSections ( )

isSectionTemplateValid()

Returns whether a section’s entries have URLs, and if the section’s template path is valid.

View source

Arguments

Returns

boolean

Signature

public boolean isSectionTemplateValid ( Craft\SectionModel $section )

onBeforeDeleteSection()

Fires an 'onBeforeDeleteSection' event.

View source

Arguments

Returns

null

Signature

public null onBeforeDeleteSection ( Craft\Event $event )

onBeforeSaveEntryType()

Fires an 'onBeforeSaveEntryType' event.

View source

Arguments

Returns

null

Signature

public null onBeforeSaveEntryType ( Craft\Event $event )

onBeforeSaveSection()

Fires an 'onBeforeSaveSection' event.

View source

Arguments

Returns

null

Signature

public null onBeforeSaveSection ( Craft\Event $event )

onDeleteSection()

Fires an 'onDeleteSection' event.

View source

Arguments

Returns

null

Signature

public null onDeleteSection ( Craft\Event $event )

onSaveEntryType()

Fires an 'onSaveEntryType' event.

View source

Arguments

Returns

null

Signature

public null onSaveEntryType ( Craft\Event $event )

onSaveSection()

Fires an 'onSaveSection' event.

View source

Arguments

Returns

null

Signature

public null onSaveSection ( Craft\Event $event )

reorderEntryTypes()

Reorders entry types.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean reorderEntryTypes ( $entryTypeIds )

saveEntryType()

Saves an entry type.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveEntryType ( Craft\EntryTypeModel $entryType )

saveSection()

Saves a section.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveSection ( Craft\SectionModel $section )