ComponentsService

Type
Class
Namespace
Craft
Inherits
Craft\ComponentsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Class ComponentsService

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.
$types array (opens new window)

# $types

Signature

public array $types = 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.
getComponentByTypeAndClass() Returns a new component instance by its type and class.
getComponentsByType() Returns instances of a component type, indexed by their class handles.
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.
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.
initializeComponent() Validates a class and creates an instance of it.
isInitialized() Checks if this application component has been initialized yet, or not.
populateComponentByTypeAndModel() Populates a new component instance by its type and model.
raiseEvent() (opens new window) Raises an event.
validateClass() Making sure a class exists and it's not abstract or an interface.

# getComponentByTypeAndClass()

Returns a new component instance by its type and class.

View source (opens new window)

Arguments

Returns

Craft\BaseComponentType, null (opens new window)

Signature

public Craft\BaseComponentType, null getComponentByTypeAndClass ( $type, $class )

# getComponentsByType()

Returns instances of a component type, indexed by their class handles.

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array getComponentsByType ( $type )

# initializeComponent()

Validates a class and creates an instance of it.

View source (opens new window)

Arguments

Returns

mixed

Signature

public mixed initializeComponent ( $class, $instanceOf = null )

# populateComponentByTypeAndModel()

Populates a new component instance by its type and model.

View source (opens new window)

Arguments

Returns

Craft\BaseComponentType, null (opens new window)

Signature

public Craft\BaseComponentType, null populateComponentByTypeAndModel ( $type, Craft\BaseComponentModel $model )

# validateClass()

Making sure a class exists and it's not abstract or an interface.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean validateClass ( $class )