BaseComponentType
- Type
- Abstract Class
- Namespace
- Craft
- Inherits
- Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
- Craft\IComponentType,
IApplicationComponent - Extended by
- Craft\AssetElementType, Craft\AssetIndexTool, Craft\AssetsFieldType, Craft\BaseAssetSourceType, Craft\BaseElementAction, Craft\BaseElementFieldType, Craft\BaseElementType, Craft\BaseFieldType, Craft\BaseOptionsFieldType, Craft\BasePlugin, Craft\BaseSavableComponentType, Craft\BaseTask, Craft\BaseTool, Craft\BaseWidget, Craft\CategoriesFieldType, Craft\CategoryElementType, Craft\CheckboxesFieldType, Craft\ClearCachesTool, Craft\ColorFieldType, Craft\CopyReferenceTagElementAction, Craft\DateFieldType, Craft\DbBackupTool, Craft\DeleteAssetsElementAction, Craft\DeleteElementAction, Craft\DeleteStaleTemplateCachesTask, Craft\DeleteUsersElementAction, Craft\DownloadFileElementAction, Craft\DropdownFieldType, Craft\EditElementAction, Craft\EntriesFieldType, Craft\EntryElementType, Craft\FeedWidget, Craft\FindAndReplaceTask, Craft\FindAndReplaceTool, Craft\GeneratePendingTransformsTask, Craft\GetHelpWidget, Craft\GlobalSetElementType, Craft\GoogleCloudAssetSourceType, Craft\LightswitchFieldType, Craft\LocalAssetSourceType, Craft\LocalizeRelationsTask, Craft\MatrixBlockElementType, Craft\MatrixFieldType, Craft\MultiSelectFieldType, Craft\NewChildElementAction, Craft\NewUsersWidget, Craft\NumberFieldType, Craft\PlainTextFieldType, Craft\PositionSelectFieldType, Craft\QuickPostWidget, Craft\RackspaceAssetSourceType, Craft\RadioButtonsFieldType, Craft\RecentEntriesWidget, Craft\RenameFileElementAction, Craft\ReplaceFileElementAction, Craft\ResaveAllElementsTask, Craft\ResaveElementsTask, Craft\RichTextFieldType, Craft\S3AssetSourceType, Craft\SearchIndexTool, Craft\SetStatusElementAction, Craft\SuspendUsersElementAction, Craft\TableFieldType, Craft\TagElementType, Craft\TagsFieldType, Craft\TempAssetSourceType, Craft\UnsuspendUsersElementAction, Craft\UpdateElementSlugsAndUrisTask, Craft\UpdatesWidget, Craft\UserElementType, Craft\UsersFieldType, Craft\ViewElementAction
- Since
- 1.0
Base component base class.
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. |
# Protected Properties
| Property | Description |
|---|---|
| $componentType | string (opens new window) |
# $componentType
Signature
protected string $componentType = null
# 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. |
| 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. |
| 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. |
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| 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. |
| getName() | Returns the component’s name. |
| 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. |
| isSelectable() | Returns whether this component should be shown when the user is creating a component of this type. |
| raiseEvent() (opens new window) | Raises an event. |
# getClassHandle()
Returns the component’s handle, ideally based on the class name.
IComponentType::getClassHandle()
View source (opens new window)
Returns
string (opens new window) – The component’s handle.
Signature
public string getClassHandle ( )
# getName()
Returns the component’s name.
This is what your component will be called throughout the Control Panel.
IComponentType::getName()
View source (opens new window)
Returns
string (opens new window) – The component’s name.
Signature
public string getName ( )
# isSelectable()
Returns whether this component should be shown when the user is creating a component of this type.
IComponentType::isSelectable()
View source (opens new window)
Returns
boolean (opens new window) – Whether the component should be selectable.
Signature
public boolean isSelectable ( )