Craft 3 Class Reference

Craft
Craft is helper class serving common Craft and Yii framework functionality.
craft\app\web\UrlRule
craft\base\ApplicationTrait
ApplicationTrait
craft\base\ClonefixTrait
Trait ClonefixTrait.
craft\base\Component
Component is the base class for classes representing Craft components in terms of objects.
craft\base\ComponentInterface
ComponentInterface defines the common interface to be implemented by Craft component classes.
craft\base\EagerLoadingFieldInterface
EagerLoadingFieldInterface defines the common interface to be implemented by field classes.
craft\base\Element
Element is the base class for classes representing elements in terms of objects.
craft\base\ElementAction
ElementAction is the base class for classes representing element actions in terms of objects.
craft\base\ElementActionInterface
ElementActionInterface defines the common interface to be implemented by element action classes.
craft\base\ElementInterface
ElementInterface defines the common interface to be implemented by element classes.
craft\base\ElementTrait
ElementTrait implements the common methods and properties for element classes.
craft\base\Field
Field is the base class for classes representing fields in terms of objects.
craft\base\FieldInterface
FieldInterface defines the common interface to be implemented by field classes.
craft\base\FieldTrait
FieldTrait implements the common methods and properties for field classes.
craft\base\FlysystemVolume
FlysystemVolume is the base class for Flysystem-based volume classes.
craft\base\Image
Base Image class.
craft\base\LocalVolumeInterface
LocalVolumeInterface defines the common interface to be implemented by volume classes that are on the local file system.
craft\base\MissingComponentInterface
MissingComponentInterface defines the common interface for classes that represent a missing component class.
craft\base\MissingComponentTrait
MissingComponentTrait implements the common methods and properties for classes implementing craft\base\MissingComponentInterface.
craft\base\Model
Model base class.
craft\base\Plugin
Plugin is the base class for classes representing plugins in terms of objects.
craft\base\PluginInterface
PluginInterface defines the common interface to be implemented by plugin classes.
craft\base\PluginTrait
PluginTrait implements the common methods and properties for plugin classes.
craft\base\PreviewableFieldInterface
PreviewableFieldInterface defines the common interface to be implemented by field classes that wish to be previewable on element indexes in the Control Panel.
craft\base\RequestTrait
Request trait.
craft\base\SavableComponent
SavableComponent is the base class for classes representing savable Craft components in terms of objects.
craft\base\SavableComponentInterface
SavableComponentInterface defines the common interface to be implemented by savable Craft component classes.
craft\base\SavableComponentTrait
SavableComponentTrait implements the common methods and properties for savable component classes.
craft\base\Serializable
Serializable is the interface that should be implemented by classes who want to support customizable representation of their instances when getting stored somewhere.
craft\base\Utility
Utility is the base class for classes representing Control Panel utilities.
craft\base\UtilityInterface
UtilityInterface defines the common interface to be implemented by utility classes.
craft\base\Volume
Volume is the base class for classes representing volumes in terms of objects.
craft\base\VolumeInterface
VolumeInterface defines the common interface to be implemented by volume classes.
craft\base\VolumeTrait
VolumeTrait
craft\base\Widget
Widget is the base class for classes representing dashboard widgets in terms of objects.
craft\base\WidgetInterface
WidgetInterface defines the common interface to be implemented by dashboard widget classes.
craft\base\WidgetTrait
WidgetTrait implements the common methods and properties for dashboard widget classes.
craft\behaviors\EnvAttributeParserBehavior
EnvAttributeParserBehavior can be applied to models with attributes that can be set to either environment variables ($VARIABLE_NAME) or aliases (@aliasName)`.
craft\behaviors\FieldLayoutBehavior
Field Layout behavior.
craft\behaviors\SessionBehavior
Extends \yii\web\Session to add support for setting the session folder and creating it if it doesn’t exist.
craft\cache\AppPathDependency
AppPathDependency is used to determine if Craft’s base path has changed.
craft\composer\Factory
Composer Factory
craft\config\DbConfig
DB config class
craft\config\GeneralConfig
General config class
craft\console\Application
Craft Console Application class
craft\console\Request
craft\console\User
The User component provides APIs for managing the user authentication status.
craft\console\actions\ClearCacheAction
craft\console\controllers\ClearCachesController
Clear caches via the CLI
craft\console\controllers\GcController
Garbage collector.
craft\console\controllers\IndexAssetsController
Re-indexes assets in volumes.
craft\console\controllers\InstallController
Craft CMS CLI installer.
craft\console\controllers\MigrateController
Manages Craft and plugin migrations.
craft\console\controllers\ProjectConfigController
Manages the project config.
craft\console\controllers\ResaveController
Bulk-saves elements
craft\console\controllers\ServeController
Runs PHP built-in web server.
craft\console\controllers\SetupController
Craft CMS setup installer.
craft\console\controllers\UpdateController
Updates Craft and plugins.
craft\controllers\AppController
The AppController class is a controller that handles various actions for Craft updates, control panel requests, upgrading Craft editions and license requests.
craft\controllers\AssetTransformsController
The AssetTransformsController class is a controller that handles various actions related to asset transformations, such as creating, editing and deleting transforms.
craft\controllers\AssetsController
The AssetsController class is a controller that handles various actions related to asset tasks, such as uploading files and creating/deleting/renaming files and folders.
craft\controllers\BaseElementsController
The BaseElementsController class provides some common methods for craft\controllers\ElementsController and \craft\controllers\ElementIndexesController.
craft\controllers\BaseEntriesController
BaseEntriesController is a base class that any entry-related controllers, such as craft\controllers\EntriesController and craft\controllers\EntryRevisionsController, extend to share common functionality.
craft\controllers\BaseUpdaterController
BaseUpdaterController provides the base class for Craft/plugin installation/updating/removal.
craft\controllers\CategoriesController
The CategoriesController class is a controller that handles various actions related to categories and category groups, such as creating, editing and deleting them.
craft\controllers\ChartsController
The ChartsController class is a controller that handles charts related operations such as preparing and returning data, in a format ready to being displayed by Craft charts.
craft\controllers\ConfigSyncController
ConfigSyncController handles the Project Config Sync workflow
craft\controllers\DashboardController
The DashboardController class is a controller that handles various dashboard related actions including managing widgets, getting craft\widgets\Feed feeds and sending craft\widgets\CraftSupport support ticket requests.
craft\controllers\ElementIndexSettingsController
The ElementIndexSettingsController class is a controller that handles various element index settings-related actions.
craft\controllers\ElementsController
The ElementsController class is a controller that handles various element related actions including retrieving and saving element and their corresponding HTML.
craft\controllers\EntriesController
The EntriesController class is a controller that handles various entry related tasks such as retrieving, saving, swapping between entry types, previewing, deleting and sharing entries.
craft\controllers\EntryRevisionsController
The EntryRevisionsController class is a controller that handles various entry version and draft related tasks such as retrieving, saving, deleting, publishing and reverting entry drafts and versions.
craft\controllers\FieldsController
The FieldsController class is a controller that handles various field and field group related tasks such as saving and deleting both fields and field groups.
craft\controllers\GlobalsController
The GlobalsController class is a controller that handles various global and global set related tasks such as saving, deleting displaying both globals and global sets.
craft\controllers\InstallController
The InstallController class is a controller that directs all installation related tasks such as creating the database schema and default content for a Craft installation.
craft\controllers\LivePreviewController
Class LivePreviewController
craft\controllers\NotFoundController
craft\controllers\PluginStoreController
The PluginStoreController class is a controller that handles various actions related to the Plugin Store.
craft\controllers\PluginsController
The PluginsController class is a controller that handles various plugin related tasks such installing, uninstalling, enabling, disabling and saving plugin settings in the control panel.
craft\controllers\QueueController
The QueueController class is a controller that handles various queue-related operations.
craft\controllers\RebrandController
The RebrandController class is a controller that handles various control panel re-branding tasks such as uploading, cropping and deleting site logos and icons.
craft\controllers\RoutesController
The RoutesController class is a controller that handles various route related tasks such as saving, deleting and re-ordering routes in the control panel.
craft\controllers\SectionsController
The SectionsController class is a controller that handles various section and entry type related tasks such as displaying, saving, deleting and reordering them in the control panel.
craft\controllers\SitesController
The SitesController class is a controller that handles various actions related to categories and category groups, such as creating, editing and deleting them.
craft\controllers\StructuresController
The StructuresController class is a controller that handles structure related tasks such as moving an element within a structure.
craft\controllers\SystemMessagesController
The SystemMessagesController class is a controller that handles various email message tasks such as saving email messages.
craft\controllers\SystemSettingsController
The SystemSettingsController class is a controller that handles various control panel settings related tasks such as displaying, saving and testing Craft settings in the control panel.
craft\controllers\TagsController
The TagsController class is a controller that handles various tag and tag group related tasks such as displaying, saving, deleting, searching and creating tags and tag groups in the control panel.
craft\controllers\TemplatesController
The TemplatesController class is a controller that handles various template rendering related tasks for both the control panel and front-end of a Craft site.
craft\controllers\UpdaterController
UpdaterController handles the Craft/plugin update workflow.
craft\controllers\UserSettingsController
The UserSettingsController class is a controller that handles various user group and user settings related tasks such as creating, editing and deleting user groups and saving Craft user settings.
craft\controllers\UsersController
The UsersController class is a controller that handles various user account related tasks such as logging-in, impersonating a user, logging out, forgetting passwords, setting passwords, validating accounts, activating accounts, creating users, saving users, processing user avatars, deleting, suspending and unsuspending users.
craft\controllers\UtilitiesController
craft\controllers\VolumesController
The VolumeController class is a controller that handles various actions related to asset volumes, such as creating, editing, renaming and reordering them.
craft\controllers\pluginstore\InstallController
InstallController handles the plugin installation workflow.
craft\controllers\pluginstore\RemoveController
RemoveController handles the plugin removal workflow.
craft\db\ActiveRecord
Active Record base class.
craft\db\Command
craft\db\Connection
craft\db\FixedOrderExpression
FixedOrderExpression represents the SQL used to apply a fixed order to a DB result.
craft\db\Migration
craft\db\MigrationManager
MigrationManager manages a set of migrations.
craft\db\Paginator
Query Paginator
craft\db\Query
Class Query
craft\db\QueryAbortedException
Class Exception
craft\db\SoftDeleteTrait
Soft-delete trait.
craft\db\StructuredElementQuery
craft\db\Table
This class provides constants for defining Craft’s database table names.
craft\db\TableSchema
craft\db\mysql\ColumnSchema
craft\db\mysql\ColumnSchemaBuilder
craft\db\mysql\QueryBuilder
craft\db\mysql\Schema
craft\db\pgsql\QueryBuilder
craft\db\pgsql\Schema
craft\debug\DeprecatedPanel
Debugger panel that collects and displays deprecation warnings.
craft\debug\RequestPanel
Debugger panel that collects and displays request data.
craft\debug\UserPanel
Debugger panel that collects and displays user info.
craft\elements\Asset
Asset represents an asset element.
craft\elements\Category
Category represents a category element.
craft\elements\Entry
Entry represents an entry element.
craft\elements\GlobalSet
GlobalSet represents a global set element.
craft\elements\MatrixBlock
MatrixBlock represents a matrix block element.
craft\elements\Tag
Tag represents a tag element.
craft\elements\User
User represents a user element.
craft\elements\actions\CopyReferenceTag
CopyReferenceTag represents a Copy Reference Tag element action.
craft\elements\actions\DeepDuplicate
DeepDuplicate represents a "Duplicate (with descendants)" element action.
craft\elements\actions\Delete
Delete represents a Delete element action.
craft\elements\actions\DeleteAssets
DeleteAssets represents a Delete Assets element action.
craft\elements\actions\DeleteUsers
DeleteUsers represents a Delete Users element action.
craft\elements\actions\DownloadAssetFile
DownloadAssetFile represents a Download Asset element action.
craft\elements\actions\Duplicate
Duplicate represents a Duplicate element action.
craft\elements\actions\Edit
Edit represents an Edit element action.
craft\elements\actions\EditImage
EditImage represents an Edit Image action
craft\elements\actions\NewChild
NewChild represents a New Child element action.
craft\elements\actions\PreviewAsset
View represents a View element action.
craft\elements\actions\RenameFile
RenameFile represents a Rename File element action.
craft\elements\actions\ReplaceFile
ReplaceFile represents a Replace File element action.
craft\elements\actions\Restore
Restore represents a Restore element action.
craft\elements\actions\SuspendUsers
SuspendUsers represents a Suspend Users element action.
craft\elements\actions\UnsuspendUsers
UnsuspendUsers represents an Unsuspend Users element action.
craft\elements\actions\View
View represents a View element action.
craft\elements\db\AssetQuery
AssetQuery represents a SELECT SQL statement for assets in a way that is independent of DBMS.
craft\elements\db\CategoryQuery
CategoryQuery represents a SELECT SQL statement for categories in a way that is independent of DBMS.
craft\elements\db\ElementQuery
ElementQuery represents a SELECT SQL statement for elements in a way that is independent of DBMS.
craft\elements\db\ElementQueryInterface
ElementQueryInterface defines the common interface to be implemented by element query classes.
craft\elements\db\ElementRelationParamParser
Parses a relatedTo param on an ElementQuery.
craft\elements\db\EntryQuery
EntryQuery represents a SELECT SQL statement for entries in a way that is independent of DBMS.
craft\elements\db\GlobalSetQuery
GlobalSetQuery represents a SELECT SQL statement for global sets in a way that is independent of DBMS.
craft\elements\db\MatrixBlockQuery
MatrixBlockQuery represents a SELECT SQL statement for global sets in a way that is independent of DBMS.
craft\elements\db\TagQuery
TagQuery represents a SELECT SQL statement for tags in a way that is independent of DBMS.
craft\elements\db\UserQuery
UserQuery represents a SELECT SQL statement for users in a way that is independent of DBMS.
craft\enums\LicenseKeyStatus
The LicenseKeyStatus class is an abstract class that defines all of the license key status states that are available in Craft.
craft\enums\PatchManifestFileAction
The PatchManifestFileAction class is an abstract class that defines all of the different path manifest file actions that are available in Craft during an auto-update.
craft\enums\PeriodType
The PeriodType class is an abstract class that defines the various time period lengths that are available in Craft.
craft\enums\PluginUpdateStatus
The PluginUpdateStatus class is an abstract class that defines the different plugin version update status states available in Craft.
craft\enums\VersionUpdateStatus
The VersionUpdateStatus class is an abstract class that defines the different update status states available in Craft.
craft\errors\AssetConflictException
Class AssetConflictException
craft\errors\AssetDisallowedExtensionException
Class AssetDisallowedExtensionException
craft\errors\AssetException
Class AssetException
craft\errors\AssetLogicException
Class AssetLogicException
craft\errors\AssetTransformException
Class AssetTransformException
craft\errors\CategoryGroupNotFoundException
Class CategoryGroupNotFoundException
craft\errors\DbConnectException
Class DbConnectException
craft\errors\DeprecationException
Deprecation Error Exception
craft\errors\ElementNotFoundException
Class ElementNotFoundException
craft\errors\EntryDraftNotFoundException
Class EntryDraftNotFoundException
craft\errors\EntryTypeNotFoundException
Class EntryTypeNotFoundException
craft\errors\EtException
Class EtException
craft\errors\FieldGroupNotFoundException
Class FieldGroupNotFoundException
craft\errors\FieldNotFoundException
Class FieldNotFoundException
craft\errors\FileException
Class FileException
craft\errors\GlobalSetNotFoundException
Class GlobalSetNotFoundException
craft\errors\ImageException
Class ImageException
craft\errors\InvalidElementException
InvalidElementException represents an exception caused by setting an invalid element.
craft\errors\InvalidLicenseKeyException
InvalidLicenseKeyException represents an exception caused by setting an invalid license key on a plugin.
craft\errors\InvalidPluginException
Class InvalidPluginException
craft\errors\InvalidSubpathException
Class InvalidSubpathException
craft\errors\InvalidTypeException
Class InvalidTypeException
craft\errors\InvalidVolumeException
Class InvalidVolumeException
craft\errors\MatrixBlockTypeNotFoundException
Class MatrixBlockTypeNotFoundException
craft\errors\MigrateException
MigrateException represents an error that occurred while migrating Craft or a plugin.
craft\errors\MigrationException
MigrationException represents an exception thrown while executing a migration.
craft\errors\MissingComponentException
MissingComponentException represents an exception caused by creating a component with a missing class.
craft\errors\OperationAbortedException
Class OperationAbortedException
craft\errors\RouteNotFoundException
Class RouteNotFoundException
craft\errors\SectionNotFoundException
Class SectionNotFoundException
craft\errors\ShellCommandException
ShellCommandException represents an exception caused by setting an invalid license key on a plugin.
craft\errors\SiteGroupNotFoundException
Class SiteGroupNotFoundException
craft\errors\SiteNotFoundException
Class SiteNotFoundException
craft\errors\StructureNotFoundException
Class StructureNotFoundException
craft\errors\TagGroupNotFoundException
Class TagGroupNotFoundException
craft\errors\TokenNotFoundException
Class TokenNotFoundException
craft\errors\UploadFailedException
Class UploadFailedException
craft\errors\UserGroupNotFoundException
Class UserGroupNotFoundException
craft\errors\UserLockedException
Class UserLockedException
craft\errors\UserNotFoundException
Class UserNotFoundException
craft\errors\VolumeException
Class VolumeException
craft\errors\VolumeObjectExistsException
Class VolumeFileExistsException
craft\errors\VolumeObjectNotFoundException
Class VolumeFileNotFoundException
craft\errors\WidgetNotFoundException
Class WidgetNotFoundException
craft\errors\WrongEditionException
Class WrongEditionException
craft\events\AssetEvent
Asset event class.
craft\events\AssetThumbEvent
Asset Thumbnail event
craft\events\AssetTransformEvent
Asset transform event class.
craft\events\AssetTransformImageEvent
Asset transform image event class.
craft\events\AuthenticateUserEvent
Authenticate User event class.
craft\events\BackupEvent
Backup event class.
craft\events\CancelableEvent
CancelableEvent class.
craft\events\CategoryGroupEvent
Category group event class.
craft\events\ConfigEvent
Config event class.
craft\events\DefineBehaviorsEvent
Define behaviors event class.
craft\events\DefineComponentsEvent
Define components event class.
craft\events\DefineEagerLoadingMapEvent
DefineEagerLoadingMapEvent class.
craft\events\DefineRulesEvent
DefineRulesEvent class.
craft\events\DefineUserContentSummaryEvent
DefineUserContentSummaryEvent class.
craft\events\DeleteElementEvent
Delete element event class.
craft\events\DeleteSiteEvent
Delete Site event class.
craft\events\DeleteTemplateCachesEvent
Delete Template Caches event class.
craft\events\DraftEvent
Draft event class.
craft\events\EditionChangeEvent
Edition Change event class.
craft\events\ElementActionEvent
Element action event class.
craft\events\ElementContentEvent
Element content event class.
craft\events\ElementEvent
Element event class.
craft\events\ElementStructureEvent
ElementStructureEvent class.
craft\events\EntryTypeEvent
Entry type event class.
craft\events\ErrorEvent
Exception event class.
craft\events\ExceptionEvent
Exception event class.
craft\events\FieldElementEvent
FieldElementEvent class.
craft\events\FieldEvent
FieldEvent class.
craft\events\FieldGroupEvent
FieldGroupEvent class.
craft\events\FieldLayoutEvent
Field layout Event class.
craft\events\GenerateTransformEvent
Asset generate transform event class.
craft\events\GetAssetThumbUrlEvent
Get Asset thumb url event class
craft\events\GetAssetUrlEvent
Get Asset url event class
craft\events\GlobalSetContentEvent
Global Set content event class.
craft\events\GlobalSetEvent
Global Set event class.
craft\events\LoginFailureEvent
LoginFailureEvent class.
craft\events\MergeElementsEvent
Merged elements event class.
craft\events\ModelEvent
ModelEvent class.
craft\events\MoveElementEvent
Move element event class.
craft\events\PluginEvent
PluginEvent class.
craft\events\PopulateElementEvent
Element event class.
craft\events\RegisterAssetFileKindsEvent
RegisterAssetFileKinds class.
craft\events\RegisterCacheOptionsEvent
RegisterCacheOptionsEvent class.
craft\events\RegisterComponentTypesEvent
RegisterComponentTypesEvent class.
craft\events\RegisterCpAlertsEvent
RegisterCpAlertsEvent class.
craft\events\RegisterCpNavItemsEvent
RegisterCpNavItemsEvent class.
craft\events\RegisterCpSettingsEvent
RegisterCpSettingsEvent class.
craft\events\RegisterElementActionsEvent
RegisterElementActionsEvent class.
craft\events\RegisterElementDefaultTableAttributesEvent
RegisterElementDefaultTableAttributesEvent class.
craft\events\RegisterElementHtmlAttributesEvent
RegisterElementHtmlAttributesEvent class.
craft\events\RegisterElementSearchableAttributesEvent
RegisterElementSearchableAttributesEvent class.
craft\events\RegisterElementSortOptionsEvent
RegisterElementSortOptionsEvent class.
craft\events\RegisterElementSourcesEvent
RegisterElementSourcesEvent class.
craft\events\RegisterElementTableAttributesEvent
RegisterElementTableAttributesEvent class.
craft\events\RegisterEmailMessagesEvent
RegisterEmailMessagesEvent class.
craft\events\RegisterTemplateRootsEvent
RegisterTemplateRootsEvent class.
craft\events\RegisterUrlRulesEvent
RegisterUrlRulesEvent class.
craft\events\RegisterUserActionsEvent
RegisterUserActionsEvent class.
craft\events\RegisterUserPermissionsEvent
RegisterUserPermissionsEvent class.
craft\events\ReorderSitesEvent
Reorder Sites event class.
craft\events\ReplaceAssetEvent
Replace asset event class.
craft\events\ResolveResourcePathEvent
ResolveResourcePathEvent class.
craft\events\RestoreEvent
Restore event class.
craft\events\RouteEvent
RouteEvent class.
craft\events\SearchEvent
SearchEvent class.
craft\events\SectionEvent
Section event class.
craft\events\SetAssetFilenameEvent
SetAssetFilenameEvent class.
craft\events\SetElementRouteEvent
SetElementRouteEvent class.
craft\events\SetElementTableAttributeHtmlEvent
SetElementTableAttributeHtmlEvent class.
craft\events\SetStatusEvent
Set Status element action event class.
craft\events\SiteEvent
Site event class.
craft\events\SiteGroupEvent
SiteGroupEvent class.
craft\events\TagGroupEvent
Tag group event class.
craft\events\TemplateEvent
TemplateEvent class.
craft\events\UserAssignGroupEvent
User assign group event class.
craft\events\UserEvent
User event class.
craft\events\UserGroupEvent
UserGroupEvent class.
craft\events\UserGroupsAssignEvent
User Groups assign event class.
craft\events\VersionEvent
Entry event class.
craft\events\VolumeEvent
VolumeEvent class.
craft\events\WidgetEvent
WidgetEvent class.
craft\feeds\Feeds
The Feeds service provides APIs for fetching remote RSS and Atom feeds.
craft\feeds\GuzzleClient
PSR-7 Guzzle client for the Feeds service.
craft\fields\Assets
Assets represents an Assets field.
craft\fields\BaseOptionsField
BaseOptionsField is the base class for classes representing an options field.
craft\fields\Categories
Categories represents a Categories field.
craft\fields\Checkboxes
Checkboxes represents a Checkboxes field.
craft\fields\Color
Color represents a Color field.
craft\fields\Date
Date represents a Date/Time field.
craft\fields\Dropdown
Dropdown represents a Dropdown field.
craft\fields\Email
Email represents an Email field.
craft\fields\Entries
Entries represents an Entries field.
craft\fields\Lightswitch
Lightswitch represents a Lightswitch field.
craft\fields\Matrix
Matrix represents a Matrix field.
craft\fields\MissingField
MissingField represents a field with an invalid class.
craft\fields\MultiSelect
MultiSelect represents a Multi-select field.
craft\fields\Number
Number represents a Number field.
craft\fields\PlainText
PlainText represents a Plain Text field.
craft\fields\RadioButtons
RadioButtons represents a Radio Buttons field.
craft\fields\Table
Table represents a Table field.
craft\fields\Tags
Tags represents a Tags field.
craft\fields\Url
Url represents a URL field.
craft\fields\Users
Users represents a Users field.
craft\fields\data\ColorData
Multi-select option field data class.
craft\fields\data\MultiOptionsFieldData
Multi-select option field data class.
craft\fields\data\OptionData
Class OptionData
craft\fields\data\SingleOptionFieldData
Single-select option field data class.
craft\helpers\App
App helper.
craft\helpers\ArrayHelper
Class ArrayHelper
craft\helpers\Assets
Class Assets
craft\helpers\Component
Component helper
craft\helpers\ConfigHelper
Config helper
craft\helpers\Console
Console helper
craft\helpers\Cp
Class Cp
craft\helpers\DateTimeHelper
Class DateTimeHelper
craft\helpers\Db
Class Db
craft\helpers\ElementHelper
Class ElementHelper
craft\helpers\FileHelper
Class FileHelper
craft\helpers\Html
Class Html
craft\helpers\HtmlPurifier
HtmlPurifier provides an ability to clean up HTML from any harmful code.
craft\helpers\Image
Class Image
craft\helpers\Install
Install helper
craft\helpers\Json
Class Json
craft\helpers\Localization
Class Localization
craft\helpers\MailerHelper
Class MailerHelper
craft\helpers\MigrationHelper
Migration utility methods.
craft\helpers\Number
Class Number
craft\helpers\Path
Class Path
craft\helpers\ProjectConfig
Class ProjectConfig
craft\helpers\Search
Search helper.
craft\helpers\Sequence
Class Sequence
craft\helpers\StringHelper
This helper class provides various multi-byte aware string related manipulation and encoding methods.
craft\helpers\Stringy
The entire purpose of this class is so we can get at the charsArray in Stringy, which is a protected method and the creators did not want to expose as public.
craft\helpers\UrlHelper
Class Url
craft\helpers\User
Class User
craft\i18n\FormatConverter
craft\i18n\Formatter
craft\i18n\I18N
craft\i18n\Locale
Stores locale info.
craft\i18n\PhpMessageSource
Class PhpMessageSource
craft\image\Raster
Raster class is used for raster image manipulations.
craft\image\Svg
Svg class is used for SVG file manipulations.
craft\log\FileTarget
Class FileTarget
craft\mail\Mailer
The Mailer component provides APIs for sending email in Craft.
craft\mail\Message
Represents an email message.
craft\mail\transportadapters\BaseTransportAdapter
Php implements a PHP Mail transport adapter into Craft’s mailer.
craft\mail\transportadapters\Gmail
Smtp implements a Gmail transport adapter into Craft’s mailer.
craft\mail\transportadapters\Sendmail
Sendmail implements a Sendmail transport adapter into Craft’s mailer.
craft\mail\transportadapters\Smtp
Smtp implements a SMTP transport adapter into Craft’s mailer.
craft\mail\transportadapters\TransportAdapterInterface
TransportAdapterInterface defines the common interface to be implemented by SwiftMailer transport adapter classes.
craft\migrations\CreateMatrixContentTable
CreateMatrixContentTable Migration
craft\migrations\Install
Installation Migration
craft\models\AssetIndexData
AssetIndexData model class.
craft\models\AssetTransform
The AssetTransform model class.
craft\models\AssetTransformIndex
Class AssetTransformIndex model.
craft\models\BaseEntryRevisionModel
Class BaseEntryRevision model.
craft\models\CategoryGroup
CategoryGroup model.
craft\models\CategoryGroup_SiteSettings
CategoryGroup_SiteSettings model class.
craft\models\CraftIdToken
Class CraftIdToken model.
craft\models\CraftSupport
Class CraftSupport model.
craft\models\DeprecationError
DeprecationError model.
craft\models\EntryDraft
Class EntryDraft model.
craft\models\EntryType
EntryType model class.
craft\models\EntryVersion
Class EntryVersion model.
craft\models\FieldGroup
FieldGroup model class.
craft\models\FieldLayout
FieldLayout model class.
craft\models\FieldLayoutTab
FieldLayoutTab model class.
craft\models\FolderCriteria
Folders parameters.
craft\models\Info
Class Info model.
craft\models\MailSettings
MailSettings Model class.
craft\models\MatrixBlockType
MatrixBlockType model class.
craft\models\Section
Section model class.
craft\models\Section_SiteSettings
Section_SiteSettings model class.
craft\models\Site
Site model class.
craft\models\SiteGroup
SiteGroup model class.
craft\models\Structure
Class Structure model.
craft\models\SystemMessage
SystemMessage represents a system email message.
craft\models\TagGroup
TagGroup model.
craft\models\Update
Craft/plugin update model.
craft\models\UpdateRelease
Stores the info for an update release.
craft\models\Updates
Stores all of the available update info.
craft\models\Url
URL model.
craft\models\UserGroup
UserGroup model class.
craft\models\VolumeFolder
The VolumeFolder model class.
craft\mutex\FileMutex
craft\queue\BaseJob
Job is the base class for classes representing jobs in terms of objects.
craft\queue\Command
Manages application db-queue.
craft\queue\InfoAction
Info about queue status.
craft\queue\JobInterface
JobInterface defines the common interface to be implemented by job classes.
craft\queue\Queue
Craft Queue
craft\queue\QueueInterface
QueueInterface defines the common interface to be implemented by queue classes.
craft\queue\QueueLogBehavior
Queue Log Behavior
craft\queue\VerboseBehavior
Verbose Behavior
craft\queue\jobs\DeleteStaleTemplateCaches
DeleteStaleTemplateCaches job
craft\queue\jobs\FindAndReplace
FindAndReplace job
craft\queue\jobs\GeneratePendingTransforms
GeneratePendingTransforms job
craft\queue\jobs\LocalizeRelations
LocalizeRelations job
craft\queue\jobs\PropagateElements
PropagateElements job
craft\queue\jobs\ResaveElements
ResaveElements job
craft\queue\jobs\UpdateElementSlugsAndUris
UpdateElementSlugsAndUris job
craft\records\Asset
Class Asset record.
craft\records\AssetIndexData
Class AssetIndexData record.
craft\records\AssetTransform
Class AssetTransform record.
craft\records\Category
Category record.
craft\records\CategoryGroup
Class CategoryGroup record.
craft\records\CategoryGroup_SiteSettings
Class CategoryGroup_SiteSettings record.
craft\records\CraftIdToken
Class CraftIdToken record.
craft\records\Element
Element record class.
craft\records\Element_SiteSettings
Element_SiteSettings record class.
craft\records\Entry
Class Entry record.
craft\records\EntryDraft
Stores entry drafts.
craft\records\EntryType
Class EntryType record.
craft\records\EntryVersion
Class EntryVersion record.
craft\records\Field
Class Field record.
craft\records\FieldGroup
Class FieldGroup record.
craft\records\FieldLayout
Field layout record class.
craft\records\FieldLayoutField
Class FieldLayoutField record.
craft\records\FieldLayoutTab
Field record class.
craft\records\GlobalSet
Field group record class.
craft\records\MatrixBlock
Class MatrixBlock record.
craft\records\MatrixBlockType
Class MatrixBlockType record.
craft\records\Migration
Class Migration record.
craft\records\Plugin
Class Plugin record.
craft\records\Route
Class Route record.
craft\records\Section
Class Section record.
craft\records\Section_SiteSettings
Class Section_SiteSettings record.
craft\records\Session
Class Session record.
craft\records\Site
Class Site record.
craft\records\SiteGroup
SiteGroup record.
craft\records\Structure
Class Structure record.
craft\records\StructureElement
Class StructureElement record.
craft\records\SystemMessage
Class SystemMessage record.
craft\records\Tag
Class Tag record.
craft\records\TagGroup
Class TagGroup record.
craft\records\Token
Token record.
craft\records\User
Class User record.
craft\records\UserGroup
Class UserGroup record.
craft\records\UserGroup_User
Class UserGroup_User record.
craft\records\UserPermission
Class UserPermission record.
craft\records\UserPermission_User
Class UserPermission_User record.
craft\records\UserPermission_UserGroup
Class UserPermission_UserGroup record.
craft\records\Volume
Class Volume record.
craft\records\VolumeFolder
Class VolumeFolder record.
craft\records\Widget
Class Widget record.
craft\search\SearchQuery
Search Query class.
craft\search\SearchQueryTerm
Search Query Term class Represents a term in the search query.
craft\search\SearchQueryTermGroup
Search Query Term Group class Contains multiple SearchQueryTerm instances, each representing a term in the search query that was combined by "OR".
craft\services\Api
The API service provides APIs for calling the Craft API (api.craftcms.com).
craft\services\AssetIndexer
Class AssetIndexer
craft\services\AssetTransforms
Asset Transforms service.
craft\services\Assets
Assets service.
craft\services\Categories
Categories service.
craft\services\Composer
Composer service.
craft\services\Config
The Config service provides APIs for retrieving the values of Craft’s config settings, as well as the values of any plugins’ config settings.
craft\services\Content
Content service.
craft\services\Dashboard
Dashboard service.
craft\services\Deprecator
Deprecator service.
craft\services\ElementIndexes
The ElementIndexes service provides APIs for managing element indexes.
craft\services\Elements
The Elements service provides APIs for managing elements.
craft\services\Entries
The Entries service provides APIs for managing entries in Craft.
craft\services\EntryRevisions
Entry Revisions service.
craft\services\Fields
Fields service.
craft\services\Gc
Garbage collection service.
craft\services\Globals
Globals service.
craft\services\Path
The Path service provides APIs for getting server paths that are used by Craft.
craft\services\PluginStore
Plugin Store service.
craft\services\Plugins
The Plugins service provides APIs for managing plugins.
craft\services\ProjectConfig
Project config service.
craft\services\Relations
Relations service.
craft\services\Routes
Routes service.
craft\services\Search
Handles search operations.
craft\services\Sections
Sections service.
craft\services\Security
Security component.
craft\services\Sites
Sites service.
craft\services\Structures
Structures service.
craft\services\SystemMessages
System Messages service.
craft\services\SystemSettings
System Settings service.
craft\services\Tags
Tags service.
craft\services\TemplateCaches
Template Caches service.
craft\services\Tokens
The Tokens service.
craft\services\Updates
Updates service.
craft\services\UserGroups
User Groups service.
craft\services\UserPermissions
User Permissions service.
craft\services\Users
The Users service provides APIs for managing users.
craft\services\Utilities
The Utilities service provides APIs for managing utilities.
craft\services\Volumes
Class AssetVolumesService
craft\utilities\AssetIndexes
AssetIndexes represents a AssetIndexes dashboard widget.
craft\utilities\ClearCaches
ClearCaches represents a ClearCaches dashboard widget.
craft\utilities\DbBackup
DbBackup represents a DbBackup dashboard widget.
craft\utilities\DeprecationErrors
DeprecationErrors represents a DeprecationErrors dashboard widget.
craft\utilities\FindAndReplace
FindAndReplace represents a FindAndReplace dashboard widget.
craft\utilities\Migrations
Migrations represents a Migrations utility.
craft\utilities\PhpInfo
PhpInfo represents a PhpInfo dashboard widget.
craft\utilities\SearchIndexes
SearchIndexes represents a SearchIndexes dashboard widget.
craft\utilities\SystemMessages
SystemMessages represents a System Messages utility.
craft\utilities\SystemReport
SystemReport represents a SystemReport dashboard widget.
craft\utilities\Updates
Updates represents a Updates dashboard widget.
craft\validators\ArrayValidator
Class ArrayValidator.
craft\validators\AssetLocationValidator
Class AssetLocationValidator.
craft\validators\ColorValidator
Color hex validator
craft\validators\DateTimeValidator
Class DateTimeValidator.
craft\validators\ElementUriValidator
Class ElementUriValidator.
craft\validators\HandleValidator
Class HandleValidator.
craft\validators\LanguageValidator
Will validate that the given attribute is a valid site language.
craft\validators\SingleSectionUriValidator
Will validate that the given attribute is a valid URI for a single section.
craft\validators\SiteIdValidator
Will validate that the given attribute is a valid site ID.
craft\validators\SlugValidator
Class SlugValidator.
craft\validators\StringValidator
Class StringValidator.
craft\validators\TemplateValidator
Class TemplateValidator.
craft\validators\UniqueValidator
Class UniqueValidator.
craft\validators\UriFormatValidator
Will validate that the given attribute is a valid URI format.
craft\validators\UriValidator
Will validate that the given attribute is a valid URI.
craft\validators\UrlValidator
Class UrlValidator.
craft\validators\UserPasswordValidator
Class UserPasswordValidator.
craft\validators\UsernameValidator
Class UsernameValidator.
craft\volumes\Local
The local volume class. Handles the implementation of the local filesystem as a volume in Craft.
craft\volumes\MissingVolume
MissingVolume represents a volume with an invalid class.
craft\volumes\Temp
The temporary volume class. Handles the implementation of a temporary volume Craft.
craft\web\Application
Craft Web Application class
craft\web\AssetBundle
craft\web\AssetManager
craft\web\Controller
Controller is a base class that all controllers in Craft extend.
craft\web\ErrorHandler
Class ErrorHandler
craft\web\Request
craft\web\Response
craft\web\ServiceUnavailableHttpException
UnavailableHttpException represents a "Service Unavailable" HTTP exception with status code 503.
craft\web\Session
Extends yii\web\Session to add support for setting the session folder and creating it if it doesn’t exist.
craft\web\UploadedFile
UploadedFile represents the information for an uploaded file.
craft\web\UrlManager
craft\web\UrlRule
craft\web\User
The User component provides APIs for managing the user authentication status.
craft\web\View
craft\web\assets\assetindexes\AssetIndexesAsset
Asset bundle for the Asset Indexes utility
craft\web\assets\clearcaches\ClearCachesAsset
Asset bundle for the Clear Caches utility
craft\web\assets\cp\CpAsset
Asset bundle for the Control Panel
craft\web\assets\craftsupport\CraftSupportAsset
Asset bundle for the Craft Support widget
craft\web\assets\d3\D3Asset
D3 asset bundle.
craft\web\assets\dashboard\DashboardAsset
Asset bundle for the Dashboard
craft\web\assets\datepickeri18n\DatepickerI18nAsset
Datepicker I18n asset bundle.
craft\web\assets\dbbackup\DbBackupAsset
Asset bundle for the DB Backup utility
craft\web\assets\deprecationerrors\DeprecationErrorsAsset
Asset bundle for the Deprecation Warnings utility
craft\web\assets\editcategory\EditCategoryAsset
Asset bundle for the Edit Category page
craft\web\assets\editentry\EditEntryAsset
Asset bundle for the Edit Entry page
craft\web\assets\edittransform\EditTransformAsset
Asset bundle for the Edit Transform page
craft\web\assets\edituser\EditUserAsset
Asset bundle for the Edit User page
craft\web\assets\elementresizedetector\ElementResizeDetectorAsset
ElementResizeDetector asset bundle.
craft\web\assets\fabric\FabricAsset
Fabric asset bundle.
craft\web\assets\feed\FeedAsset
Asset bundle for Feed widgets
craft\web\assets\fields\FieldsAsset
Asset bundle for the Fields index page
craft\web\assets\fileupload\FileUploadAsset
File Upload asset bundle.
craft\web\assets\findreplace\FindReplaceAsset
Asset bundle for the Find & Replace utility
craft\web\assets\garnish\GarnishAsset
Garnish asset bundle.
craft\web\assets\generalsettings\GeneralSettingsAsset
Asset bundle for the General Settings page
craft\web\assets\installer\InstallerAsset
Asset bundle for the Installer
craft\web\assets\jquerypayment\JqueryPaymentAsset
JqueryPayment asset bundle.
craft\web\assets\jquerytouchevents\JqueryTouchEventsAsset
JqueryTouchEvents asset bundle.
craft\web\assets\jqueryui\JqueryUiAsset
JQuery UI asset bundle.
craft\web\assets\login\LoginAsset
Asset bundle for the Login page
craft\web\assets\matrix\MatrixAsset
Asset bundle for Matrix fields
craft\web\assets\matrixsettings\MatrixSettingsAsset
Asset bundle for Matrix field settings
craft\web\assets\newusers\NewUsersAsset
Asset bundle for New Users widgets
craft\web\assets\picturefill\PicturefillAsset
Picturefill asset bundle.
craft\web\assets\plugins\PluginsAsset
Asset bundle for the Plugins page
craft\web\assets\pluginstore\PluginStoreAsset
Asset bundle for the Plugin Store page
craft\web\assets\pluginstoreoauth\PluginStoreOauthAsset
Asset bundle for the Plugin Store page
craft\web\assets\positionselect\PositionSelectAsset
Asset bundle for Position Select fields
craft\web\assets\prismjs\PrismJsAsset
PrismJs asset bundle.
craft\web\assets\quickpost\QuickPostAsset
Asset bundle for Quick Post widgets
craft\web\assets\qunit\QunitAsset
Qunit asset bundle.
craft\web\assets\recententries\RecentEntriesAsset
Asset bundle for Recent Entries widgets
craft\web\assets\routes\RoutesAsset
Asset bundle for the Routes page
craft\web\assets\searchindexes\SearchIndexesAsset
Asset bundle for the Search Indexes utility
craft\web\assets\selectize\SelectizeAsset
Selectize asset bundle.
craft\web\assets\sites\SitesAsset
Asset bundle for the Sites page
craft\web\assets\systemmessages\SystemMessagesAsset
Asset bundle for the Email Messages page
craft\web\assets\tablesettings\TableSettingsAsset
Asset bundle for Table field settings
craft\web\assets\tests\TestsAsset
Asset bundle for the Tests page
craft\web\assets\timepicker\TimepickerAsset
Timepicker asset bundle.
craft\web\assets\updater\UpdaterAsset
Asset bundle for the Updater
craft\web\assets\updates\UpdatesAsset
Asset bundle for the Updates utility
craft\web\assets\updateswidget\UpdatesWidgetAsset
Asset bundle for Updates widgets
craft\web\assets\userpermissions\UserPermissionsAsset
Asset bundle for user permissions
craft\web\assets\utilities\UtilitiesAsset
Asset bundle for the Utilities section
craft\web\assets\velocity\VelocityAsset
Velocity asset bundle.
craft\web\assets\vue\VueAsset
Vue asset bundle.
craft\web\assets\whatsnew\WhatsNewAsset
Asset bundle for the What's New page
craft\web\assets\xregexp\XregexpAsset
Xregexp asset bundle.
craft\web\twig\Environment
Base Twig template class.
craft\web\twig\Extension
Class Extension
craft\web\twig\Template
Base Twig template class.
craft\web\twig\TemplateLoader
craft\web\twig\TemplateLoaderException
Class TemplateLoaderException
craft\web\twig\nodes\CacheNode
Cache twig node.
craft\web\twig\nodes\ExitNode
Class ExitNode
craft\web\twig\nodes\GetAttrNode
GetAttrNode is an alternative to \Twig\Node\Expression\GetAttrExpression, which sends attribute calls to \craft\helpers\Template::attribute() rather than twig_get_attribute().
craft\web\twig\nodes\HeaderNode
Class HeaderNode
craft\web\twig\nodes\HookNode
Class HookNode
craft\web\twig\nodes\NamespaceNode
Class NamespaceNode
craft\web\twig\nodes\NavItem_Node
Internal node used by the nav node.
craft\web\twig\nodes\NavNode
Represents a nav node.
craft\web\twig\nodes\PaginateNode
Represents a paginate node.
craft\web\twig\nodes\RedirectNode
Class RedirectNode
craft\web\twig\nodes\RegisterResourceNode
Class RegisterResourceNode
craft\web\twig\nodes\RequireAdminNode
Class RequireAdminNode
craft\web\twig\nodes\RequireEditionNode
Class RequireEditionNode
craft\web\twig\nodes\RequireLoginNode
Class RequireLoginNode
craft\web\twig\nodes\RequirePermissionNode
Class RequirePermissionNode
craft\web\twig\nodes\SwitchNode
Class SwitchNode Based on the rejected Twig pull request: https://github.com/fabpot/Twig/pull/185
craft\web\twig\nodevisitors\BaseEventTagVisitor
EventTagFinder adds “head”, “beginBody”, and “endBody” events to the template as it’s being compiled.
craft\web\twig\nodevisitors\EventTagAdder
EventTagAdder adds missing head(), beginBody(), and endBody() event tags to templates as they’re being compiled.
craft\web\twig\nodevisitors\EventTagFinder
EventTagFinder looks for head(), beginBody(), and endBody() event tags in templates as they’re being compiled.
craft\web\twig\nodevisitors\GetAttrAdjuster
GetAttrAdjuster swaps \Twig\Node\Expression\GetAttrExpression nodes with craft\web\twig\nodes\GetAttrNode nodes.
craft\web\twig\tokenparsers\CacheTokenParser
Class CacheTokenParser
craft\web\twig\tokenparsers\ExitTokenParser
Class ExitTokenParser
craft\web\twig\tokenparsers\HeaderTokenParser
Class HeaderTokenParser
craft\web\twig\tokenparsers\HookTokenParser
Class HookTokenParser
craft\web\twig\tokenparsers\NamespaceTokenParser
Class NamespaceTokenParser
craft\web\twig\tokenparsers\NavTokenParser
Recursively outputs a hierarchical navigation.
craft\web\twig\tokenparsers\PaginateTokenParser
Paginates elements via an craft\elements\db\ElementQuery instance.
craft\web\twig\tokenparsers\RedirectTokenParser
Class RedirectTokenParser
craft\web\twig\tokenparsers\RegisterResourceTokenParser
Class RegisterResourceTokenParser
craft\web\twig\tokenparsers\RequireAdminTokenParser
Class RequireAdminTokenParser
craft\web\twig\tokenparsers\RequireEditionTokenParser
Class RequireEditionTokenParser
craft\web\twig\tokenparsers\RequireLoginTokenParser
Class RequireLoginTokenParser
craft\web\twig\tokenparsers\RequirePermissionTokenParser
Class RequirePermissionTokenParser
craft\web\twig\tokenparsers\SwitchTokenParser
Class SwitchTokenParser that parses {% switch %} tags.
craft\web\twig\variables\CategoryGroups
Class CategoryGroupsVariable
craft\web\twig\variables\Config
Class Config variable.
craft\web\twig\variables\Cp
CP functions
craft\web\twig\variables\CraftVariable
Craft defines the craft global template variable.
craft\web\twig\variables\Deprecator
Class Deprecator variable.
craft\web\twig\variables\ElementIndexes
Class ElementIndexes variable.
craft\web\twig\variables\EmailMessages
Email functions.
craft\web\twig\variables\EntryRevisions
Class EntryRevisions variable.
craft\web\twig\variables\Feeds
Class Feeds variable.
craft\web\twig\variables\Fields
Fields provides an API for accessing information about fields. It is accessible from templates via craft.fields.
craft\web\twig\variables\Globals
Globals functions.
craft\web\twig\variables\I18N
Localization functions.
craft\web\twig\variables\Image
Class Image variable.
craft\web\twig\variables\Io
Io variable.
craft\web\twig\variables\Paginate
Paginate variable class.
craft\web\twig\variables\Rebrand
Rebranding functions.
craft\web\twig\variables\Request
Request functions.
craft\web\twig\variables\Routes
Route functions.
craft\web\twig\variables\Sections
Class Sections variable.
craft\web\twig\variables\SystemSettings
Settings functions.
craft\web\twig\variables\UserGroups
User group functions.
craft\web\twig\variables\UserPermissions
User permission functions.
craft\web\twig\variables\UserSession
User session functions.
craft\widgets\CraftSupport
CraftSupport represents a Craft Support dashboard widget.
craft\widgets\Feed
Feed represents a Feed dashboard widget.
craft\widgets\MissingWidget
MissingWidget represents a widget with an invalid class.
craft\widgets\NewUsers
NewUsers represents a New Users dashboard widget.
craft\widgets\QuickPost
QuickPost represents a Quick Post dashboard widget.
craft\widgets\RecentEntries
RecentEntries represents a Recent Entries dashboard widget.
craft\widgets\Updates
Updates represents an Updates dashboard widget.