class SimpleSitemapSyncExtend in CMS Content Sync 2.1.x

Event subscriptions for events dispatched by Content Sync.

Hierarchy

• class \Drupal\cms_content_sync_simple_sitemap\EventSubscriber\SimpleSitemapSyncExtend implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'SimpleSitemapSyncExtend'

cms_content_sync_simple_sitemap.services.yml in modules/cms_content_sync_simple_sitemap/cms_content_sync_simple_sitemap.services.yml

modules/cms_content_sync_simple_sitemap/cms_content_sync_simple_sitemap.services.yml

1 service uses SimpleSitemapSyncExtend

cms_content_sync_simple_sitemap.event_subscriber in modules/cms_content_sync_simple_sitemap/cms_content_sync_simple_sitemap.services.yml

Drupal\cms_content_sync_simple_sitemap\EventSubscriber\SimpleSitemapSyncExtend

File

modules/cms_content_sync_simple_sitemap/src/EventSubscriber/SimpleSitemapSyncExtend.php, line 14

Namespace

Drupal\cms_content_sync_simple_sitemap\EventSubscriber

class SimpleSitemapSyncExtend implements EventSubscriberInterface {
  const PROPERTY_NAME = 'simple_sitemap';

  /**
   * Returns an array of event names this subscriber wants to listen to.
   *
   * @return array
   *   The event names to listen to
   */
  public static function getSubscribedEvents() {
    $events[BeforeEntityPush::EVENT_NAME][] = [
      'extendPush',
    ];
    $events[BeforeEntityPull::EVENT_NAME][] = [
      'extendPull',
    ];
    $events[BeforeEntityTypeExport::EVENT_NAME][] = [
      'extendEntityType',
    ];
    return $events;
  }

  /**
   * Basically copied from different parts of the simple sitemap module.
   * Must be updated when the logic of simple sitemap changes.
   *
   * @param string $entity_type_name
   * @param string $bundle_name
   *
   * @return bool Whether or not the simple sitemap module supports configuring
   *   sitemap settings for the given entity type + bundle.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function sitemapSupportsEntityType($entity_type_name, $bundle_name) {

    /**
     * @var \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
     */
    $entity_type_manager = \Drupal::service('entity_type.manager');
    $entity_type = $entity_type_manager
      ->getDefinition($entity_type_name, FALSE);
    if (!$entity_type instanceof ContentEntityTypeInterface || !method_exists($entity_type, 'getBundleEntityType') || !$entity_type
      ->hasLinkTemplate('canonical')) {
      return FALSE;
    }

    /**
     * @var \Drupal\Core\Config\ConfigFactory $config_factory
     */
    $config_factory = \Drupal::service('config.factory');
    $setting = $config_factory
      ->get('simple_sitemap.settings')
      ->get('enabled_entity_types');
    if (empty($setting) || !in_array($entity_type_name, $setting)) {
      return FALSE;
    }
    $bundle_settings = $config_factory
      ->get("simple_sitemap.bundle_settings.{$entity_type_name}.{$bundle_name}")
      ->get();

    // @todo Add support for multiple sitemap variants which have been
    // added by Simple Sitemap Version 3.0.
    if (empty($bundle_settings)) {
      $bundle_settings = $config_factory
        ->get("simple_sitemap.bundle_settings.default.{$entity_type_name}.{$bundle_name}")
        ->get();
    }
    if (empty($bundle_settings) || empty($bundle_settings['index'])) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Add the field to the entity type for the simple sitemap configuration.
   *
   * @param \Drupal\cms_content_sync\Event\BeforeEntityTypeExport $event
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendEntityType(BeforeEntityTypeExport $event) {
    if (!$this
      ->sitemapSupportsEntityType($event
      ->getEntityTypeName(), $event
      ->getBundleName())) {
      return;
    }
    $event
      ->getDefinition()
      ->addObjectProperty(self::PROPERTY_NAME, 'Simple sitemap', FALSE);
  }

  /**
   * Alter the push to include the sitemap settings, if enabled for the entity
   * type and cached by the form values.
   * Will not support programmatically added sitemap settings, so that's not
   * supported out of the box.
   *
   * @param \Drupal\cms_content_sync\Event\BeforeEntityPush $event
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendPush(BeforeEntityPush $event) {
    $intent = $event->intent;
    $entity = $event->entity;
    if (!$this
      ->sitemapSupportsEntityType($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      return;
    }

    // Use values from the entity form if present as the database might not be updated yet.
    $values = _cms_content_sync_submit_cache($entity
      ->getEntityTypeId(), $entity
      ->uuid());

    // Push isn't related to submitting the entity form. So we can take the values out of the database.
    if (empty($values)) {

      /**
       * @var \Drupal\simple_sitemap\Simplesitemap $generator
       */
      $generator = \Drupal::service('simple_sitemap.generator');
      $values = $generator
        ->getEntityInstanceSettings($entity
        ->getEntityTypeId(), $entity
        ->id());
      $intent
        ->setProperty(self::PROPERTY_NAME, $values);
      return;
    }
    else {

      // Fix for values appearing in a sub array on a commerce product entity.
      $values = isset($values['simple_sitemap']) ? $values['simple_sitemap'] : $values;
    }
    if (empty($values)) {
      $intent
        ->setProperty(self::PROPERTY_NAME, NULL);
      return;
    }
    $values = [
      'index' => empty($values['simple_sitemap_index_content']) ? empty($values['index_default_node_settings']) ? NULL : $values['index_default_node_settings'] : $values['simple_sitemap_index_content'],
      'priority' => empty($values['simple_sitemap_priority']) ? empty($values['priority_default_node_settings']) ? NULL : $values['priority_default_node_settings'] : $values['simple_sitemap_priority'],
      'changefreq' => empty($values['simple_sitemap_changefreq']) ? empty($values['changefreq_default_node_settings']) ? NULL : $values['changefreq_default_node_settings'] : $values['simple_sitemap_changefreq'],
      'include_images' => empty($values['simple_sitemap_include_images']) ? empty($values['include_images_default_node_settings']) ? NULL : $values['include_images_default_node_settings'] : $values['simple_sitemap_include_images'],
    ];
    $intent
      ->setProperty(self::PROPERTY_NAME, $values);
  }

  /**
   * @param \Drupal\cms_content_sync\Event\BeforeEntityPull $event
   *
   * @internal param $entity
   * @internal param $intent
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendPull(BeforeEntityPull $event) {
    $intent = $event->intent;
    $entity = $intent
      ->getEntity();
    if (!$this
      ->sitemapSupportsEntityType($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      return;
    }
    $values = $intent
      ->getProperty(self::PROPERTY_NAME);
    if (empty($values)) {
      return;
    }

    /**
     * @var \Drupal\simple_sitemap\Simplesitemap $generator
     */
    $generator = \Drupal::service('simple_sitemap.generator');
    $generator
      ->setEntityInstanceSettings($entity
      ->getEntityTypeId(), $entity
      ->id(), $values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SimpleSitemapSyncExtend::extendEntityType	public	function	Add the field to the entity type for the simple sitemap configuration.
SimpleSitemapSyncExtend::extendPull	public	function	@internal param $entity @internal param $intent
SimpleSitemapSyncExtend::extendPush	public	function	Alter the push to include the sitemap settings, if enabled for the entity type and cached by the form values. Will not support programmatically added sitemap settings, so that's not supported out of the box.
SimpleSitemapSyncExtend::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
SimpleSitemapSyncExtend::PROPERTY_NAME		constant
SimpleSitemapSyncExtend::sitemapSupportsEntityType	protected	function	Basically copied from different parts of the simple sitemap module. Must be updated when the logic of simple sitemap changes.