contacts-8.x-1.x-dev/src/Entity/ContactTab.php

<?php

namespace Drupal\contacts\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;

/**
 * Defines the Contact tab entity.
 *
 * @ConfigEntityType(
 *   id = "contact_tab",
 *   label = @Translation("Contact tab"),
 *   handlers = {
 *     "list_builder" = "Drupal\contacts\ContactTabListBuilder",
 *     "form" = {
 *       "default" = "Drupal\contacts\Form\ContactTabForm",
 *       "add" = "Drupal\contacts\Form\ContactTabForm",
 *       "edit" = "Drupal\contacts\Form\ContactTabForm",
 *       "delete" = "Drupal\contacts\Form\ContactTabDeleteForm"
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
 *     },
 *   },
 *   config_prefix = "contact_tab",
 *   admin_permission = "administer contacts",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *     "uuid" = "uuid"
 *   },
 *   links = {
 *     "canonical" = "/admin/structure/contact-tabs/{contact_tab}",
 *     "add-form" = "/admin/structure/contact-tabs/add",
 *     "edit-form" = "/admin/structure/contact-tabs/{contact_tab}/edit",
 *     "delete-form" = "/admin/structure/contact-tabs/{contact_tab}/delete",
 *     "collection" = "/admin/structure/contact-tabs"
 *   },
 *   config_export = {
 *     "id",
 *     "label",
 *     "path",
 *     "layout",
 *     "weight",
 *     "relationships",
 *     "blocks",
 *     "roles"
 *   }
 * )
 */
class ContactTab extends ConfigEntityBase implements ContactTabInterface {

  /**
   * The tab ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The tab label.
   *
   * @var string
   */
  protected $label;

  /**
   * The tab path part.
   *
   * @var string
   */
  protected $path;

  /**
   * The tab layout.
   *
   * @var string
   */
  protected $layout;

  /**
   * The contexts in which to show the tab.
   *
   * @var string[]
   */
  protected $contexts = [];

  /**
   * The relationships for the tab.
   *
   * An array including:
   *   - id: The relationship plugin id.
   *   - name: The name for the context.
   *   - source: The name of the source context.
   *
   * @var array
   */
  protected $relationships = [];

  /**
   * The blocks configuration.
   *
   * An array including:
   *   - id: The block plugin id.
   *   - context_mapping: Any relevant context mapping.
   *
   * @var array
   */
  protected $blocks = [];

  /**
   * The block plugins for this tab.
   *
   * @var \Drupal\Core\Block\BlockPluginInterface[]
   */
  protected $blockPlugins = [];

  /**
   * The tab user roles.
   *
   * A tab should only be shown if the contact being viewed has one of these
   * roles. If empty then can be shown on any contact.
   *
   * @var array
   */
  protected $roles = [];

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage, array &$values) {
    $values += ['layout' => 'contacts_tab_content.stacked'];
    parent::preCreate($storage, $values);
  }

  /**
   * {@inheritdoc}
   */
  public function getPath() {
    return $this->path;
  }

  /**
   * {@inheritdoc}
   */
  public function setPath($path) {
    $this->path = $path;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getLayout() {
    return $this->layout;
  }

  /**
   * {@inheritdoc}
   */
  public function setLayout($layout) {
    $this->layout = $layout;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRelationships() {
    return $this->relationships;
  }

  /**
   * {@inheritdoc}
   */
  public function setRelationships(array $relationships) {
    $this->relationships = $relationships;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addBlock($id, $block) {
    // Get default name.
    $name = preg_replace("/[^A-Za-z0-9 ]/", '_', $id);

    // Check for uniqueness.
    if (in_array($name, array_keys($this->getBlocks()))) {
      $i = 0;
      do {
        $i++;
        $new_name = "{$name}_{$i}";
        $exists = in_array($new_name, array_keys($this->getBlocks()));
      } while ($exists);

      $name = $new_name;
    }

    // Make sure the name is set properly.
    $block['id'] = $id;
    $this->setBlock($name, $block);

    return $name;
  }

  /**
   * {@inheritdoc}
   */
  public function getBlock($id) {
    if (isset($this->blocks[$id])) {
      return $this->blocks[$id];
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getBlocks() {
    return $this->blocks;
  }

  /**
   * {@inheritdoc}
   */
  public function setBlock($name, array $block) {
    // Make sure we have an actual id and not just a numeric array key.
    if (empty($block['id']) || is_numeric($block['id'])) {
      throw new \InvalidArgumentException('Missing required ID for block settings.');
    }

    // If there is a problem with the name we can try to create one from ID.
    if (empty($name) || is_numeric($name)) {
      $name = preg_replace("/[^A-Za-z0-9 ]/", '_', $block['id']);
    }

    // Make sure the name is set properly.
    $block['name'] = $name;
    $this->blocks[$name] = $block;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setBlocks(array $blocks) {
    $this->blocks = [];
    foreach ($blocks as $key => $block) {
      $name = $block['name'] ?: $key;
      $this->setBlock($name, $block);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBlockPlugins() {
    return $this->blockPlugins;
  }

  /**
   * {@inheritdoc}
   */
  public function setBlockPlugins(array $blocks) {
    $this->blockPlugins = $blocks;
    return $this;
  }

  /**
   * Load a tab by path.
   *
   * @param string $path
   *   The path to load by.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   *   The entity for the given path, or FALSE if none is found.
   */
  public static function loadByPath($path) {
    $entity_type_id = \Drupal::service('entity_type.repository')->getEntityTypeFromClass(get_called_class());
    $tabs = \Drupal::entityTypeManager()->getStorage($entity_type_id)->loadByProperties([
      'path' => $path,
    ]);
    return reset($tabs);
  }

  /**
   * {@inheritdoc}
   */
  public function getRoles() {
    return $this->roles;
  }

  /**
   * {@inheritdoc}
   */
  public function setRoles(array $roles) {
    $this->roles = $roles;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    $configs = $this->getBlocks();
    foreach ($configs as $config) {
      $block = \Drupal::service('plugin.manager.block')->createInstance($config['id'], $config);
      $this->calculatePluginDependencies($block);
    }

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getManageMeta() {
    // @todo Add tab metadata.
    $meta = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => 'About this tab',
      '#access' => FALSE,
    ];

    return $meta;
  }

}