Table
- Type
- Class
- Namespace
- craft\fields
- Inherits
- craft\fields\Table » craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\Actionable, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\FieldInterface, craft\base\Iconic, craft\base\ModelInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 3.0.0
Table represents a Table field.
Public Properties
Property | Description |
---|---|
actionMenuItems | array |
activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
addRowLabel | string, null – Custom add row button label |
attributes | array – Attribute values (name => value). |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
columnSuffix | string, null – The field’s content column suffix |
columns | array – The columns that should be shown in the table |
contentGqlMutationArgumentType | \GraphQL\Type\Definition\Type , array |
contentGqlQueryArgumentType | \GraphQL\Type\Definition\Type , array |
contentGqlType | \GraphQL\Type\Definition\Type , array |
context | string, null – The field’s context |
cpEditUrl | |
dateCreated | DateTime, null – The date that the component was created |
dateDeleted | DateTime, null – The date that the field was trashed |
dateUpdated | DateTime, null – The date that the component was last updated |
defaults | array, null – The default row values that new elements should have |
describedBy | string, null – The aria-describedby attribute value that should be set on the focusable input(s). |
eagerLoadingGqlConditions | |
elementConditionRuleType | string, array, null |
elementValidationRules | array |
errors | array – Errors for all attributes or the specified attribute. |
firstErrors | array – The first errors. |
handle | string, null – The field’s handle |
icon | string, null |
id | integer, string, null – The component’s ID (could be a temporary one: "new:X") |
inputId | string |
instructions | string, null – The field’s instructions |
isNew | boolean – Whether the component is new (unsaved) |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
labelId | string |
layoutElement | craft\fieldlayoutelements\CustomField, null – The field layout element |
maxRows | integer, null – Maximum number of Rows allowed |
minRows | integer, null – Minimum number of Rows allowed |
name | string, null – The field’s name |
oldHandle | string, null – The field’s previous handle |
oldSettings | array, null – The field’s previous settings |
required | boolean, null – Whether the field is required in the field layout it was fetched from |
scenario | string – The scenario that this model is in. |
searchable | boolean – Whether the field's values should be registered as search keywords on the elements. |
settings | array – The component’s settings |
settingsHtml | string, null |
sortOption | |
staticRows | boolean – Whether the rows should be static. |
translationKeyFormat | string, null – The field’s translation key format, if translationMethod is "custom" |
translationMethod | string – The field’s translation method |
uiLabel | |
uid | string, null – The field's UID |
validateHandleUniqueness | boolean – Whether the field handle’s uniqueness should be validated. |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
valueSql | string, null |
addRowLabel
Custom add row button label
columns
- Type
- array
- Default value
[ 'col1' => [ 'heading' => '', 'handle' => '', 'type' => 'singleline', ], ]
The columns that should be shown in the table
contentGqlMutationArgumentType
- Type
\GraphQL\Type\Definition\Type
, array- Default value
null
- Access
- Read-only
- Since
- 3.5.0
contentGqlType
- Type
\GraphQL\Type\Definition\Type
, array- Default value
null
- Access
- Read-only
- Since
- 3.3.0
defaults
The default row values that new elements should have
elementValidationRules
- Type
- array
- Default value
null
- Access
- Read-only
maxRows
Maximum number of Rows allowed
minRows
Minimum number of Rows allowed
settingsHtml
staticRows
- Type
- boolean
- Default value
false
- Since
- 4.5.0
Whether the rows should be static.
Public Methods
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__clone() | This method is called after the object is created by cloning an existing one. |
__construct() | Constructor |
__get() | Returns the value of a component property. |
__isset() | Checks if a property is set, i.e. defined and not null. |
__set() | Sets the value of a component property. |
__toString() | Use the translated field name as the string representation. |
__unset() | Sets a component property to be null. |
activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. |
addError() | Adds a new error to the specified attribute. |
addErrors() | Adds a list of errors. |
addModelErrors() | Adds errors from another model, with a given attribute name prefix. |
afterDelete() | Performs actions after a component is deleted. |
afterElementDelete() | Performs actions after the element has been deleted. |
afterElementDeleteForSite() | Performs actions after the element has been deleted. |
afterElementPropagate() | Performs actions after the element has been fully saved and propagated to other sites. |
afterElementRestore() | Performs actions after the element has been restored. |
afterElementSave() | Performs actions after the element has been saved. |
afterMergeFrom() | |
afterMergeInto() | |
afterSave() | Performs actions after a component is saved. |
afterValidate() | This method is invoked after validation ends. |
attachBehavior() | Attaches a behavior to this component. |
attachBehaviors() | Attaches a list of behaviors to the component. |
attributeHints() | Returns the attribute hints. |
attributeLabels() | Returns the attribute labels. |
attributes() | Returns the list of attribute names. |
beforeApplyDelete() | Performs actions before a component delete is applied to the database. |
beforeDelete() | Performs actions before a component is deleted. |
beforeElementDelete() | Performs actions before an element is deleted. |
beforeElementDeleteForSite() | Performs actions before an element is deleted for a site. |
beforeElementRestore() | Performs actions before an element is restored. |
beforeElementSave() | Performs actions before an element is saved. |
beforeSave() | Performs actions before a component is saved. |
beforeValidate() | This method is invoked before validation starts. |
behaviors() | Returns a list of behaviors that this component should behave as. |
canGetProperty() | Returns a value indicating whether a property can be read. |
canMergeFrom() | |
canMergeInto() | |
canSetProperty() | Returns a value indicating whether a property can be set. |
className() | Returns the fully qualified name of this class. |
clearErrors() | Removes errors for all attributes or a single attribute. |
copyValue() | Copies the field’s value from one element to another. |
createValidators() | Creates validator objects based on the validation rules specified in rules(). |
datetimeAttributes() | Returns the names of any attributes that should hold DateTime values. |
dbType() | Returns the DB data type(s) that this field will store within the elements_sites.content column. |
detachBehavior() | Detaches a behavior from the component. |
detachBehaviors() | Detaches all behaviors from the component. |
displayName() | Returns the display name of this class. |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
formName() | Returns the form name that this model class should use. |
generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. |
get() | |
getActionMenuItems() | Returns action menu items for the component. |
getActiveValidators() | Returns the validators applicable to the current scenario. |
getAttributeHint() | Returns the text hint for the specified attribute. |
getAttributeLabel() | Returns the text label for the specified attribute. |
getAttributes() | Returns attribute values. |
getBehavior() | Returns the named behavior object. |
getBehaviors() | Returns all behaviors attached to this component. |
getContentGqlMutationArgumentType() | Returns the GraphQL type to be used as an argument in mutations for this field type. |
getContentGqlQueryArgumentType() | Returns the GraphQL type to be used as an argument in queries for this field type. |
getContentGqlType() | Returns the GraphQL type to be used for this field type. |
getCpEditUrl() | |
getEagerLoadingGqlConditions() | |
getElementConditionRuleType() | Returns the element condition rule class that should be used for this field. |
getElementValidationRules() | Returns the validation rules for an element with this field. |
getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. |
getErrors() | Returns the errors for all attributes or a single attribute. |
getFirstError() | Returns the first error of the specified attribute. |
getFirstErrors() | Returns the first error of every attribute in the model. |
getHandle() | |
getIcon() | Returns the component’s icon, if it has one. |
getId() | |
getInlineInputHtml() | |
getInputHtml() | Returns the field’s input HTML. |
getInputId() | Returns the input’s ID, which the <label> ’s for attribute should reference. |
getIsNew() | Returns whether the component is new (unsaved). |
getIsTranslatable() | Returns whether the field should be shown as translatable in the UI. |
getIterator() | Returns an iterator for traversing the attributes in the model. |
getLabelId() | Returns the input’s label ID. |
getOrientation() | Returns the orientation the field should use (ltr or rtl ). |
getPreviewHtml() | |
getScenario() | Returns the scenario that this model is used in. |
getSearchKeywords() | Returns the search keywords that should be associated with this field. |
getSettings() | Returns an array of the component’s settings. |
getSettingsHtml() | Returns the component’s settings HTML. |
getSortOption() | |
getStaticHtml() | Returns a static (non-editable) version of the field’s input HTML. |
getStatus() | Returns the status of the field for a given element. |
getTranslationDescription() | Returns the description of this field’s translation support. |
getTranslationKey() | Returns the field’s translation key, based on a given element. |
getUiLabel() | |
getValidators() | Returns all the validators declared in rules(). |
getValueSql() | Returns a SQL expression which extracts the field’s value from the elements_sites.content column. |
hasErrors() | Returns a value indicating whether there is any validation error. |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
hasMaxRows() | |
hasMethod() | Returns a value indicating whether a method is defined. |
hasMinRows() | |
hasProperty() | Returns a value indicating whether a property is defined for this component. |
icon() | Returns the field type’s SVG icon. |
includeInGqlSchema() | Returns whether the field should be included in the given GraphQL schema. |
init() | Initializes the object. |
instance() | Returns static class instance, which can be used to obtain meta information. |
isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. |
isAttributeRequired() | Returns a value indicating whether the attribute is required. |
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. |
isMultiInstance() | Returns whether the field can be included multiple times within a field layout. |
isRequirable() | Returns whether the field can be marked as required. |
isSelectable() | Returns whether the component should be selectable in component Type selects. |
isValueEmpty() | Returns whether the given value should be considered “empty” to a validator. |
load() | Populates the model with input data. |
loadMultiple() | Populates a set of models with the data from end user. |
modifyElementIndexQuery() | Modifies an element index query. |
normalizeValue() | Normalizes the field’s value for use. |
normalizeValueFromRequest() | Normalizes a posted field value for use. |
off() | Detaches an existing event handler from this component. |
offsetExists() | Returns whether there is an element at the specified offset. |
offsetGet() | Returns the element at the specified offset. |
offsetSet() | Sets the element at the specified offset. |
offsetUnset() | Sets the element value at the specified offset to null. |
on() | Attaches an event handler to an event. |
onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. |
phpType() | Returns the PHPDoc type this field’s values will have. |
queryCondition() | Returns a query builder-compatible condition for the given field instances, for a user-provided param value. |
rules() | Returns the validation rules for attributes. |
safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. |
scenarios() | Returns a list of scenarios and the corresponding active attributes. |
serializeValue() | Prepares the field’s value to be stored somewhere, like the content table. |
setAttributes() | Sets the attribute values in a massive way. |
setIsFresh() | Sets whether the field is fresh. |
setScenario() | Sets the scenario for the model. |
settingsAttributes() | Returns the list of settings attribute names. |
supportedTranslationMethods() | Returns which translation methods the field supports. |
toArray() | Converts the model into an array. |
trigger() | Triggers an event. |
useFieldset() | Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label> . |
validate() | Performs the data validation. |
validateColumns() | Validates the column configs. |
validateMultiple() | Validates multiple models. |
validateTableData() | Validates the table data. |
__construct()
Constructor
Arguments
$config
dbType()
Returns the DB data type(s) that this field will store within the elements_sites.content
column.
return \yii\db\Schema::TYPE_STRING;
Specifying the DB type isn’t strictly necessary, but it enables individual field values to be targeted by functional indexes.
If field values will consist of an associative array, each of the array keys can be specified here, so the nested values can receive their own functional indexes.
return [
'date' => \yii\db\Schema::TYPE_DATETIME,
'tz' => \yii\db\Schema::TYPE_STRING,
];
If null
is returned, the field’s values won’t be stored in the elements_sites.content
column at all. In that case, the field will be solely responsible for storing and retrieving its own values from normalizeValue() and afterElementSave()/afterElementPropagate().
Returns
string, string[], null – The column type(s).
displayName()
Returns the display name of this class.
Returns
string – The display name of this class.
getContentGqlMutationArgumentType()
- Since
- 3.5.0
Returns the GraphQL type to be used as an argument in mutations for this field type.
Returns
\GraphQL\Type\Definition\Type
, array
getContentGqlType()
- Since
- 3.3.0
Returns the GraphQL type to be used for this field type.
Returns
\GraphQL\Type\Definition\Type
, array
getElementValidationRules()
Returns the validation rules for an element with this field.
Rules should be defined in the array syntax required by yii\base\Model::rules(), with one difference: you can skip the first argument (the attribute list).
[
// explicitly specify the field attribute
[$this->handle, 'string', 'min' => 3, 'max' => 12],
// skip the field attribute
['string', 'min' => 3, 'max' => 12],
// you can only pass the validator class name/handle if not setting any params
'bool',
]
To register validation rules that should only be enforced for live elements, set the rule scenario to live
:
[
['string', 'min' => 3, 'max' => 12, 'on' => \craft\base\Element::SCENARIO_LIVE],
]
Returns
getSettingsHtml()
Returns the component’s settings HTML.
An extremely simple implementation would be to directly return some HTML:
return '<textarea name="foo">'.$this->foo.'</textarea>';
For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at src/templates/_settings.html
, passing the settings to it:
return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
'widget' => $this
]);
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 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, Craft provides a couple handy methods that can help you deal with this:
- craft\web\View::namespaceInputId() will give you the namespaced version of a given ID.
- craft\web\View::namespaceInputName() will give you the namespaced version of a given input name.
So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:
public function getSettingsHtml(): ?string
{
// Figure out what the ID is going to be namespaced into
$id = 'foo';
$namespacedId = Craft::$app->view->namespaceInputId($id);
// Render and return the input template
return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
'id' => $id,
'namespacedId' => $namespacedId,
'widget' => $this,
]);
}
And the _widget-settings.twig template might look like this:
<textarea id="{{ id }}" name="foo">{{ widget.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 craft\web\View::registerJs().
Returns
getStaticHtml()
Returns a static (non-editable) version of the field’s input HTML.
This function is called to output field values when viewing element drafts.
Arguments
$value
(mixed
) – The field’s value$element
(craft\base\ElementInterface) – The element the field is associated with
Returns
string – The static version of the field’s input HTML
hasMaxRows()
Returns
boolean – Whether maxRows was set
hasMinRows()
Returns
boolean – Whether minRows was set
icon()
- Since
- 5.0.0
Returns the field type’s SVG icon.
The returned icon can be a system icon’s name (e.g. 'whiskey-glass-ice'
), the path to an SVG file, or raw SVG markup.
System icons can be found in src/icons/solid/.
Returns
init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
normalizeValue()
Normalizes the field’s value for use.
This method is called when the field’s value is first accessed from the element. For example, the first time element.myFieldHandle
is called from a template, or right before getInputHtml() is called. Whatever this method returns is what element.myFieldHandle
will likewise return, and what getInputHtml()’s and serializeValue()’s $value arguments will be set to.
The value passed into this method will vary depending on the context.
- If a new, unsaved element is being edited for the first time (such as an entry within a Quick Post widget on the Dashboard), the value will be
null
. - If an element is currently being saved, the value will be the field’s POST data.
- If an existing element was retrieved from the database, the value will be whatever is stored in the field’s
content
table column. (Or if the field doesn’t have acontent
table column per\craft\fields\hasContentColumn()
, the value will benull
.) - If the field is being cleared out (e.g. via the
resave/entries
command with--to :empty:
), the value will be an empty string (''
).
There are cases where a pre-normalized value could be passed in as well, so be sure to account for that.
Arguments
$value
(mixed
) – The raw field value$element
(craft\base\ElementInterface, null) – The element the field is associated with, if there is one
Returns
mixed
– The prepared field value
normalizeValueFromRequest()
- Since
- 4.5.0
Normalizes a posted field value for use.
This should call normalizeValue() by default, unless there are any special considerations that need to be made for posted values.
Arguments
$value
(mixed
) – The serialized value$element
(craft\base\ElementInterface, null) – The element the field is associated with, if there is one
Returns
mixed
– The prepared field value
phpType()
- Since
- 5.0.0
Returns the PHPDoc type this field’s values will have.
It will be used by the generated CustomFieldBehavior
class.
If the values can be of more than one type, return multiple types separated by |
s.
public static function valueType(): string
{
return 'int|string';
}
Returns
serializeValue()
Prepares the field’s value to be stored somewhere, like the content table.
Data types that are JSON-encodable are safe (arrays, integers, strings, booleans, etc). Whatever this returns should be something normalizeValue() can handle.
Arguments
$value
(mixed
) – The raw field value$element
(craft\base\ElementInterface, null) – The element the field is associated with, if there is one
Returns
mixed
– The serialized field value
useFieldset()
- Since
- 3.6.0
Returns whether the field should use a <fieldset>
+ <legend>
instead of a <div>
+ <label>
.
Returns
validateColumns()
Validates the column configs.
validateTableData()
Validates the table data.
Arguments
$element
(craft\base\ElementInterface)
Protected Methods
Method | Description |
---|---|
defineBehaviors() | Returns the behaviors to attach to this class. |
defineRules() | Returns the validation rules for attributes. |
extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". |
extractRootFields() | Extracts the root field names from nested fields. |
inputHtml() | Returns the field’s input HTML. |
isFresh() | Returns whether this is the first time the element’s content has been edited. |
requestParamName() | Returns the field’s param name on the request. |
resolveFields() | Determines which fields can be returned by toArray(). |
searchKeywords() | Returns the search keywords that should be associated with this field. |
valueSql() | Returns a coalescing value SQL expression for the given field instances. |
defineRules()
- Since
- 3.4.0
Returns the validation rules for attributes.
See rules() for details about what should be returned.
Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.
Returns
inputHtml()
- Since
- 3.5.0
Returns the field’s input HTML.
Arguments
$value
(mixed
) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null$element
(craft\base\ElementInterface, null) – The element the field is associated with, if there is one$inline
(boolean) – Whether this is for an inline edit form.
Returns
string – The input HTML.
searchKeywords()
- Since
- 3.5.0
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. craft\services\Search will be able to find the individual keywords in whatever string is returned, and normalize them for you.
Arguments
$value
(mixed
) – The field’s value$element
(craft\base\ElementInterface) – The element the field is associated with, if there is one
Returns
string – A string of search keywords.
Constants
Constant | Description |
---|---|
SCENARIO_DEFAULT | The name of the default scenario. |
TRANSLATION_METHOD_CUSTOM | |
TRANSLATION_METHOD_LANGUAGE | |
TRANSLATION_METHOD_NONE | |
TRANSLATION_METHOD_SITE | |
TRANSLATION_METHOD_SITE_GROUP |