BaseSavableComponentType

Type

Abstract Class

Namespace

Craft

Inherits

Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)

Implements

Craft\IComponentType, Craft\ISavableComponentType, IApplicationComponent

Extended by

Craft\AssetsFieldType, Craft\BaseAssetSourceType, Craft\BaseElementFieldType, Craft\BaseFieldType, Craft\BaseOptionsFieldType, Craft\BasePlugin, Craft\BaseTask, Craft\BaseWidget, Craft\CategoriesFieldType, Craft\CheckboxesFieldType, Craft\ColorFieldType, Craft\DateFieldType, Craft\DeleteStaleTemplateCachesTask, Craft\DropdownFieldType, Craft\EntriesFieldType, Craft\FeedWidget, Craft\FindAndReplaceTask, Craft\GeneratePendingTransformsTask, Craft\GetHelpWidget, Craft\GoogleCloudAssetSourceType, Craft\LightswitchFieldType, Craft\LocalAssetSourceType, Craft\LocalizeRelationsTask, Craft\MatrixFieldType, Craft\MultiSelectFieldType, Craft\NewUsersWidget, Craft\NumberFieldType, Craft\PlainTextFieldType, Craft\PositionSelectFieldType, Craft\QuickPostWidget, Craft\RackspaceAssetSourceType, Craft\RadioButtonsFieldType, Craft\RecentEntriesWidget, Craft\ResaveAllElementsTask, Craft\ResaveElementsTask, Craft\RichTextFieldType, Craft\S3AssetSourceType, Craft\TableFieldType, Craft\TagsFieldType, Craft\TempAssetSourceType, Craft\UpdateElementSlugsAndUrisTask, Craft\UpdatesWidget, Craft\UsersFieldType

Since

1.0

Base savable component 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.
$model	Craft\BaseModel

$model

Type

Craft\BaseModel

View source (opens new window)

Signature

public Craft\BaseModel $model = null

Protected Properties

Property	Description
$componentType	string (opens new window)

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.
getSettings()	Returns the component’s settings model.
getSettingsHtml()	Returns the component’s settings HTML.
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.
prepSettings()	Preps the settings before they’re saved to the database.
raiseEvent() (opens new window)	Raises an event.
setSettings()	Sets the setting values.

getSettings()

Returns the component’s settings model.

ISavableComponentType::getSettings()

View source (opens new window)

Returns

Craft\BaseModel – The component’s settings model.

Signature

public Craft\BaseModel getSettings ( )

getSettingsHtml()

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->getSettings()->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via {@link TemplatesService::render()}. For example, the following code would render a template loacated at craft/plugins/myplugin/templates/_settings.html, passing the settings to it:

return craft()->templates->render('myplugin/_settings', array(
    'settings' => $this->getSettings()
));

If you need to tie any JavaScript code to your settings, it’s important to know that any name= and id= attributes within the returned HTML will probably get {@link TemplatesService::namespaceInputs() namespaced}, however your JavaScript code will be left untouched.

For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>

<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>

<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id= attribute was changed from foo to namespace-foo.

Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, {@link TemplatesService} provides a couple handy methods that can help you deal with this:

• {@link TemplatesService::namespaceInputId()} will give you the namespaced version of a given ID.
• {@link TemplatesService::namespaceInputName()} will give you the namespaced version of a given input name.
• {@link TemplatesService::formatInputId()} will format an input name to look more like an ID attribute value.

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml()
{
    // Come up with an ID value for 'foo'
    $id = craft()->templates->formatInputId('foo');

    // Figure out what that ID is going to be namespaced into
    $namespacedId = craft()->templates->namespaceInputId($id);

    // Render and return the input template
    return craft()->templates->render('myplugin/_fieldinput', array(
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'settings'     => $this->getSettings()
    ));
}

And the _settings.html template might look like this:

<textarea id="{{ id }}" name="foo">{{ settings.foo }}</textarea>

<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with {@link TemplatesService::includeJs()}.

ISavableComponentType::getSettingsHtml()

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Signature

public string, null getSettingsHtml ( )

prepSettings()

Preps the settings before they’re saved to the database.

ISavableComponentType::prepSettings()

View source (opens new window)

Arguments

• $settings (array (opens new window)) – The settings, as they exist in the POST data.

Returns

array (opens new window) – The prepped settings, which will be stored in the database.

Signature

public array prepSettings ( $settings )

setSettings()

Sets the setting values.

The values may come as a key/value array, or a {@link BaseModel} object. Either way, this method should store the values on the model that is returned by {@link getSettings()}.

ISavableComponentType::setSettings()

View source (opens new window)

Arguments

• $values (array (opens new window), Craft\BaseModel) – The new setting values.

Returns

null (opens new window)

Signature

public null setSettings ( $values )

Protected Methods

Method	Description
defineSettings()	Defines the settings.
getSettingsModel()	Returns the settings model.

defineSettings()

Defines the settings.

View source (opens new window)

Returns

array (opens new window)

Signature

protected array defineSettings ( )

getSettingsModel()

Returns the settings model.

View source (opens new window)

Returns

Craft\BaseModel

Signature

protected Craft\BaseModel getSettingsModel ( )