class TwitterWidgetWidget in Twitter Profile Widget 8.2

Same name and namespace in other branches

3.x src/Plugin/Field/FieldWidget/TwitterWidgetWidget.php \Drupal\twitter_profile_widget\Plugin\Field\FieldWidget\TwitterWidgetWidget

Plugin implementation of the 'twitter_widget' widget.

Plugin annotation


@FieldWidget(
  id = "twitter_widget",
  label = @Translation("Twitter widget"),
  field_types = {
    "twitter_widget"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\twitter_profile_widget\Plugin\Field\FieldWidget\TwitterWidgetWidget

Expanded class hierarchy of TwitterWidgetWidget

File

src/Plugin/Field/FieldWidget/TwitterWidgetWidget.php, line 23

Namespace

Drupal\twitter_profile_widget\Plugin\Field\FieldWidget

View source

class TwitterWidgetWidget extends WidgetBase {

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a WidgetBase object.
   *
   * @param string $plugin_id
   *   The plugin_id for the widget.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the widget is associated.
   * @param array $settings
   *   The widget settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, MessengerInterface $messenger) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $config = \Drupal::config('twitter_profile_widget.settings');
    if ($config
      ->get('twitter_widget_token') !== 'Credentials Valid') {
      $this->messenger
        ->addWarning($this
        ->t('Credentials for the Twitter API have not been configured or are invalid. Review the <a href=":widget">Twitter widget</a> settings.', [
        ':widget' => '/admin/config/media/twitter_profile_widget',
      ]));
    }
    $field_name = $items
      ->getName();
    $item = $items[$delta];
    $element['headline'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Headline'),
      '#description' => $this
        ->t('Optional header that appears above the tweets.'),
      '#default_value' => isset($item->headline) ? $item->headline : 'Latest Tweets',
    ];
    $options = [
      'status' => 'User tweets',
      'timeline' => 'User timeline',
      'favorites' => 'Favorited by user',
      'search' => 'Search (Twitter-wide)',
    ];
    $element['list_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('List type'),
      '#options' => $options,
      '#default_value' => isset($item->list_type) ? $item->list_type : 'status',
    ];
    $element['account'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('User account'),
      '#description' => $this
        ->t('The username (handle) from which to pull tweets.'),
      '#default_value' => isset($item->account) ? $item->account : '',
      '#states' => [
        'invisible' => [
          ':input[name="' . $field_name . '[0][list_type]"]' => [
            'value' => 'search',
          ],
        ],
      ],
    ];
    $element['search'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Search'),
      '#description' => $this
        ->t('A search query, which may include Twitter <a href=":examples" target="blank">query operators</a>. Results are sorted based on Twitter ranking algorithm.', [
        ':examples' => 'https://dev.twitter.com/rest/public/search#query-operators',
      ]),
      '#default_value' => isset($item->search) ? $item->search : '',
      '#states' => [
        'visible' => [
          ':input[name="' . $field_name . '[0][list_type]"]' => [
            'value' => 'search',
          ],
        ],
      ],
    ];
    $element['timeline'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Timeline list'),
      '#description' => $this
        ->t('Must already exist in Twitter to return any results. Lists are found at https://twitter.com/[username]/lists'),
      '#default_value' => isset($item->timeline) ? $item->timeline : '',
      '#states' => [
        'visible' => [
          ':input[name="' . $field_name . '[0][list_type]"]' => [
            'value' => 'timeline',
          ],
        ],
      ],
    ];
    $element['count'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of tweets to display'),
      '#options' => array_combine(range(1, 10), range(1, 10)),
      '#default_value' => isset($item->count) ? $item->count : 5,
    ];
    $element['retweets'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display retweets'),
      '#default_value' => isset($item->retweets) ? $item->retweets : 1,
      '#states' => [
        'visible' => [
          ':input[name="' . $field_name . '[0][list_type]"]' => [
            [
              'value' => 'status',
            ],
            [
              'value' => 'timeline',
            ],
          ],
        ],
      ],
    ];
    $element['replies'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display replies'),
      '#default_value' => isset($item->replies) ? $item->replies : 1,
      '#states' => [
        'visible' => [
          ':input[name="' . $field_name . '[0][list_type]"]' => [
            [
              'value' => 'status',
            ],
            [
              'value' => 'timeline',
            ],
          ],
        ],
      ],
    ];
    $element['view_all'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('"View all..." text'),
      '#description' => $this
        ->t('Optional text displayed at the bottom of the widget, linking to Twitter.'),
      '#default_value' => isset($item->view_all) ? $item->view_all : 'View on Twitter',
    ];
    $element['#element_validate'] = [
      [
        $this,
        'validate',
      ],
    ];
    return $element;
  }

  /**
   * Validate the Twitter block parameters.
   */
  public function validate($element, FormStateInterface $form_state) {
    $config = \Drupal::config('twitter_profile_widget.settings');
    if ($config
      ->get('twitter_widget_token') !== 'Credentials Valid') {
      $form_state
        ->setError($element, $this
        ->t('Credentials for the Twitter API have not been configured or are invalid. Review the <a href=":widget">Twitter widget</a> settings.', [
        ':widget' => '/admin/config/media/twitter_profile_widget',
      ]));
    }
    $values = $form_state
      ->getValues();
    $fields = $values['field_twitter_profile_widget'][0];
    if ($fields['list_type'] == 'search' && $fields['search'] == '') {
      $form_state
        ->setError($element['search'], $this
        ->t('The "Search term" type requires entering a search parameter.'));
    }
    if ($fields['list_type'] != 'search' && $fields['account'] == '') {
      $form_state
        ->setError($element['account'], $this
        ->t('This Twitter widget type requires that you enter an account handle.'));
    }
    if ($fields['list_type'] == 'timeline' && $fields['timeline'] == '') {
      $form_state
        ->setError($element['timeline'], $this
        ->t('The "User timeline" type requires entering a timeline list.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings	42
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TwitterWidgetWidget::$messenger	protected	property	The Messenger service. Overrides MessengerTrait::$messenger
TwitterWidgetWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
TwitterWidgetWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
TwitterWidgetWidget::validate	public	function	Validate the Twitter block parameters.
TwitterWidgetWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__construct
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm	16
WidgetBase::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary	15
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class TwitterWidgetWidget in Twitter Profile Widget 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation