BaseElementFieldType

Type: Abstract Class
Namespace: Craft
Inherits: Craft\BaseElementFieldType » Craft\BaseFieldType » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements: Craft\IComponentType, Craft\IEagerLoadingFieldType, Craft\IFieldType, Craft\IPreviewableFieldType, Craft\ISavableComponentType, IApplicationComponent
Extended by: Craft\AssetsFieldType, Craft\CategoriesFieldType, Craft\EntriesFieldType, Craft\TagsFieldType, Craft\UsersFieldType
Since: 1.0

Base element fieldtype class.

# Public Properties

Property	Description
$behaviors (opens new window)	array (opens new window) – The behaviors that should be attached to this component.
$element	Craft\BaseElementModel
$model	Craft\BaseModel

# Protected Properties

Property	Description
$allowLargeThumbsView	boolean (opens new window)
$allowLimit	boolean (opens new window)
$allowMultipleSources	boolean (opens new window)
$componentType	string (opens new window)
$elementType	string (opens new window)
$inputJsClass	string (opens new window), null (opens new window)
$inputTemplate	string (opens new window)
$sortable	boolean (opens new window)

# `$allowLargeThumbsView`

Type: boolean (opens new window)

View source (opens new window)

Signature

protected boolean $allowLargeThumbsView = false

# `$allowLimit`

Type: boolean (opens new window)

View source (opens new window)

Signature

protected boolean $allowLimit = true

# `$allowMultipleSources`

Type: boolean (opens new window)

View source (opens new window)

Signature

protected boolean $allowMultipleSources = true

# `$elementType`

Type: string (opens new window)

View source (opens new window)

Signature

protected string $elementType = null

# `$inputJsClass`

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

View source (opens new window)

Signature

protected string, null $inputJsClass = null

# `$inputTemplate`

Type: string (opens new window)

View source (opens new window)

Signature

protected string $inputTemplate = '_includes/forms/elementSelect'

# `$sortable`

Type: boolean (opens new window)

View source (opens new window)

Signature

protected boolean $sortable = true

# 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.
defineContentAttribute()	Returns the field’s content attribute config.
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.
getEagerLoadingMap()	Returns an array that maps source-to-target element IDs based on this custom field.
getEventHandlers() (opens new window)	Returns the list of attached event handlers for an event.
getInputHtml()	Returns the field’s input HTML.
getIsInitialized() (opens new window)	Checks if this application component has been initialized.
getName()	Returns the component’s name.
getSearchKeywords()	Returns the search keywords that should be associated with this field.
getSettings()	Returns the component’s settings model.
getSettingsHtml()	Returns the component’s settings HTML.
getStaticHtml()	Returns a static (non-editable) version of the field’s input HTML.
getTableAttributeHtml()
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.
modifyElementsQuery()	Modifies an element query.
onAfterDelete()	Performs any actions after a field is deleted.
onAfterElementSave()	Performs any additional actions after the element has been saved.
onAfterSave()	Performs any actions after a field is saved.
onBeforeDelete()	Performs any actions before a field is deleted.
onBeforeSave()	Performs any actions before a field is saved.
prepSettings()	Preps the settings before they’re saved to the database.
prepValue()	Prepares the field’s value for use.
prepValueFromPost()	Returns the input value as it should be stored in the database.
raiseEvent() (opens new window)	Raises an event.
setElement()	Sets the element that the field type is associated with.
setIsFresh()	Sets whether the field is fresh.
setSettings()	Sets the setting values.
validate()	Validates the field’s value.

# `defineContentAttribute()`

Returns the field’s content attribute config.

The attribute config returned by this method is used to define two things:

This field’s attribute in {@link ContentModel::defineAttributes()}.
This field’s column in the craft_content table.

The method can return a string (e.g. AttributeType::Number) or an array with additional settings (e.g. array(AttributeType::Number, 'min' => 0, 'max' => 100, 'decimals' => 2)) if the attribute type’s default settings defined by {@link ModelHelper::$attributeTypeDefaults} aren’t good enough.

If you return AttributeType::Mixed, your field type can work with array data, and it will automatically be JSON-encoded when getting saved to the database, and automatically JSON-decoded when getting fetched from the database. All your field type will ever see is the actual array.

If the field type is storing its data in its own table and doesn’t need a column in the craft_content table, this method should return false. You can then save your data manually from {@link onAfterElementSave}.

IFieldType::defineContentAttribute()

View source (opens new window)

Returns

mixed – The field’s content attribute config, or false if it’s storing data in its own table.

Signature

public mixed defineContentAttribute ( )

# `getEagerLoadingMap()`

Returns an array that maps source-to-target element IDs based on this custom field.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain two sub-keys:

elementType – indicating the type of sub-elements to eager-load (the element type class handle)
map – an array of element ID mappings, where each element is a sub-array with source and target keys.

IEagerLoadingFieldType::getEagerLoadingMap()

View source (opens new window)

Arguments

$sourceElements (Craft\BaseElementModel[]) – An array of the source elements

Returns

array (opens new window), false (opens new window) – The eager-loading element ID mappings, or false if no mappings exist

Signature

public array, false getEagerLoadingMap ( $sourceElements )

# `getInputHtml()`

Returns the field’s input HTML.

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

return '<textarea name="'.$name.'">'.$value.'</textarea>';

For more complex inputs, 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/_fieldinput.html, passing the $name and $value variables to it:

return craft()->templates->render('myplugin/_fieldinput', array(
    'name'  => $name,
    'value' => $value
));

If you need to tie any JavaScript code to your input, 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 getInputHtml() 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 getInputHtml() method that includes field-targeting JavaScript code might look like:

public function getInputHtml($name, $value)
{
    // Come up with an ID value based on $name
    $id = craft()->templates->formatInputId($name);

    // 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(
        'name'         => $name,
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'value'        => $value
    ));
}

And the _fieldinput.html template might look like this:

<textarea id="{{ id }}" name="{{ name }}">{{ value }}</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()}.

IFieldType::getInputHtml()

View source (opens new window)

Arguments

$name (string (opens new window)) – The name that the field’s HTML inputs should have.
$value (mixed) – The field’s value. This will either be the {@link prepValue() prepped value}, or the raw POST value in the event of a validation error, or if the user is editing an entry draft/version.

Returns

string (opens new window) – The input HTML.

Signature

public string getInputHtml ( $name, $value )

# `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 ( )

# `getSearchKeywords()`

Returns the search keywords that should be associated with this field.

The keywords can be separated by commas and/or whitespace; it doesn’t really matter. {@link SearchService} will be able to find the individual keywords in whatever string is returned, and normalize them for you.

IFieldType::getSearchKeywords()

View source (opens new window)

Arguments

$criteria (Craft\ElementCriteriaModel)

Returns

string (opens new window) – A string of search keywords.

Signature

public string getSearchKeywords ( $criteria )

# `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.

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 ( )

# `getStaticHtml()`

Returns a static (non-editable) version of the field’s input HTML.

This function is called to output field values when viewing entry drafts.

IFieldType::getStaticHtml()

View source (opens new window)

Arguments

$value (mixed)

Returns

string (opens new window)

Signature

public string getStaticHtml ( $value )

# `getTableAttributeHtml()`

IPreviewableFieldType::getTableAttributeHtml()

View source (opens new window)

Arguments

$value (mixed)

Returns

string (opens new window)

Signature

public string getTableAttributeHtml ( $value )

# `modifyElementsQuery()`

Modifies an element query.

This method will be called whenever elements are being searched for that may have this field assigned to them.

If the method returns false, the query will be stopped before it ever gets a chance to execute.

IFieldType::modifyElementsQuery()

View source (opens new window)

Arguments

$query (Craft\DbCommand) – The database query currently being built to find the elements.
$value (mixed) – The value that was set on this field’s corresponding {@link ElementCriteriaModel} param, if any.

Returns

null (opens new window), false (opens new window) – false in the event that the method is sure that no elements are going to be found.

Signature

public null, false modifyElementsQuery ( Craft\DbCommand $query, $value )

# `onAfterElementSave()`

Performs any additional actions after the element has been saved.

If your field type is storing data in its own table, this is the best place to do it. That’s because by the time this method has been called, you can be sure that the element will have an ID, even if it’s getting saved for the first time.

IFieldType::onAfterElementSave()

View source (opens new window)

Returns

null (opens new window)

Signature

public null onAfterElementSave ( )

# `onAfterSave()`

Performs any actions after a field is saved.

IFieldType::onAfterSave()

View source (opens new window)

Returns

null (opens new window)

Signature

public null onAfterSave ( )

# `onBeforeSave()`

Performs any actions before a field is saved.

IFieldType::onBeforeSave()

View source (opens new window)

Returns

null (opens new window)

Signature

public null onBeforeSave ( )

# `prepValue()`

Prepares the field’s value for use.

This method is called when the field’s value is first acessed from the element. For example, the first time entry.myFieldHandle is called from a template, or right before {@link getFieldHtml()} is called. Whatever this method returns is what entry.myFieldHandle will likewise return, and what getFieldHandle()’s $value argument will be set to.

IFieldType::prepValue()

View source (opens new window)

Arguments

$value (mixed) – The field’s stored value.

Returns

Craft\ElementCriteriaModel – The prepped value.

Signature

public Craft\ElementCriteriaModel prepValue ( $value )

# `validate()`

Validates the field’s value.

The $value passed into this method will be based on the value that {@link prepValueFromPost()} returned. It may have gone through additional modification when it was set on the {@link ContentModel} as well, depending on the attribute type {@link defineContentAttribute()} returns.

Some validation may already occur for this field without any help from this method. For example, if the field is required by the field layout, but doesn’t have any value, the {@link ContentModel} will take care of that. Also, if {@link defineContentAttribute()} defines any validation rules (e.g. min or max for Number attributes), those will also be applied automatically. So this method should only be used for custom validation rules that aren’t already provided for free.

IFieldType::validate()

View source (opens new window)

Arguments

$value (array (opens new window)) – The field’s value.

Returns

true (opens new window), string (opens new window), array (opens new window) – true if everything checks out; otherwise a string for a single validation error, or an array of strings if there are multiple validation errors.

Signature

public true, string, array validate ( $value )

# Protected Methods

Method	Description
defineSettings()	Defines the settings.
getAddButtonLabel()	Returns the label for the "Add" button.
getAvailableSources()	Returns the sources that should be available to choose from within the field's settings
getContentPostLocation()	Returns the location in POST that this field's content was pulled from.
getElementType()	Returns the element type.
getInputSelectionCriteria()	Returns any additional criteria parameters limiting which elements the field should be able to select.
getInputSources()	Returns an array of the source keys the field should be able to select elements from.
getInputTemplateVariables()	Returns an array of variables that should be passed to the input template.
getSettingsModel()	Returns the settings model.
getSourceOptions()	Normalizes the available sources into select input options.
getSupportedViewModes()	Returns the field’s supported view modes.
getTargetLocale()	Returns the locale that target elements should have.
getTargetLocaleFieldHtml()	Returns the HTML for the Target Locale setting.
getViewMode()	Returns the field’s current view mode.
getViewModeFieldHtml()	Returns the HTML for the View Mode setting.
isFresh()	Returns whether this is the first time the element's content has been edited.

# `defineSettings()`

Defines the settings.

BaseSavableComponentType::defineSettings()

View source (opens new window)

Returns

array (opens new window)

Signature

protected array defineSettings ( )

# `getAddButtonLabel()`

Returns the label for the "Add" button.

View source (opens new window)

Returns

string (opens new window)

Signature

protected string getAddButtonLabel ( )

# `getAvailableSources()`

Returns the sources that should be available to choose from within the field's settings

View source (opens new window)

Signature

protected void getAvailableSources ( )

# `getElementType()`

Returns the element type.

View source (opens new window)

Returns

Craft\BaseElementType

Throws

Craft\Exception

Signature

protected Craft\BaseElementType getElementType ( )

# `getInputSelectionCriteria()`

Returns any additional criteria parameters limiting which elements the field should be able to select.

View source (opens new window)

Returns

array (opens new window)

Signature

protected array getInputSelectionCriteria ( )

# `getInputSources()`

Returns an array of the source keys the field should be able to select elements from.

View source (opens new window)

Returns

array (opens new window)

Signature

protected array getInputSources ( )

# `getInputTemplateVariables()`

Returns an array of variables that should be passed to the input template.

View source (opens new window)

Arguments

$name (string (opens new window))
$value (mixed)

Returns

array (opens new window)

Signature

protected array getInputTemplateVariables ( $name, $value )

# `getSourceOptions()`

Normalizes the available sources into select input options.

View source (opens new window)

Returns

array (opens new window)

Signature

protected array getSourceOptions ( )

# `getSupportedViewModes()`

Returns the field’s supported view modes.

View source (opens new window)

Returns

array (opens new window), null (opens new window)

Signature

protected array, null getSupportedViewModes ( )

# `getTargetLocale()`

Returns the locale that target elements should have.

View source (opens new window)

Returns

string (opens new window)

Signature

protected string getTargetLocale ( )

# `getTargetLocaleFieldHtml()`

Returns the HTML for the Target Locale setting.

View source (opens new window)

Returns

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

Signature

protected string, null getTargetLocaleFieldHtml ( )

# `getViewMode()`

Returns the field’s current view mode.

View source (opens new window)

Returns

string (opens new window)

Signature

protected string getViewMode ( )

# `getViewModeFieldHtml()`

Returns the HTML for the View Mode setting.

View source (opens new window)

Returns

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

Signature

protected string, null getViewModeFieldHtml ( )

← BaseElementAction BaseElementModel →

BaseElementFieldType

# Public Properties

# Protected Properties

# $allowLargeThumbsView

Signature

# $allowLimit

Signature

# $allowMultipleSources

Signature

# $elementType

Signature

# $inputJsClass

Signature

# $inputTemplate

Signature

# $sortable

Signature

# Public Methods

# defineContentAttribute()

Returns

Signature

# getEagerLoadingMap()

Arguments

Returns

Signature

# getInputHtml()

Arguments

Returns

Signature

# getName()

Returns

Signature

# getSearchKeywords()

Arguments

Returns

Signature

# getSettingsHtml()

Returns

Signature

# getStaticHtml()

Arguments

Returns

Signature

# getTableAttributeHtml()

Arguments

Returns

Signature

# modifyElementsQuery()

Arguments

Returns

Signature

# onAfterElementSave()

Returns

Signature

# onAfterSave()

Returns

Signature

# onBeforeSave()

Returns

Signature

# prepValue()

Arguments

Returns

Signature

# validate()

Arguments

Returns

Signature

# Protected Methods

# defineSettings()

Returns

Signature

# getAddButtonLabel()

Returns

Signature

# getAvailableSources()

Signature

# getElementType()

Returns

Throws

# `$allowLargeThumbsView`

# `$allowLimit`

# `$allowMultipleSources`

# `$elementType`

# `$inputJsClass`

# `$inputTemplate`

# `$sortable`

# `defineContentAttribute()`

# `getEagerLoadingMap()`

# `getInputHtml()`

# `getName()`

# `getSearchKeywords()`

# `getSettingsHtml()`

# `getStaticHtml()`

# `getTableAttributeHtml()`

# `modifyElementsQuery()`

# `onAfterElementSave()`

# `onAfterSave()`

# `onBeforeSave()`

# `prepValue()`

# `validate()`

# `defineSettings()`

# `getAddButtonLabel()`

# `getAvailableSources()`

# `getElementType()`

# `getInputSelectionCriteria()`

# `getInputSources()`

# `getInputTemplateVariables()`

# `getSourceOptions()`

# `getSupportedViewModes()`

# `getTargetLocale()`

# `getTargetLocaleFieldHtml()`

# `getViewMode()`

# `getViewModeFieldHtml()`