SectionsVariable
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\SectionsVariable
- Since
- 1.0
Class SectionsVariable
See also http://craftcms.com
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| getAllSections() | Returns all sections. |
| getEditableSections() | Returns all editable sections. |
| getSectionByHandle() | Returns a section by its handle. |
| getSectionById() | Returns a section by its ID. |
| getTotalEditableSections() | Gets the total number of sections that are editable by the current user. |
| getTotalSections() | Gets the total number of sections. |
# getAllSections()
Returns all sections.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getAllSections ( $indexBy = null )
# getEditableSections()
Returns all editable sections.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getEditableSections ( $indexBy = null )
# getSectionByHandle()
Returns a section by its handle.
View source (opens new window)
Arguments
$handle(string (opens new window))
Returns
Signature
public Craft\SectionModel, null getSectionByHandle ( $handle )
# 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 )
# 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 ( )