class YoastSeoWidget in Real-time SEO for Drupal 8.2

Same name and namespace in other branches

8 src/Plugin/Field/FieldWidget/YoastSeoWidget.php \Drupal\yoast_seo\Plugin\Field\FieldWidget\YoastSeoWidget

Advanced widget for yoast_seo field.

Plugin annotation


@FieldWidget(
  id = "yoast_seo_widget",
  label = @Translation("Real-time SEO form"),
  field_types = {
    "yoast_seo"
  }
)

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\yoast_seo\Plugin\Field\FieldWidget\YoastSeoWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of YoastSeoWidget

File

src/Plugin/Field/FieldWidget/YoastSeoWidget.php, line 28

Namespace

Drupal\yoast_seo\Plugin\Field\FieldWidget

View source

class YoastSeoWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Instance of YoastSeoManager service.
   *
   * @var \Drupal\yoast_seo\SeoManager
   */
  protected $seoManager;

  /**
   * Target elements for Javascript.
   *
   * @var array
   */
  public static $jsTargets = [
    'wrapper_target_id' => 'yoast-wrapper',
    'snippet_target_id' => 'yoast-snippet',
    'output_target_id' => 'yoast-output',
    'overall_score_target_id' => 'yoast-overall-score',
  ];

  /**
   * {@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('entity_type.manager'), $container
      ->get('yoast_seo.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, SeoManager $manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->entityTypeManager = $entity_type_manager;
    $this->seoManager = $manager;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $form['#yoast_settings'] = $this
      ->getSettings();

    // Create the form element.
    $element += [
      '#type' => 'details',
      '#open' => TRUE,
      '#attached' => [
        'library' => [
          'yoast_seo/yoast_seo_core',
          'yoast_seo/yoast_seo_admin',
        ],
      ],
    ];
    $element['focus_keyword'] = [
      '#id' => Html::getUniqueId('yoast_seo-' . $delta . '-focus_keyword'),
      '#type' => 'textfield',
      '#title' => $this
        ->t('Focus keyword'),
      '#default_value' => isset($items[$delta]->focus_keyword) ? $items[$delta]->focus_keyword : NULL,
      '#description' => $this
        ->t("Pick the main keyword or keyphrase that this post/page is about."),
    ];
    $element['overall_score'] = [
      '#theme' => 'overall_score',
      '#overall_score_target_id' => self::$jsTargets['overall_score_target_id'],
      '#overall_score' => $this->seoManager
        ->getScoreStatus(isset($items[$delta]->status) ? $items[$delta]->status : 0),
    ];
    $element['status'] = [
      '#id' => Html::getUniqueId('yoast_seo-' . $delta . '-status'),
      '#type' => 'hidden',
      '#title' => $this
        ->t('Real-time SEO status'),
      '#default_value' => isset($items[$delta]->status) ? $items[$delta]->status : NULL,
      '#description' => $this
        ->t("The SEO status in points."),
    ];

    // Snippet.
    $element['snippet_analysis'] = [
      '#theme' => 'yoast_snippet',
      '#wrapper_target_id' => self::$jsTargets['wrapper_target_id'],
      '#snippet_target_id' => self::$jsTargets['snippet_target_id'],
      '#output_target_id' => self::$jsTargets['output_target_id'],
    ];
    $js_config = $this
      ->getJavaScriptConfiguration();
    $js_config['fields']['focus_keyword'] = $element['focus_keyword']['#id'];
    $js_config['fields']['seo_status'] = $element['status']['#id'];

    // Add fields to store editable properties.
    foreach ([
      'title',
      'description',
    ] as $property) {
      if ($this
        ->getSetting('edit_' . $property)) {
        $element['edit_' . $property] = [
          '#id' => Html::getUniqueId('yoast_seo-' . $delta . '-' . $property),
          '#type' => 'hidden',
          '#default_value' => isset($items[$delta]->{$property}) ? $items[$delta]->{$property} : NULL,
        ];
        $js_config['fields']['edit_' . $property] = $element['edit_' . $property]['#id'];
      }
    }
    $form_object = $form_state
      ->getFormObject();
    if ($form_object instanceof EntityForm) {
      $js_config['is_new'] = $form_object
        ->getEntity()
        ->isNew();
    }
    else {

      // If we aren't working with an entity we assume whatever we are working
      // with is new.
      $js_config['is_new'] = TRUE;
    }
    $element['#attached']['drupalSettings']['yoast_seo'] = $js_config;

    // Add analysis submit button.
    $target_type = $this->fieldDefinition
      ->getTargetEntityTypeId();
    if ($this->entityTypeManager
      ->hasHandler($target_type, 'yoast_seo_preview_form')) {
      $form_handler = $this->entityTypeManager
        ->getHandler($target_type, 'yoast_seo_preview_form');
      if ($form_handler instanceof AnalysisFormHandler) {
        $form_handler
          ->addAnalysisSubmit($element, $form_state);
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    foreach ($values as &$value) {
      $value['title'] = $this
        ->getSetting('edit_title') ? $value['edit_title'] : NULL;
      $value['description'] = $this
        ->getSetting('edit_description') ? $value['edit_description'] : NULL;
    }
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'edit_title' => FALSE,
      'edit_description' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['edit_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable title editing'),
      '#description' => $this
        ->t('When this is checked the page title will be editable through the Real-Time SEO widget.'),
      '#default_value' => $this
        ->getSetting('edit_title'),
    ];
    $form['edit_description'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable description editing'),
      '#description' => $this
        ->t('When this is checked the meta description will be editable through the Real-Time SEO widget.'),
      '#default_value' => $this
        ->getSetting('edit_description'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('edit_title')) {
      $summary[] = 'Title editing enabled';
    }
    if ($this
      ->getSetting('edit_description')) {
      $summary[] = 'Description editing enabled';
    }
    return $summary;
  }

  /**
   * Returns the JavaScript configuration for this widget.
   *
   * @return array
   *   The configuration that should be attached for the module to work.
   */
  protected function getJavaScriptConfiguration() {
    global $base_root;
    $score_rules = $this->seoManager
      ->getScoreRules();

    // @todo Use dependency injection for language manager.
    // @todo Translate to something usable by YoastSEO.js.
    $language = \Drupal::languageManager()
      ->getCurrentLanguage()
      ->getId();
    $configuration = [
      // Set localization within the YoastSEO.js library.
      'language' => $language,
      // Set the base for URL analysis.
      'base_root' => $base_root,
      // Set up score to indicator word rules.
      'score_rules' => $score_rules,
      // Possibly allow properties to be editable.
      'enable_editing' => [],
    ];
    foreach ([
      'title',
      'description',
    ] as $property) {
      $configuration['enable_editing'][$property] = $this
        ->getSetting('edit_' . $property);
    }

    // Set up the names of the text outputs.
    foreach (self::$jsTargets as $js_target_name => $js_target_id) {
      $configuration['targets'][$js_target_name] = $js_target_id;
    }
    return $configuration;
  }

}

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	protected	property	The messenger.	29
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::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.
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::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
YoastSeoWidget::$entityTypeManager	protected	property	The entity type manager.
YoastSeoWidget::$jsTargets	public static	property	Target elements for Javascript.
YoastSeoWidget::$seoManager	protected	property	Instance of YoastSeoManager service.
YoastSeoWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
YoastSeoWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
YoastSeoWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
YoastSeoWidget::getJavaScriptConfiguration	protected	function	Returns the JavaScript configuration for this widget.
YoastSeoWidget::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
YoastSeoWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
YoastSeoWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
YoastSeoWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__construct

You are here

class YoastSeoWidget in Real-time SEO for Drupal 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation