Class Reference

PackageClassDescription
craft.app #CraftCraft is helper class serving common Craft and Yii framework functionality.
craft.app.assetsourcetypes #BaseAssetSourceTypeThe base class for all asset source types. Any asset source type must extend this class.
GoogleCloudAssetSourceTypeThe Google Cloud asset source type class. Handles the implementation of Google Cloud as an asset source type in Craft.
LocalAssetSourceTypeThe local asset source type class. Handles the implementation of the local filesystem as an asset source type in Craft.
RackspaceAssetSourceTypeThe Rackspace asset source type class. Handles the implementation of Rackspace as an asset source type in Craft.
S3AssetSourceTypeThe S3 asset source type class. Handles the implementation of Amazon S3 as an asset source type in Craft.
TempAssetSourceTypeA temporary asset source type class.
craft.app.consolecommands #BaseCommandBaseCommand extends Yii's \CConsoleCommand<span class="external" and represents an executable console command.
MigrateCommandMigrateCommand is a command for managing Craft and plugin database migrations.
QuerygenCommandThe query generator console command.
craft.app.controllers #AppControllerThe AppController class is a controller that handles various actions for Craft updates, control panel requests, upgrading Craft editions and license requests.
AssetSourcesControllerThe AssetSourcesController class is a controller that handles various actions related to asset sources, such as creating, editing, renaming and reordering them.
AssetTransformsControllerThe AssetTransformsController class is a controller that handles various actions related to asset transformations, such as creating, editing and deleting transforms.
AssetsControllerThe AssetsController class is a controller that handles various actions related to asset tasks, such as uploading files and creating/deleting/renaming files and folders.
BaseControllerBaseController is a base class that all controllers in Craft extend.
BaseElementsControllerThe BaseElementsController class provides some common methods for ElementsController and ElementIndexController.
BaseEntriesControllerBaseController is a base class that any entry related controllers, such as EntriesController and EntryRevisionsController extend to share common functionality.
CategoriesControllerThe CategoriesController class is a controller that handles various actions related to categories and category groups, such as creating, editing and deleting them.
ChartsControllerCharts Controller
DashboardControllerThe DashboardController class is a controller that handles various dashboardrelated actions including managing widgets, getting FeedWidget feeds and sending GetHelpWidget support ticket requests.
ElementIndexControllerThe ElementIndexController class is a controller that handles various element index related actions.
ElementIndexSettingsControllerThe ElementIndexSettingsController class is a controller that handles various element index related actions.
ElementsControllerThe ElementsController class is a controller that handles various element related actions including retrieving and saving element and their corresponding HTML.
EmailMessagesControllerThe EmailMessagesController class is a controller that handles various email message tasks such as saving email messages.
EntriesControllerThe EntriesController class is a controller that handles various entry related tasks such as retrieving, saving, swapping between entry types, previewing, deleting and sharing entries.
EntryRevisionsControllerThe 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.
FieldsControllerThe FieldsController class is a controller that handles various field and field group related tasks such as saving and deleting both fields and field groups.
GlobalsControllerThe GlobalsController class is a controller that handles various global and global set related tasks such as saving, deleting displaying both globals and global sets.
InstallControllerThe InstallController class is a controller that directs all installation related tasks such as creating the database schema and default content for a Craft installation.
LocalizationControllerThe LocalizationController class is a controller that handles various localization related tasks such adding, deleting and re-ordering locales in the control panel.
PluginsControllerThe PluginsController class is a controller that handles various plugin related tasks such installing, uninstalling, enabling, disabling and saving plugin settings in the control panel.
RebrandControllerThe RebrandController class is a controller that handles various control panel re-branding tasks such as uploading, cropping and delete custom logos for displaying on the login page.
RoutesControllerThe RoutesController class is a controller that handles various route related tasks such as saving, deleting and re-ordering routes in the control panel.
SectionsControllerThe 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.
StructuresControllerThe StructuresController class is a controller that handles structure related tasks such as moving an element within a structure.
SystemSettingsControllerThe 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.
TagsControllerThe 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.
TasksControllerThe TasksController class is a controller that handles various task related operations such as running, checking task status, re-running and deleting tasks.
TemplatesControllerThe TemplatesController class is a controller that handles various template rendering related tasks for both the control panel and front-end of a Craft site.
ToolsControllerThe ToolsController class is a controller that handles various tools related tasks such as trigger tool actions.
UpdateControllerThe UpdateController class is a controller that handles various update related tasks such as checking for available updates and running manual and auto-updates.
UserSettingsControllerThe 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.
UsersControllerThe 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 un-suspending users.
UtilsControllerThe UtilsController class is a controller that handles various utility related tasks such as displaying server info, php info, log files and deprecation errors in the control panel.
craft.app.elementactions #BaseElementActionElement Action base class
CopyReferenceTagElementActionCopy Reference Tag Element Action
DeleteAssetsElementActionDelete Assets Element Action
DeleteElementActionDelete Element Action
DeleteUsersElementActionDelete Users Element Action
DownloadFileElementActionDownload File Element Action
EditElementActionEdit Element Action
IElementActionInterface IElementAction
NewChildElementActionNew Child Element Action
RenameFileElementActionRename File Element Action
ReplaceFileElementActionReplace File Element Action
SetStatusElementActionSet Status Element Action
SuspendUsersElementActionSuspend Users Element Action
UnsuspendUsersElementActionUnsuspend Users Element Action
ViewElementActionView Element Action
craft.app.elementtypes #AssetElementTypeThe AssetElementType class is responsible for implementing and defining assets as a native element type in Craft.
BaseElementTypeThe base class for all Craft element types. Any element type must extend this class.
CategoryElementTypeThe CategoryElementType class is responsible for implementing and defining categories as a native element type in Craft.
EntryElementTypeThe EntryElementType class is responsible for implementing and defining entries as a native element type in Craft.
GlobalSetElementTypeThe GlobalSetElementType class is responsible for implementing and defining globals as a native element type in Craft.
IElementTypeThis interface defines the contract that all element types must implement via BaseElementType.
MatrixBlockElementTypeThe MatrixBlockElementType class is responsible for implementing and defining Matrix blocks as a native element type in Craft.
TagElementTypeThe TagElementType class is responsible for implementing and definingtags as a native element type in Craft.
UserElementTypeThe UserElementType class is responsible for implementing and defining users as a native element type in Craft.
craft.app.enums #AssetConflictResolutionThe AssetConflictResolution class is an abstract class that defines all of the Asset conflict resolution options that are available in Craft.
AttributeTypeThe AttributeType class is an abstract class that defines all of the attribute types that are available in Craft. Attribute types are used primarily in Records and Models.
BaseEnumThe BaseEnum class is an abstract class that all enums in Craft inherit. It provides some functionality that mimics first-class citizen enum support in PHP.
CacheMethodThe CacheMethod class is an abstract class that defines all of the cache methods (except for template caching) that are available in Craft.
ColumnTypeThe ColumnType class is an abstract class that defines all of the abstract column types that will eventually be changed to a physical database column type.
ComponentTypeThe ComponentType class is an abstract class that defines all of the component types that are available in Craft.
ConfigFileThe ConfigFile class is an abstract class that defines all of the config file options that are available in Craft.
CraftPackageThe CraftPackage class is an abstract class that defines all of the packages that are available in Craft.
ElementTypeThe ElementType class is an abstract class that defines all of the element types that are available in Craft.
EmailerTypeThe EmailerType class is an abstract class that defines all of the email protocol options that are available in Craft.
InstallStatusThe InstallStatus class is an abstract class that defines all of the install status states that are available in Craft during installation.
InvalidLoginModeThe InvalidLoginMode class is an abstract class that defines all of the invalid login modes that are available in Craft when a user has unsuccessfully attempted to log into their account the number of times specified by the maxInvalidLogins config setting.
LicenseKeyStatusThe LicenseKeyStatus class is an abstract class that defines all of the license key status states that are available in Craft.
LogLevelThe LogLevel class is an abstract class that defines all of the different log level options that are available in Craft when calling Craft::log().
PatchManifestFileActionThe 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.
PeriodTypeThe PeriodType class is an abstract class that defines the various time period lengths that are available in Craft.
PluginUpdateStatusThe PluginUpdateStatus class is an abstract class that defines the different plugin version update status states available in Craft.
RequirementResultThe RequirementResult class is an abstract class that defines the different requirement result status results available in Craft for when the requirement checker runs.
SectionTypeThe SectionType class is an abstract class that defines the different section types available in Craft.
TaskStatusThe TaskStatus class is an abstract class that defines the different task status options available in Craft for the TaskService.
TemplateModeThe TemplateMode class is an abstract class that defines whether the TemplateService is in a Control Panel or Site context.
UserStatusThe UserStatus class is an abstract class that defines the different user account statuses available in Craft.
VersionUpdateStatusThe VersionUpdateStatus class is an abstract class that defines the different update status states available in Craft.
craft.app.etc.behaviors #AppBehaviorClass AppBehavior
BaseBehaviorBehavior base class
FieldLayoutBehaviorField layout behavior.
craft.app.etc.cache #ApcCacheApcCache provides APC caching in terms of an application component.
DbCacheDbCache implements a cache application component by storing cached data in a database.
EAcceleratorCacheEAcceleratorCache implements a cache application module based on eaccelerator.
FileCacheClass FileCache
MemCacheMemCache implements a cache application component based on memcached.
RedisCacheRedisCache implements a cache application component based on redis.
WinCacheWinCache implements a cache application component based on WinCache.
XCacheXCache implements a cache application module based on xcache.
ZendDataCacheZendDataCache implements a cache application module based on the Zend DataCache delivered with ZendServer.
craft.app.etc.cache.dependencies #AppPathCacheDependencyAppPathCacheDependency is used to determine if the path to the craft/app folder has changed.
craft.app.etc.components #BaseApplicationComponentClass BaseApplicationComponent
BaseComponentTypeBase component base class.
BaseSavableComponentTypeBase savable component class.
IComponentTypeComponent type interface.
ISavableComponentTypeSavable component type interface.
craft.app.etc.console #ConsoleAppClass ConsoleApp
ConsoleCommandRunnerClass ConsoleCommandRunner
craft.app.etc.dates #DateFormatterDateFormatter class with functions for date/time-pickers.
DateIntervalClass DateInterval
DateTimeClass DateTime
craft.app.etc.db #BaseMigrationClass BaseMigration
DbBackupThis class provides methods for backing up and restore Craft databases.
DbCommandClass DbCommand
DbConnectionClass DbConnection
craft.app.etc.db.schemas #MysqlSchemaClass MysqlSchema
craft.app.etc.elements #ElementRelationParamParserParses a relatedTo param on an ElementCriteriaModel.
craft.app.etc.errors #DbConnectExceptionClass DbConnectException
EmailTestExceptionClass EmailTestException
ErrorExceptionClass ErrorException
ErrorHandlerErrorHandler handles uncaught PHP errors and exceptions.
EtExceptionClass EtException
ExceptionClass Exception
HttpExceptionClass HttpException
InvalidLicenseKeyExceptionClass InvalidLicenseKeyException
InvalidSourceExceptionClass InvalidSourceException
InvalidSubpathExceptionClass InvalidSubpathException
TemplateLoaderExceptionClass TemplateLoaderException
craft.app.etc.et #EtClass Et
craft.app.etc.events #ElementActionEventElement Action Event class.
EventEvent class.
craft.app.etc.i18n #LocaleDataClass LocaleData
NumberFormatterNumber formatter class.
PhpMessageSourceClass PhpMessageSource
craft.app.etc.image #BaseImageBase Image class
ImageClass Image
SvgImageClass SvgImage
craft.app.etc.io #BaseIOClass BaseIO
FileClass File
FolderClass Folder
IZipInterface IZip
PclZipClass PclZip
ZipClass Zip
ZipArchiveClass ZipArchive
craft.app.etc.logging #FileLogRouteClass FileLogRoute
LogFilterLogFilter pre-processes the logged messages before they are handled by a log route.
LogRouterClass LogRouter
LoggerClass Logger
ProfileLogRouteClass ProfileLogRoute
WebLogRouteClass WebLogRoute
craft.app.etc.plugins #BasePluginPlugin base class.
IPluginInterface IPlugin
craft.app.etc.requirements #IconvRequirementIconv requirement class.
PhpVersionRequirementPHP version requirement class.
RequirementRequirement class.
RequirementsClass Requirements
RequirementsCheckerClass RequirementsChecker
WebRootExposedFolderRequirementAttempts to determine if the craft folder is inside of web root.
craft.app.etc.search #SearchQuerySearch Query class.
SearchQueryTermSearch Query Term class
SearchQueryTermGroupSearch Query Term Group class
craft.app.etc.state #StatePersisterStatePersister implements a file-based persistent data storage.
craft.app.etc.templating #BaseTemplateBase Twig template class.
StringTemplateClass StringTemplate
craft.app.etc.templating.twigextensions #Cache_NodeCache twig node.
Cache_TokenParserClass Cache_TokenParser
CraftTwigExtensionClass CraftTwigExtension
DeprecatedTag_TokenParserClass DeprecatedTag_TokenParser
Exit_NodeClass Exit_Node
Exit_TokenParserClass Exit_TokenParser
Header_NodeClass Header_Node
Header_TokenParserClass Header_TokenParser
Hook_NodeClass Hook_Node
Hook_TokenParserClass Hook_TokenParser
IncludeResource_NodeClass IncludeResource_Node
IncludeResource_TokenParserClass IncludeResource_TokenParser
IncludeTranslations_NodeClass IncludeTranslations_Node
IncludeTranslations_TokenParserClass IncludeTranslations_TokenParser
Namespace_NodeClass Namespace_Node
Namespace_TokenParserClass Namespace_TokenParser
NavItem_NodeInternal node used by the nav node.
Nav_NodeRepresents a nav node.
Nav_TokenParserRecursively outputs a hierarchical navigation.
Paginate_NodeRepresents a paginate node.
Paginate_TokenParserPaginates elements via a ElementCriteriaModel instance.
Redirect_NodeClass Redirect_Node
Redirect_TokenParserClass Redirect_TokenParser
RequireAdmin_NodeClass RequireAdmin_Node
RequireAdmin_TokenParserClass RequireAdmin_TokenParser
RequireEdition_NodeClass RequireEdition_Node
RequireEdition_TokenParserClass RequireEdition_TokenParser
RequireLogin_NodeClass RequireLogin_Node
RequireLogin_TokenParserClass RequireLogin_TokenParser
RequirePermission_NodeClass RequirePermission_Node
RequirePermission_TokenParserClass RequirePermission_TokenParser
Switch_NodeClass Switch_Node
Switch_TokenParserClass Switch_TokenParser that parses {% switch %} tags.
TemplateLoaderLoads Craft templates into Twig.
TwigEnvironmentTwigEnvironment class.
TwigParserTwigParser class.
craft.app.etc.updates #UpdaterClass Updater
craft.app.etc.users #UserIdentityUserIdentity represents the data needed to identify a user. It contains the authentication method that checks if the provided data can identity the user.
craft.app.etc.web #CookieCollectionCookieCollection implements a collection class to store cookies. You normally access it via HttpRequest::getCookies().
HttpCookieA HttpCookie instance stores a single cookie, including the cookie name, value, domain, path, expire time and whether it should be access over a secure connection or not..
UploadedFileUploadedFile represents the information for an uploaded file.
UrlManagerClass UrlManager
WebApp
craft.app.fieldtypes #AssetsFieldTypeAssets fieldtype.
BaseElementFieldTypeBase element fieldtype class.
BaseFieldTypeField type base class.
BaseOptionsFieldTypeClass BaseOptionsFieldType
CategoriesFieldTypeCategories fieldtype.
CheckboxesFieldTypeClass CheckboxesFieldType
ColorFieldTypeClass ColorFieldType
DateFieldTypeClass DateFieldType
DropdownFieldTypeClass DropdownFieldType
EntriesFieldTypeClass EntriesFieldType
IEagerLoadingFieldTypeInterface IEagerLoadingFieldType
IFieldTypeInterface IFieldType
IPreviewableFieldTypeInterface IPreviewableFieldType
LightswitchFieldTypeClass LightswitchFieldType
MatrixFieldTypeClass MatrixFieldType
MultiOptionsFieldDataMulti-select option field data class.
MultiSelectFieldTypeClass MultiSelectFieldType
NumberFieldTypeClass NumberFieldType
OptionDataClass OptionData
PlainTextFieldTypeClass PlainTextFieldType
PositionSelectFieldTypeClass PositionSelectFieldType
RadioButtonsFieldTypeClass RadioButtonsFieldType
RichTextDataStores the data for Rich Text fields.
RichTextFieldTypeClass RichTextFieldType
SingleOptionFieldDataSingle-select option field data class.
TableFieldTypeClass TableFieldType
TagsFieldTypeClass TagsFieldType
UsersFieldTypeClass UsersFieldType
craft.app.helpers #AppHelperClass AppHelper
ArrayHelperClass ArrayHelper
AssetsHelperClass AssetsHelper
ChartHelperClass ChartHelper
CpHelperClass CpHelper
DateTimeHelperClass DateTimeHelper
DbHelperClass DbHelper
ElementHelperClass ElementHelper
FileHelperClass FileHelper
HeaderHelperClass HeaderHelper
HtmlHelperClass HtmlHelper
IOHelperClass IOHelper
ImageHelperClass ImageHelper
JsonHelperClass JsonHelper
LocalizationHelperClass LocalizationHelper
LoggingHelperClass LoggingHelper
MigrationHelperMigration utility methods.
ModelHelperClass ModelHelper
NumberHelperClass NumberHelper
PathHelperClass PathHelper
StringHelperClass StringHelper
TemplateHelperClass TemplateHelper
UpdateHelperHelper class for updating.
UrlHelperClass UrlHelper
VariableHelperHelper class for template variables.
craft.app.models #AccountSettingsModelValidates the required User attributes for the installer.
AppNewReleaseModelStores the info for a Craft release.
AppUpdateModelStores the available Craft update info.
AssetFileModelClass AssetFileModel
AssetFolderModelClass AssetFolderModel
AssetIndexDataModelAsset source model class.
AssetOperationResponseModelThis model represents an Asset Operation Response.
AssetSourceModelAsset source model class
AssetTransformIndexModelClass AssetTransformIndexModel
AssetTransformModelClass AssetTransformModel
BaseComponentModelBase component model class.
BaseElementModelBase element model class.
BaseEntryRevisionModelClass BaseEntryRevisionModel
BaseModelModel base class.
CategoryGroupLocaleModelCategory group locale model class.
CategoryGroupModelCategory group model.
CategoryModelCategory model class.
ContentModelEntry content model class.
DeprecationErrorModelDeprecation log model.
ElementCriteriaModelElement criteria model class.
EmailModelEmail message model class.
EmailSettingsModelEmailSettingsModel class.
EntryDraftModelClass EntryDraftModel
EntryModelEntry model class.
EntryTypeModelEntry type model class.
EntryVersionModelClass EntryVersionModel
EtModelClass EtModel
FieldGroupModelField group model class.
FieldLayoutFieldModelField layout field model class.
FieldLayoutModelField layout model class.
FieldLayoutTabModelField layout tab model class.
FieldModelField model class.
FolderCriteriaModelFolders parameters.
GetHelpModelClass GetHelpModel
GlobalSetModelGlobalSet model class
InfoModelClass InfoModel
LocaleModelStores locale info.
LogEntryModelClass LogEntryModel
MatrixBlockModelMatrix block model class.
MatrixBlockTypeModelMatrix block type model class.
MatrixSettingsModelMatrix block model class.
ModelClass Model
NumberFieldTypeSettingsModel
PasswordModelClass PasswordModel
PluginNewReleaseModelStores the info for a plugin release.
PluginUpdateModelStores the available plugin update info.
RebrandEmailModelEmail message model class.
SectionLocaleModelSection locale model class.
SectionModelSection model class
SiteSettingsModelValidates the required Site attributes for the installer.
StructureModelClass StructureModel
TagGroupModelTag group model.
TagModelTag model class.
TaskModelClass TaskModel
UpdateModelStores all of the available update info.
UpgradeInfoModelUsed to hold edition upgrade information.
UpgradePurchaseModelUsed to hold edition upgrade purchase order data.
UserGroupModelUser group model class.
UserModelUser model class.
UsernameModelUsername model.
WidgetModelWidget model class
urlModelURL model class.
craft.app.records #AssetFileRecordClass AssetFileRecord
AssetFolderRecordClass AssetFolderRecord
AssetIndexDataRecordClass AssetIndexDataRecord
AssetSourceRecordClass AssetSourceRecord
AssetTransformRecordClass AssetTransformRecord
BaseRecordActive Record base class.
CategoryGroupLocaleRecordClass CategoryGroupLocaleRecord
CategoryGroupRecordCategory group record.
CategoryRecordCategory record.
ElementIndexSettingsRecordElement index settings record class.
ElementLocaleRecordElement locale data record class.
ElementRecordElement record class.
EmailMessageRecordClass EmailMessageRecord
EntryDraftRecordStores entry drafts.
EntryRecordClass EntryRecord
EntryTypeRecordClass EntryTypeRecord
EntryVersionRecordClass EntryVersionRecord
FieldGroupRecordClass FieldGroupRecord
FieldLayoutFieldRecordClass FieldLayoutFieldRecord
FieldLayoutRecordField layout record class
FieldLayoutTabRecordField record class.
FieldRecordField record class.
GlobalSetRecordField group record class.
LocaleRecordStores the locales.
MatrixBlockRecordStores Matrix blocks.
MatrixBlockTypeRecordStores Matrix block types.
MigrationRecordClass MigrationRecord
PluginRecordClass PluginRecord
RouteRecordClass RouteRecord
SectionLocaleRecordClass SectionLocaleRecord
SectionRecordClass SectionRecord
SessionRecordClass SessionRecord
StructureElementRecordClass StructureElementRecord
StructureRecordClass StructureRecord
SystemSettingsRecordClass SystemSettingsRecord
TagGroupRecordClass TagGroupRecord
TagRecordClass TagRecord
TaskRecordClass TaskRecord
TokenRecordToken record.
UserGroupRecordClass UserGroupRecord
UserGroup_UserRecordClass UserGroup_UserRecord
UserPermissionRecordClass UserPermissionRecord
UserPermission_UserGroupRecordClass UserPermission_UserGroupRecord
UserPermission_UserRecordClass UserPermission_UserRecord
UserRecordClass UserRecord
WidgetRecordClass WidgetRecord
craft.app.services #AssetIndexingServiceClass AssetIndexingService
AssetSourcesServiceClass AssetSourcesService
AssetTransformsServiceClass AssetTransformsService
AssetsServiceClass AssetsService
CacheServiceClass CacheService
CategoriesServiceClass CategoriesService
ComponentsServiceClass ComponentsService
ConfigServiceConfigService provides APIs for retrieving the values of Craft’s config settings, as well as the values of any plugins’ config settings.
ContentServiceClass ContentService
DashboardServiceClass DashboardService
DeprecatorServiceClass DeprecatorService
ElementIndexesServiceElementIndexesService provides APIs for managing element indexes.
ElementsServiceElementsService provides APIs for managing elements.
EmailMessagesServiceClass EmailMessagesService
EmailServiceEmailService provides APIs for sending email in Craft.
EntriesServiceEntriesService provides APIs for managing entries in Craft.
EntryRevisionsServiceClass EntryRevisionsService
EtServiceClass EtService
FeedsServiceFeedsService provides APIs for fetching remote RSS and Atom feeds.
FieldsServiceClass FieldsService
GlobalsServiceClass GlobalsService
HttpRequestServiceHttpRequestService provides APIs for getting information about the current HTTP request.
HttpSessionServiceExtends CHttpSession to add support for setting the session folder and creating it if it doesn't exist.
ImagesServiceService for image operations.
InstallServiceClass InstallService
LocalizationServiceClass LocalizationService
MatrixServiceMatrixService provides APIs for managing Matrix fields.
MigrationsServiceClass MigrationsService
PathServicePathService provides APIs for getting server paths that are used by Craft.
PluginsServicePluginsService provides APIs for managing plugins.
RelationsServiceClass RelationsService
ResourcesServiceClass ResourcesService
RoutesServiceClass RoutesService
SearchServiceHandles search operations.
SectionsServiceClass SectionsService
SecurityServiceClass SecurityService
StructuresServiceClass StructuresService
SystemSettingsServiceClass SystemSettingsService
TagsServiceClass TagsService
TasksServiceClass TasksService
TemplateCacheServiceClass TemplateCacheService
TemplatesServiceTemplatesService provides APIs for rendering templates, as well as interacting with other areas of Craft’s templating system.
TokensServiceTokens service.
UpdatesServiceClass UpdatesService
UserGroupsServiceClass UserGroupsService
UserPermissionsServiceClass UserPermissionsService
UserSessionServiceUserSessionService provides APIs for managing user sessions.
UsersServiceUsersService provides APIs for managing users.
craft.app.tasks #BaseTaskTask base class.
DeleteStaleTemplateCachesTaskDelete Stale Template Caches Task
FindAndReplaceTaskFind and Replace task.
GeneratePendingTransformsTaskGenerate Pending Transforms Task
ITaskInterface ITask
LocalizeRelationsTaskThe LocalizeRelations Task.
ResaveAllElementsTaskResave All Elements Task.
ResaveElementsTaskResave Elements Task
UpdateElementSlugsAndUrisTaskUpdate Element Slugs and URIs Task
craft.app.tools #AssetIndexToolAsset Index tool.
BaseToolTool base class.
ClearCachesToolClear Caches tool.
DbBackupToolBackup Database tool
FindAndReplaceToolFind and Replace tool
IToolInterface ITool
SearchIndexToolSearch Index tool.
craft.app.validators #CompositeUniqueValidatorClass CompositeUniqueValidator
DateTimeValidatorClass DateTimeValidator
HandleValidatorClass HandleValidator
LocaleValidatorWill validate that the given attribute is a valid site locale ID.
UriValidatorWill validate that the given attribute is a valid URI.
UrlFormatValidatorWill validate that the given attribute is a valid URL format.
UrlValidatorClass UrlValidator
craft.app.variables #AppVariableClass AppVariable
AssetSourceTypeVariableAsset source type template variable.
BaseComponentTypeVariableComponent template variable class
CategoryGroupsVariableClass CategoryGroupsVariable
ConfigVariableClass ConfigVariable
CpVariableCP functions
CraftVariableContains all global variables.
DeprecatorVariableClass DeprecatorVariable
ElementIndexesVariableClass ElementIndexesVariable
ElementTypeVariableElement type template variable.
ElementsVariableClass ElementsVariable
EmailMessagesVariableEmail functions.
EntryRevisionsVariableClass EntryRevisionsVariable
FeedsVariableClass FeedsVariable
FieldTypeVariableField type template variable.
FieldsVariableClass FieldsVariable
GlobalsVariableGlobals functions.
HttpRequestVariableRequest functions.
ImageVariableClass ImageVariable
LocalizationVariableLocalization functions.
PaginateVariablePaginate variable class.
PluginVariablePlugin template variable.
PluginsVariablePlugin functions.
RebrandVariableRebranding functions.
RoutesVariableRoute functions.
SectionsVariableClass SectionsVariable
SystemSettingsVariableSettings functions.
TasksVariableTask functions.
ToolVariableTool template variable.
UpdatesVariableUpdate functions.
UserGroupsVariableUser group functions.
UserPermissionsVariableUser permission functions.
UserSessionVariableUser session functions.
craft.app.widgets #BaseWidgetWidget base class.
FeedWidgetClass FeedWidget
GetHelpWidgetGet Help widget.
IWidgetInterface IWidget
NewUsersWidgetClass NewUsersWidget
QuickPostWidgetClass QuickPostWidget
RecentEntriesWidgetClass RecentEntriesWidget
UpdatesWidgetClass UpdatesWidget