BaseComponentType

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
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

Public Properties

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

Protected Properties

PropertyDescription
$componentTypestring

$componentType

Signature

protected string $componentType = null

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.
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.
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.
getClassHandle()Returns the component’s handle, ideally based on the class name.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getName()Returns the component’s name.
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.
isSelectable()Returns whether this component should be shown when the user is creating a component of this type.
raiseEvent()Raises an event.

getClassHandle()

Returns the component’s handle, ideally based on the class name.

IComponentType::getClassHandle()

View source

Returns

string – 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

Returns

string – 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

Returns

boolean – Whether the component should be selectable.

Signature

public boolean isSelectable ( )