class TwitterWidgetItem in Twitter Profile Widget 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldType/TwitterWidgetItem.php \Drupal\twitter_profile_widget\Plugin\Field\FieldType\TwitterWidgetItem
Plugin implementation of the 'twitter_widget' field type.
Plugin annotation
@FieldType(
id = "twitter_widget",
label = @Translation("Twitter widget"),
description = @Translation("Reference a twitter feed"),
category = @Translation("Social Media"),
default_widget = "twitter_widget",
default_formatter = "twitter_widget"
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\twitter_profile_widget\Plugin\Field\FieldType\TwitterWidgetItem
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
Expanded class hierarchy of TwitterWidgetItem
File
- src/
Plugin/ Field/ FieldType/ TwitterWidgetItem.php, line 24
Namespace
Drupal\twitter_profile_widget\Plugin\Field\FieldTypeView source
class TwitterWidgetItem extends FieldItemBase {
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties['headline'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Headline'))
->setRequired(FALSE);
$properties['list_type'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Type'))
->setRequired(TRUE);
$properties['account'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Twitter Account'))
->setRequired(FALSE);
$properties['search'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Search query'))
->setRequired(FALSE);
$properties['timeline'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Timeline List'))
->setRequired(FALSE);
$properties['count'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Number of tweets'))
->setRequired(TRUE);
$properties['retweets'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Include retweets'))
->setRequired(FALSE);
$properties['replies'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Include replies'))
->setRequired(FALSE);
$properties['view_all'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('View all text'))
->setRequired(FALSE);
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
$schema = [
'columns' => [
'headline' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
'list_type' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
'account' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
'search' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
'timeline' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
'count' => [
'type' => 'int',
'size' => 'tiny',
],
'retweets' => [
'type' => 'int',
'size' => 'tiny',
],
'replies' => [
'type' => 'int',
'size' => 'tiny',
],
'view_all' => [
'type' => 'varchar',
'length' => 255,
'binary' => FALSE,
],
],
];
return $schema;
}
/**
* {@inheritdoc}
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$values['headline'] = Random::word(3);
$values['list_type'] = 'account';
$values['account'] = 'markfullmer';
$values['search'] = '';
$values['timeline'] = '';
$values['count'] = array_rand(range(1, 10), 1);
$values['retweets'] = array_rand(range(0, 1), 1);
$values['replies'] = array_rand(range(0, 1), 1);
$values['view_all'] = Random::word(3);
return $values;
}
/**
* {@inheritdoc}
*/
public function isEmpty() {
$account = $this
->get('account')
->getValue();
$search = $this
->get('search')
->getValue();
$timeline = $this
->get('timeline')
->getValue();
return empty($account) && empty($search) && empty($timeline);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items on the storage level. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides FieldItemInterface:: |
10 |
FieldItemBase:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public | function |
Sets the data value. Overrides Map:: |
4 |
FieldItemBase:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function |
Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet. Overrides Map:: |
|
FieldItemBase:: |
public | function |
Constructs a TypedData object given its definition and context. Overrides TypedData:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
Map:: |
protected | property |
The data definition. Overrides TypedData:: |
|
Map:: |
protected | property | The array of properties. | |
Map:: |
protected | property | An array of values for the contained properties. | |
Map:: |
public | function |
Applies the default value. Overrides TypedData:: |
4 |
Map:: |
public | function |
Gets a property object. Overrides ComplexDataInterface:: |
|
Map:: |
public | function | ||
Map:: |
public | function |
Gets an array of property objects. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
Map:: |
public | function |
Gets the data value. Overrides TypedData:: |
1 |
Map:: |
public | function |
Overrides TraversableTypedDataInterface:: |
4 |
Map:: |
public | function |
Sets a property value. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns an array of all property values. Overrides ComplexDataInterface:: |
1 |
Map:: |
public | function | Magic method: Implements a deep clone. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TwitterWidgetItem:: |
public static | function |
Generates placeholder field values. Overrides FieldItemBase:: |
|
TwitterWidgetItem:: |
public | function |
Determines whether the data structure is empty. Overrides Map:: |
|
TwitterWidgetItem:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
|
TwitterWidgetItem:: |
public static | function |
Returns the schema for the field. Overrides FieldItemInterface:: |
|
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
9 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |